275 lines
8.3 KiB
Plaintext
275 lines
8.3 KiB
Plaintext
<!-- $XConsortium: Concepts.sgm /main/6 1996/09/08 22:14:10 rws $ -->
|
|
<!-- (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. -->
|
|
<!-- Help volume: Help4Help -->
|
|
<!-- File name: Concepts -->
|
|
<Chapter Id="Concepts">
|
|
<Title>Help Concepts</Title>
|
|
<Para>These topics describe a help window, introduce hyperlinks, and explain how
|
|
help topics are organized.
|
|
</Para>
|
|
<ItemizedList Mark="•">
|
|
<ListItem Id="HH4H.CNCP.item.1">
|
|
<Para><XRef Linkend="AHelpWindowAtAGlance"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.2">
|
|
<Para><XRef Linkend="Hyperlinks"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.3">
|
|
<Para><XRef Linkend="HelpTopicOrganization"></Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
<Procedure>
|
|
<Title>See Also</Title>
|
|
<Step>
|
|
<ItemizedList Mark="•" Role="tight">
|
|
<ListItem Id="HH4H.CNCP.item.4">
|
|
<Para><XRef Linkend="Tasks"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.5">
|
|
<Para><XRef Linkend="Table-Of-Contents"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.6">
|
|
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
|
|
</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
</Step>
|
|
</Procedure>
|
|
<Sect1 Id="AHelpWindowAtAGlance">
|
|
<Title>A Help Window at a Glance</Title>
|
|
<IndexTerm>
|
|
<Primary>topic tree, defined</Primary>
|
|
</IndexTerm>
|
|
<IndexTerm>
|
|
<Primary>topic display area, defined</Primary>
|
|
</IndexTerm>
|
|
<ItemizedList Mark="•">
|
|
<ListItem Id="HH4H.CNCP.item.7">
|
|
<Para>The topic tree is an outline of help topics. You
|
|
can scroll the list of topics, or to view a topic,
|
|
click mouse button 1 on the title.</Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.8">
|
|
<Para>The topic display area displays help topics.
|
|
You can scroll the topic display area or resize the
|
|
help window.
|
|
</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
<Graphic Entityref="Help4HelpGeneralHelp" Id="HH4H.CNCP.fig.1"></Graphic>
|
|
<ItemizedList Mark="•">
|
|
<ListItem Id="HH4H.CNCP.item.9">
|
|
<Para>Any underlined text is a hyperlink.
|
|
You use hyperlinks to &dquote;jump&dquote; to other topics (see <XRef Linkend="Hyperlinks">).</Para>
|
|
<Para>&sigspace;</Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.10">
|
|
<Para>A general help window has these buttons:</Para>
|
|
<VariableList>
|
|
<VarListEntry>
|
|
<Term>Backtrack</Term>
|
|
<ListItem>
|
|
<Para>Returns to a previous topic.</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>History</Term>
|
|
<ListItem>
|
|
<Para>Lists topics and help volumes you have visited and enables you to
|
|
redisplay a topic.</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
<VarListEntry>
|
|
<Term>Index</Term>
|
|
<ListItem>
|
|
<Para>Opens a help index that you can search to find help
|
|
on a subject.
|
|
</Para>
|
|
</ListItem>
|
|
</VarListEntry>
|
|
</VariableList>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
<Procedure>
|
|
<Title>See Also</Title>
|
|
<Step>
|
|
<ItemizedList Mark="•" Role="tight">
|
|
<ListItem Id="HH4H.CNCP.item.11">
|
|
<Para><XRef Linkend="ToLocateWhereYouAre"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.12">
|
|
<Para><XRef Linkend="HelpTopicOrganization"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.13">
|
|
<Para><XRef Linkend="Concepts"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.14">
|
|
<Para><XRef Linkend="Tasks"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.15">
|
|
<Para><XRef Linkend="Table-Of-Contents"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.16">
|
|
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
|
|
</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
</Step>
|
|
</Procedure>
|
|
</Sect1>
|
|
<Sect1 Id="Hyperlinks">
|
|
<Title>Hyperlinks in Help Topics</Title>
|
|
<IndexTerm>
|
|
<Primary>hyperlinks, types of</Primary>
|
|
</IndexTerm>
|
|
<IndexTerm>
|
|
<Primary>graphic hyperlink</Primary>
|
|
</IndexTerm>
|
|
<IndexTerm>
|
|
<Primary>underline, in hyperlinks</Primary>
|
|
</IndexTerm>
|
|
<IndexTerm>
|
|
<Primary>dashed underline, in hyperlinks</Primary>
|
|
</IndexTerm>
|
|
<Para>A hyperlink can be a word, phrase, or graphic image. Graphic
|
|
hyperlinks are shown with an open-cornered border.</Para>
|
|
<Para>Two format styles are used to identify hyperlinks:</Para>
|
|
<ItemizedList Mark="•">
|
|
<ListItem Id="HH4H.CNCP.item.17">
|
|
<Para>A solid underscore indicates a standard hyperlink that is displayed
|
|
in the current window or a new window.
|
|
</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
<Figure Id="HH4H.CNCP.fig.2">
|
|
<Title></Title>
|
|
<Graphic Entityref="Help4HelpHyperlinksS" Id="HH4H.CNCP.grph.1"></Graphic>
|
|
</Figure>
|
|
<ItemizedList Mark="•">
|
|
<ListItem Id="HH4H.CNCP.item.18">
|
|
<Para>A dashed underscore indicates that the help topic will be displayed
|
|
in a smaller pop-up window.</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
<Figure Id="HH4H.CNCP.fig.3">
|
|
<Title></Title>
|
|
<Graphic Entityref="Help4HelpHyperlinksD" Id="HH4H.CNCP.grph.2"></Graphic>
|
|
</Figure>
|
|
<Para>&sigspace;</Para>
|
|
<Procedure>
|
|
<Title>Execution Hyperlinks</Title>
|
|
<Step>
|
|
<Para>Most hyperlinks display help topics, but a hyperlink can also execute a
|
|
command. When you choose an execution hyperlink, the Help System displays
|
|
a confirmation dialog box that enables you to choose whether to execute
|
|
the command. To change the default behavior, see <XRef Linkend="Execution-Policy">.</Para>
|
|
<Para>&sigspace;</Para>
|
|
<Para>To select topics or hyperlinks using the keyboard,
|
|
see <XRef Linkend="Mouse-And-Keyboard">.</Para>
|
|
<Para>&sigspace;</Para>
|
|
</Step>
|
|
</Procedure>
|
|
<Procedure>
|
|
<Title>See Also</Title>
|
|
<Step>
|
|
<ItemizedList Mark="•" Role="tight">
|
|
<ListItem Id="HH4H.CNCP.item.19">
|
|
<Para><XRef Linkend="Execution-Policy"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.20">
|
|
<Para><XRef Linkend="Mouse-And-Keyboard"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.21">
|
|
<Para><XRef Linkend="DisplayingHelpTopics"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.22">
|
|
<Para><XRef Linkend="Concepts"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.23">
|
|
<Para><XRef Linkend="Tasks"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.24">
|
|
<Para><XRef Linkend="Table-Of-Contents"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.25">
|
|
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
|
|
</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
</Step>
|
|
</Procedure>
|
|
</Sect1>
|
|
<Sect1 Id="HelpTopicOrganization">
|
|
<Title>Help Topic Organization</Title>
|
|
<IndexTerm>
|
|
<Primary>help topic, defined</Primary>
|
|
</IndexTerm>
|
|
<IndexTerm>
|
|
<Primary>help volume, defined</Primary>
|
|
</IndexTerm>
|
|
<IndexTerm>
|
|
<Primary>help topics, how organized</Primary>
|
|
</IndexTerm>
|
|
<IndexTerm>
|
|
<Primary>help family</Primary>
|
|
</IndexTerm>
|
|
<ItemizedList Mark="•">
|
|
<ListItem Id="HH4H.CNCP.item.26">
|
|
<Para><GlossTerm Role="nogloss"> Help Volume</GlossTerm>
|
|
A help volume is a collection of topics that describe an application or
|
|
a particular subject. Typically there is one help volume per application.</Para>
|
|
<Para>Similar to an outline, a volume is a hierarchy of
|
|
topics. For example, an application might organize its help using these
|
|
categories: Introduction, Tasks and Reference. Each of these in turn
|
|
contains more detailed topics.</Para>
|
|
<Graphic Entityref="Help4HelpOrganization" Id="HH4H.CNCP.fig.4"></Graphic>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.27">
|
|
<Para><GlossTerm Role="nogloss"> Home Topic</GlossTerm>
|
|
The top-level topic in a volume is called the home topic. It is
|
|
the first topic in a help volume.</Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.28">
|
|
<Para><GlossTerm Role="nogloss"> Help Family</GlossTerm>
|
|
A help volume can be assigned to a help family. A family includes one
|
|
or more help volumes. This allows several related volumes to be grouped under a
|
|
single name.</Para>
|
|
<Para>To browse the list of help families available on your desktop, see <XRef Linkend="ToBrowseDesktopHelp">.</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
<Procedure>
|
|
<Title>See Also</Title>
|
|
<Step>
|
|
<ItemizedList Mark="•" Role="tight">
|
|
<ListItem Id="HH4H.CNCP.item.29">
|
|
<Para><XRef Linkend="DisplayingHelpTopics"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.30">
|
|
<Para><XRef Linkend="ToLocateWhereYouAre"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.31">
|
|
<Para><XRef Linkend="Concepts"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.32">
|
|
<Para><XRef Linkend="Tasks"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.33">
|
|
<Para><XRef Linkend="Table-Of-Contents"></Para>
|
|
</ListItem>
|
|
<ListItem Id="HH4H.CNCP.item.34">
|
|
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
|
|
</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
</Step>
|
|
</Procedure>
|
|
</Sect1>
|
|
</Chapter>
|
|
<!--fickle 1.15 help-to-docbook 1.4 01/17/96 16:34:36-->
|