CDE/cde/doc/C/help/Intromgr/Help.sgm

<!-- $XConsortium: Help.sgm /main/9 1996/10/28 18:12:50 cdedoc $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<Chapter Id="getting-help">
<Title>Getting Help</Title>
<Para>&newline;&empty;&newline;
<IndexTerm>
<Primary>getting help</Primary>
</IndexTerm>
<IndexTerm>
<Primary>online help</Primary>
</IndexTerm>
<IndexTerm>
<Primary>Help Manager</Primary>
</IndexTerm>
<IndexTerm>
<Primary>help: key</Primary>
</IndexTerm>
<IndexTerm>
<Primary>help: menu</Primary>
</IndexTerm>
<IndexTerm>
<Primary>help: browsing</Primary>
</IndexTerm>
<IndexTerm>
<Primary>browsing help volumes</Primary>
</IndexTerm>
<IndexTerm>
<Primary>help: button</Primary>
</IndexTerm>
Here are the ways you can request help:</Para>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HIMGR.GTH.item.1">
<Para><Link Type="jump" Linkend="help-key">Press F1 or the Help key</Link>
</Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.2">
<Para><Link Type="jump" Linkend="help-menu">Choose an item from the Help menu</Link>
</Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.3">
<Para><Link Type="jump" Linkend="help-button">Click the Help button in a dialog box</Link>
</Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.4">
<Para><Link Type="jump" Linkend="help-browser">Open the Help Manager to browse all the available help</Link>
</Para>
</ListItem>
</ItemizedList>
<Sect1 Id="help-key">
<Title>Help Key</Title>
<Para>&newline;&empty;&newline;The quickest and easiest way to get help is to press the F1 key.  When you 
press F1, the application you are using displays the help topic most closely 
related to your current activity.</Para>
<Para>Some keyboards have a dedicated "Help" key which may take the place of the 
F1 key.</Para>
<Procedure>
<Title>More ...</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HIMGR.GTH.item.5">
<Para><XRef Linkend="help-menu"></Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.6">
<Para><XRef Linkend="help-button"></Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.7">
<Para><XRef Linkend="help-browser"></Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect1>
<Sect1 Id="help-menu">
<Title>Help Menu</Title>
<Para>&newline;&empty;&newline;Most applications have a Help menu for requesting specific kinds of help.</Para>
<Para><InlineGraphic Remap="graphic" Role="left" Entityref="HelpMenu"></InlineGraphic><GlossTerm Role="nogloss">Overview</GlossTerm> displays introductory information 
about the application&newline;<GlossTerm Role="nogloss">Tasks</GlossTerm> displays instructions for using the application
&newline;<GlossTerm Role="nogloss">Reference</GlossTerm> displays summary information about 
application components  
&newline;<GlossTerm Role="nogloss">On Item</GlossTerm> changes the pointer to a question 
mark--click the question mark pointer on an item to display its description
&newline;<GlossTerm Role="nogloss">Using Help</GlossTerm> displays information 
about using Help
&newline;<GlossTerm Role="nogloss">About&sigspace;...&sigspace;</GlossTerm>displays version 
and copyright information about the application (in this case, Text Editor)</Para>
<Para>To learn more about using help windows, choose Using Help from an application's 
Help menu.  Or, you can press F1 while using a Help window.</Para>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HIMGR.GTH.item.8">
<Para><XRef Linkend="help-key"></Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.9">
<Para><XRef Linkend="help-button"></Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.10">
<Para><XRef Linkend="help-browser"></Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.11">
<Para><XRef Linkend="WindowMenuTA"></Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect1>
<Sect1 Id="help-button">
<Title>Help Button</Title>
<Para>&newline;&empty;&newline;</Para>
<Para><InlineGraphic Remap="graphic" Role="left" Entityref="HelpButton"></InlineGraphic> If you need help using an application's 
dialog box, click it's Help button.</Para>
<Para>In response, the Help Viewer displays information about the dialog box.</Para>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HIMGR.GTH.item.12">
<Para><XRef Linkend="help-key"></Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.13">
<Para><XRef Linkend="help-menu"></Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.14">
<Para><XRef Linkend="help-browser"></Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect1>
<Sect1 Id="help-browser">
<Title>Help Manager</Title>
<Para>&newline;&empty;&newline;The Help Manager lists all the online help volumes installed on 
your system.
</Para>
<Procedure>
<Title>To Display the Help Manager</Title>
<Step>
<OrderedList>
<ListItem Id="HIMGR.GTH.item.15">
<para>
Click the Information subpanel on the Front Panel.
</para>
<Graphic Entityref="IMsubpnlhelp"></graphic>
</listitem>
<ListItem Id="HIMGR.GTH.item.15a">
<para>Click Help Manager.</para>
<para>The Help Viewer opens, displaying the Help Manager.</para>
</listitem>
<ListItem Id="HIMGR.GTH.item.16">
<Para>Choose the "Common Desktop Environment" topic to
display the list of help volumes for the desktop.</Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.17">
<Para>Browse the list of titles. To open a volume, choose its title.
</Para>
</ListItem>
</OrderedList>
<Para>&newline;&empty;&newline;</Para>
<Para><OLink Type="JumpNewView" LocalInfo="browser SDL-RESERVED-HOMETOPIC"><InlineGraphic Remap="graphic" Role="left" Entityref="help-control-icon" Id="HIMGR.GTH.grph.1"></InlineGraphic></OLink>&newline;To start the Help Manager from 
 here,&newline; 
 click this picture of the Help control.</Para>
</Step>
</Procedure>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HIMGR.GTH.item.18">
<Para><XRef Linkend="help-key"></Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.19">
<Para><XRef Linkend="help-menu"></Para>
</ListItem>
<ListItem Id="HIMGR.GTH.item.20">
<Para><XRef Linkend="help-button"></Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect1>
<Sect1 Id="info-manager">
<Title>Getting Information
<indexterm><primary>desktop</primary><secondary>information</secondary></indexterm>
<indexterm><primary>displaying</primary><secondary>information</secondary></indexterm>
<indexterm><primary>information</primary><secondary>displaying</secondary></indexterm>
<indexterm><primary>online documentation</primary><secondary>displaying</secondary></indexterm>
</title>
<para>
The Information Manager allows you to browse and search large collections
of online documents containing graphics and hypertext links. These collections
are referred to as "information libraries". An information library
consists of a collection of book cases, each of which contains a
collection of books.
</para>
<para>
You can start the Information Manager by:
<IndexTerm><Primary>Information Manager</Primary><Secondary>starting</Secondary></IndexTerm>
</para>
<itemizedlist>
<listitem Id="HIMGR.GTH.item.21">
<para>
Clicking on the Information Manager control in the Front Panel.
</para>
<sidebar>
<graphic entityref="IMcontrolfp"></graphic>
</sidebar>
</listitem>
<listitem Id="HIMGR.GTH.item.22">
<para>
Clicking on the Information Manager icon in the Information Manager
subpanel.
</para>
<sidebar>
<graphic entityref="IMico"></graphic>
</sidebar>
</listitem>
<listitem Id="HIMGR.GTH.item.23">
<para>
Dragging and dropping an Information Library icon (shown in the File Manager
window) on the Information Manager control in the Front Panel.
</para>
<sidebar>
<graphic entityref="Ilibico"></graphic>
</sidebar>
</listitem>
<listitem Id="HIMGR.GTH.item.24">
<para>
Entering the <command>dtinfo</command> command from the Terminal window.
</para>
</listitem>
</itemizedlist>
<para>
When the Information Manager starts, it displays the Book List window.
The Book List window displays the available information
libraries.
</para>
<graphic entityref="BkListWin"></graphic>
<para>
The contents of information libraries are arranged hierarchically so
that you progress from larger to smaller pieces of information.
The hierarchy consists of bookcases, books, chapters, and sections.
</para>
<itemizedlist>
<listitem Id="HIMGR.GTH.item.25">
<para>
To open any item in the hierarchy, click the right arrow next to it. The
Information Manager expands the item to show its contents.
</para>
</listitem>
<listitem Id="HIMGR.GTH.item.26">
<para>To close an item (chapter, book, book case), click the down arrow
next to it. The Information Manager collapses the item and removes its contents
from the display.
</para>
</listitem>
<listitem Id="HIMGR.GTH.item.27">
<para>
To browse a section of a book, select the section name and then click
on the Display (Binoculars) button in the tool bar or simply
double-click on the section's name. The Information Manager opens the
Reading window, displaying the contents of the selected section. The
following figure shows how text appears in the Reading window.
</para>
</listitem>
</itemizedlist>
<graphic entityref="ReadingWin"></graphic>
<para>
With a section displayed, you can click the Previous Section and Next Section browse
buttons (located in the tool bar) to move to earlier or later sections.
</para>
<graphic entityref="PrvNxtBrowse"></graphic>
<para>
By clicking on hypertext links
(shown bold and underlined), you can move to other 
locations in the book.
</para>
<note>
<para>
You can keep the Book List window or the Reading window
open for easy access while you work. You can also minimize
these windows.
</para>
</note>
</sect1>
</Chapter>
<!--fickle 1.15 help-to-docbook 1.4 01/17/96 16:37:38-->