falso
/
cdesktopenv
mirror of https://git.code.sf.net/p/cdesktopenv/code
1
0
Fork 0
Code Issues Releases Wiki Activity
cdesktopenv/cde/doc/C/help/Help4Help/Ref.sgm

1857 lines
49 KiB
Plaintext
Raw Blame History

<!-- $XConsortium: Ref.sgm /main/7 1996/09/08 22:14:42 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: Reference -->
<Chapter Id="Reference">
<Title>Help Reference</Title>
<IndexTerm>
<Primary>reference</Primary>
</IndexTerm>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.1">
<Para><XRef Linkend="HelpMenuCommands"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.2">
<Para><XRef Linkend="HelpMenuShortcutKeys"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.3">
<Para><XRef Linkend="Mouse-And-Keyboard"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.4">
<Para><XRef Linkend="HelpWindowsAndDialogBoxes"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.5">
<Para><XRef Linkend="HelpWindowConfiguration"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.6">
<Para><XRef Linkend="ErrorMessages"></Para>
</ListItem>
</ItemizedList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.7">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.8">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.9">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
<Sect1 Id="HelpMenuCommands">
<Title>Help Menus</Title>
<IndexTerm>
<Primary>help window menus</Primary>
</IndexTerm>
<IndexTerm>
<Primary>menus, in help window</Primary>
</IndexTerm>
<Para>The Help menus in the help window are:
</Para>
<ItemizedList Mark="&bull;">
<ListItem Id="HH4H.REF.item.10">
<Para><XRef Linkend="Help-File-Menu"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.11">
<Para><XRef Linkend="Help-Edit-Menu"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.12">
<Para><XRef Linkend="Help-Search-Menu"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.13">
<Para><XRef Linkend="Help-Navigate-Menu"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.14">
<Para><XRef Linkend="Help-Help-Menu"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.15">
<Para><XRef Linkend="Help-Popup-Menu"></Para>
</ListItem>
</ItemizedList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.16">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.17">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.18">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.19">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
<IndexTerm>
<Primary>help window menus</Primary>
</IndexTerm>
<Para>&sigspace;</Para>
</Step>
</Procedure>
<Sect2 Id="Help-File-Menu">
<Title>Help File Menu</Title>
<IndexTerm>
<Primary>help, File menu</Primary>
</IndexTerm>
<VariableList>
<VarListEntry>
<Term>Print</Term>
<ListItem>
<Para>Opens the Print dialog
<Anchor Id="HelpMenuPrint">
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Close</Term>
<ListItem>
<Para>Closes the help window
<Anchor Id="HelpMenuClose">
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Note>
<Para>When using <Link Type="jump" Linkend="ToBrowseDesktopHelp">Help Manager</Link> to view help information, the
Help File menu includes a New Window command.
</Para>
</Note>
<Para><Anchor Id="HelpMenuNewWindow">
</Para>
<VariableList>
<VarListEntry>
<Term>New Window</Term>
<ListItem>
<Para>Creates a copy of the current general help
window
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.20">
<Para><XRef Linkend="Printing"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.21">
<Para><XRef Linkend="ToBrowseDesktopHelp"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.22">
<Para><XRef Linkend="HelpMenuCommands"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.23">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.24">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.25">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="Help-Edit-Menu">
<Title>Help Edit Menu</Title>
<IndexTerm>
<Primary>help, Edit menu</Primary>
</IndexTerm>
<VariableList>
<VarListEntry>
<Term>Copy</Term>
<ListItem>
<Para>Copies selected text to the clipboard
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.26">
<Para><XRef Linkend="CopyingTextFromHelp"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.27">
<Para><XRef Linkend="HelpMenuCommands"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.28">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.29">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.30">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="Help-Search-Menu">
<Title>Help Search Menu</Title>
<IndexTerm>
<Primary>help, Search menu</Primary>
</IndexTerm>
<VariableList>
<VarListEntry>
<Term>Index</Term>
<ListItem>
<Para>Opens the Index Search dialog box, which lists
the help volume's key words and phrases</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.31">
<Para><XRef Linkend="Index-Search"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.32">
<Para><XRef Linkend="HelpMenuCommands"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.33">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.34">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.35">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="Help-Navigate-Menu">
<Title>Help Navigate Menu</Title>
<IndexTerm>
<Primary>help, Navigate menu</Primary>
</IndexTerm>
<VariableList>
<VarListEntry>
<Term>Backtrack</Term>
<ListItem>
<Para>Returns to the previous topic.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Home Topic</Term>
<ListItem>
<Para>Takes you to the "home topic," or the first
topic of a help volume.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>History</Term>
<ListItem>
<Para>Opens the History dialog box, which lists help volumes and
topics you've visited.</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Note>
<Para>The Backtrack and Home Topic commands are available in a pop-up menu
in the topic display area.
</Para>
</Note>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.36">
<Para><XRef Linkend="ToReturnToAPreviousTopic">
</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.37">
<Para><XRef Linkend="ToReturnToTheHomeTopic"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.38">
<Para><XRef Linkend="History"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.39">
<Para><XRef Linkend="Help-Popup-Menu"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.40">
<Para><XRef Linkend="HelpMenuCommands"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.41">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.42">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.43">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="Help-Help-Menu">
<Title>Help Menu</Title>
<IndexTerm>
<Primary>help, Help menu</Primary>
</IndexTerm>
<VariableList>
<VarListEntry>
<Term>Overview - Using Help&sigspace;</Term>
<ListItem>
<Para>Provides help on using help windows</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Table Of Contents</Term>
<ListItem>
<Para>Displays an outline of the topics in a help volume</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Tasks</Term>
<ListItem>
<Para>Displays task instructions for using the Help System</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Reference</Term>
<ListItem>
<Para>Displays reference summaries for various Help features, such
as windows and dialog boxes, menus, and resources</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Mouse And Keyboard</Term>
<ListItem>
<Para>Provides information on using the mouse and keyboard
commands in help windows</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>About Help</Term>
<ListItem>
<Para>Displays the version and copyright information for the Help System
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.44">
<Para><XRef Linkend="HelpMenuCommands"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.45">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.46">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.47">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="Help-Popup-Menu">
<Title>Help Pop-up Menu</Title>
<Para>A Help pop-up menu is available in a <Link Type="jump" Linkend="GeneralHelpWindow">general help window</Link>. To display
the pop-up menu, point to the topic display area and
press mouse button 3. &newline;(On a two-button mouse, press both buttons simultaneously.)</Para>
<VariableList>
<VarListEntry>
<Term>Bactrack</Term>
<ListItem>
<Para>Returns to the previous topic.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Home Topic</Term>
<ListItem>
<Para>Returns to the first topic of a help volume.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.48">
<Para><XRef Linkend="ToReturnToAPreviousTopic"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.49">
<Para><XRef Linkend="ToReturnToTheHomeTopic"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.50">
<Para><XRef Linkend="HelpMenuCommands"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.51">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.52">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.53">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
</Sect1>
<Sect1 Id="HelpMenuShortcutKeys">
<Title>Help Menu Shortcut Keys</Title>
<IndexTerm>
<Primary>help, shortcut keys</Primary>
</IndexTerm>
<IndexTerm>
<Primary>shortcut keys</Primary>
</IndexTerm>
<IndexTerm>
<Primary>accelerator keys</Primary>
</IndexTerm>
<Para>Use these shortcut keys to activate Help menu commands:
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis Role="heading">Command</Emphasis></Term>
<ListItem>
<Para><Emphasis Role="heading">Shortcut Key</Emphasis></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Print</Term>
<ListItem>
<Para>Control+P
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Close</Term>
<ListItem>
<Para>Alt+F4
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Copy</Term>
<ListItem>
<Para>Control+C
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Index</Term>
<ListItem>
<Para>Control+I
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Backtrack</Term>
<ListItem>
<Para>Control+B
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>HomeTopic</Term>
<ListItem>
<Para>Control+H
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Note>
<Para>If your keyboard does not have an Alt key,
ask your system administrator to identify the corresponding key or
refer to your system documentation.
</Para>
</Note>
<Para>&sigspace;</Para>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.54">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.55">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.56">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.57">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect1>
<Sect1 Id="Mouse-And-Keyboard">
<Title>Mouse Actions and Keyboard Commands</Title>
<IndexTerm>
<Primary>keyboard selection</Primary>
</IndexTerm>
<IndexTerm>
<Primary>text, selecting with keyboard</Primary>
</IndexTerm>
<IndexTerm>
<Primary>selection, with keyboard</Primary>
</IndexTerm>
<IndexTerm>
<Primary>keyboard commands</Primary>
</IndexTerm>
<IndexTerm>
<Primary>mouse, actions in help windows</Primary>
</IndexTerm>
<Procedure>
<Title>Mouse Actions</Title>
<Step>
<VariableList>
<VarListEntry>
<Term><Emphasis Role="heading">Action&sigspace;</Emphasis></Term>
<ListItem>
<Para><Emphasis Role="heading">Behavior</Emphasis></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Click mouse button 1</Term>
<ListItem>
<Para>Selects a topic in the topic tree or a
hyperlink and displays the content in the current help window.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Hold mouse button 1 and drag</Term>
<ListItem>
<Para>Copies selected text to the clipboard.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+button&sigspace;1</Term>
<ListItem>
<Para>Selects a topic in the topic tree or
hyperlink and displays the content in a new window.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Shift+button&sigspace;1</Term>
<ListItem>
<Para>Same as above.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Alt+button&sigspace;1</Term>
<ListItem>
<Para>Same as above.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Note>
<Para>If your keyboard does not have an Alt key ask your system administrator to
identify the corresponding key or refer to your system documentation.
</Para>
</Note>
<Para>&sigspace;</Para>
</Step>
</Procedure>
<Procedure>
<Title>Keyboard Commands</Title>
<IndexTerm>
<Primary>keyboard, selecting topics</Primary>
</IndexTerm>
<IndexTerm>
<Primary>topics, selecting with keyboard</Primary>
</IndexTerm>
<Step>
<Para>To use your keyboard to display topics or to scroll data, first
move the window selection highlight to the appropriate area of
the help window, such as the topic tree or topic display area.
Press the Tab key to move the selection highlight forward. To move
the highlight backward, press Shift+Tab.</Para>
<Para>You can use these keyboard commands in the following help window
areas:</Para>
<ItemizedList Mark="&bull;">
<ListItem Id="HH4H.REF.item.58">
<Para><GlossTerm Role="nogloss">Topic Tree</GlossTerm>
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis Role="heading">Key</Emphasis></Term>
<ListItem>
<Para><Emphasis Role="heading">Cursor Action</Emphasis></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Up Arrow</Term>
<ListItem>
<Para>Up one line
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Down Arrow</Term>
<ListItem>
<Para>Down one line
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Return</Term>
<ListItem>
<Para>Display help topic for selected title
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+Return&sigspace;</Term>
<ListItem>
<Para>Display help topic for selected
title in a new window
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+/</Term>
<ListItem>
<Para>Select topic tree list
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+&bsol;</Term>
<ListItem>
<Para>Deselect topic tree list
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
<ListItem Id="HH4H.REF.item.59">
<Para><GlossTerm Role="nogloss">Topic Display Area</GlossTerm>
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis Role="heading">Key</Emphasis></Term>
<ListItem>
<Para><Emphasis Role="heading">Behavior</Emphasis></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Up Arrow or Left Arrow</Term>
<ListItem>
<Para>Move highlight to previous hyperlink
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Down Arrow or Right Arrow</Term>
<ListItem>
<Para>Move highlight to next hyperlink</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+/</Term>
<ListItem>
<Para>Select entire topic
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+&bsol;</Term>
<ListItem>
<Para>Deselect entire topic
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+C</Term>
<ListItem>
<Para>Copy selection to clipboard
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+V</Term>
<ListItem>
<Para>Paste selection to clipboard
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Return</Term>
<ListItem>
<Para>Display help topic for the
selected hyperlink
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+Return&sigspace;</Term>
<ListItem>
<Para>Display help topic for the
selected hyperlink in a new window
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Shift+F10</Term>
<ListItem>
<Para>Displays the pop-up menu</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
<ListItem Id="HH4H.REF.item.60">
<Para><GlossTerm Role="nogloss"> Help Window</GlossTerm>
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis Role="heading">Key</Emphasis></Term>
<ListItem>
<Para><Emphasis Role="heading">Behavior</Emphasis></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Escape</Term>
<ListItem>
<Para>Cancels an operation such as
scrolling or resizing. Otherwise, if there is no current operation, closes the help window.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Alt key+Up Arrow</Term>
<ListItem>
<Para>Moves window to top of window stack.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Alt key+Down Arrow&sigspace;</Term>
<ListItem>
<Para>Moves window to bottom of window
stack.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
<ListItem Id="HH4H.REF.item.61">
<Para><GlossTerm Role="nogloss"> Buttons</GlossTerm>
Press Tab to move the selection highlight to the desired button and
press Return.</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.62">
<Para><GlossTerm Role="nogloss"> Vertical Scroll Bars</GlossTerm>
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis Role="heading">Key</Emphasis></Term>
<ListItem>
<Para><Emphasis Role="heading">Cursor Movement</Emphasis></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Up Arrow</Term>
<ListItem>
<Para>Scroll up
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Down Arrow</Term>
<ListItem>
<Para>Scroll down
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+Up Arrow</Term>
<ListItem>
<Para>Scroll to top of list or topic
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+Down Arrow&sigspace;</Term>
<ListItem>
<Para>Scroll to end of list or topic
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>PageUp or Previous</Term>
<ListItem>
<Para>Scroll one screen up
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>PageDown or Next</Term>
<ListItem>
<Para>Scroll one screen down
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
<ListItem Id="HH4H.REF.item.63">
<Para><GlossTerm Role="nogloss"> Horizontal Scroll Bars</GlossTerm>
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis Role="heading">Key</Emphasis></Term>
<ListItem>
<Para><Emphasis Role="heading">Cursor Movement</Emphasis></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Left Arrow</Term>
<ListItem>
<Para>Scroll left
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+Left Arrow</Term>
<ListItem>
<Para>Scroll to leftmost edge of data
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Right Arrow</Term>
<ListItem>
<Para>Scroll right
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Control+Right Arrow&sigspace;</Term>
<ListItem>
<Para>Scroll to rightmost edge of data</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.64">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.65">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.66">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.67">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect1>
<Sect1 Id="HelpWindowsAndDialogBoxes">
<Title>Help Windows And Dialog Boxes</Title>
<IndexTerm>
<Primary>help window, types of</Primary>
</IndexTerm>
<ItemizedList Mark="&bull;">
<ListItem Id="HH4H.REF.item.68">
<Para><XRef Linkend="GeneralHelpWindow"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.69">
<Para><XRef Linkend="Quick-Help"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.70">
<Para><XRef Linkend="HistoryDlg"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.71">
<Para><XRef Linkend="PrintDlg"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.72">
<Para><XRef Linkend="IndexSearchDlg"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.73">
<Para><XRef Linkend="Volume-Select"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.74">
<Para><XRef Linkend="Execution-Policy"></Para>
</ListItem>
</ItemizedList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.75">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.76">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.77">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.78">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
<Sect2 Id="GeneralHelpWindow">
<Title>General Help Window</Title>
<IndexTerm>
<Primary>general help window</Primary>
</IndexTerm>
<IndexTerm>
<Primary>window, general help</Primary>
</IndexTerm>
<Para>A general help window has a menu bar, topic tree, and a topic display area.
The topic tree lists help topics that you can choose. The lower portion of
the window&emdash;the topic display area&emdash;displays the selected
topic.
</Para>
<Graphic Entityref="Help4HelpGeneralHelp" Id="HH4H.REF.fig.1"></Graphic>
<Para>Any underlined text is a hyperlink.
You use hyperlinks to &dquote;jump&dquote; to other topics.
See <Link Type="jump" Linkend="ToSelectAHelpTopicHyperlink">To Select a Hyperlink</Link> for a description of hyperlinks.</Para>
<Para>&sigspace;</Para>
<Para>A general help window has these Help 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 that you 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>
<Para>&sigspace;</Para>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.79">
<Para><XRef Linkend="ToReturnToAPreviousTopic"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.80">
<Para><XRef Linkend="History"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.81">
<Para><XRef Linkend="Quick-Help"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.82">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.83">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.84">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.85">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="Quick-Help">
<Title>Quick Help Window</Title>
<IndexTerm>
<Primary>quick help window</Primary>
</IndexTerm>
<IndexTerm>
<Primary>window, quick help</Primary>
</IndexTerm>
<Para>A quick help window is a streamlined help window. It has a topic display
area and one or more dialog buttons.
</Para>
<Graphic Entityref="Help4HelpQuickHelp" Id="HH4H.REF.fig.2"></Graphic>
<Para>&sigspace;</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis Role="heading">Button</Emphasis></Term>
<ListItem>
<Para><Emphasis Role="heading">Action</Emphasis></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Close</Term>
<ListItem>
<Para>Closes the quick help window
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Backtrack</Term>
<ListItem>
<Para>Goes to the previous topic
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Print</Term>
<ListItem>
<Para>Displays a Print dialog box
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Help</Term>
<ListItem>
<Para>Displays Help on the quick help window
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.86">
<Para><XRef Linkend="Printing"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.87">
<Para><XRef Linkend="GeneralHelpWindow"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.88">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.89">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.90">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.91">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="HistoryDlg">
<Title>History Dialog Box</Title>
<IndexTerm>
<Primary>Help, History dialog box</Primary>
</IndexTerm>
<Graphic Entityref="Help4HelpHistory" Id="HH4H.REF.fig.3"></Graphic>
<Para>&sigspace;</Para>
<VariableList>
<VarListEntry>
<Term>Help Volumes Visited&sigspace;</Term>
<ListItem>
<Para>Lists help volumes you have visited</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Help Topics Visited</Term>
<ListItem>
<Para>List topics you have visited
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>To return to a volume or help topic, click its title in the History list.</Para>
<Para>&sigspace;</Para>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.92">
<Para><XRef Linkend="History"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.93">
<Para><XRef Linkend="HelpWindowsAndDialogBoxes"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.94">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.95">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.96">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.97">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="PrintDlg">
<Title>Print Dialog Box</Title>
<IndexTerm>
<Primary>Help, Print dialog box</Primary>
</IndexTerm>
<Graphic Entityref="Help4HelpPrintDialog" Id="HH4H.REF.fig.4"></Graphic>
<Para>&sigspace;</Para>
<VariableList>
<VarListEntry>
<Term>Printer</Term>
<ListItem>
<Para>The Help System uses your default printer (set by the LPDEST environment variable).</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Copies</Term>
<ListItem>
<Para>Type the number of copies you want to print.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Paper Size</Term>
<ListItem>
<Para>Click the paper size button to display the following choices:</Para>
<VariableList>
<VarListEntry>
<Term>Letter</Term>
<ListItem>
<Para>8.5 x 11 in
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Legal</Term>
<ListItem>
<Para>8.5 x 14 in
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Executive</Term>
<ListItem>
<Para>7.25 x 10.5 in
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>A4</Term>
<ListItem>
<Para>210 x 297 mm
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>B5</Term>
<ListItem>
<Para>182 x 257 mm
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
</VarListEntry>
</VariableList>
<VariableList>
<VarListEntry>
<Term>Topics To Print&sigspace;&sigspace;</Term>
<ListItem>
<Para>Select the topic or topics to print:</Para>
<VariableList>
<VarListEntry>
<Term>Current Topic</Term>
<ListItem>
<Para>Print only the displayed topic (the default)</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Current and Subtopics</Term>
<ListItem>
<Para>Print the current topic
and any subtopics it contains</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Table of Contents and Index&sigspace;</Term>
<ListItem>
<Para>Print the Table of
Contents and Index of the help volume</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Entire Volume</Term>
<ListItem>
<Para>Print Table of Contents, Index, and all topics in the help volume
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Print</Term>
<ListItem>
<Para>Prints the topic or topics you have chosen</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Cancel</Term>
<ListItem>
<Para>Closes the Print dialog box</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Help</Term>
<ListItem>
<Para>Provides a description of the Print dialog box
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.98">
<Para><XRef Linkend="Printing"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.99">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.100">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.101">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.102">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="IndexSearchDlg">
<Title>Index Search Dialog Box</Title>
<IndexTerm>
<Primary>Help, Index Search dialog box</Primary>
</IndexTerm>
<Graphic Entityref="Help4HelpIndexDialog" Id="HH4H.REF.fig.5"></Graphic>
<Procedure>
<Title>Search</Title>
<Step>
<VariableList>
<VarListEntry>
<Term>Current</Term>
<ListItem>
<Para>Displays a Help index for the volume that you are viewing. The
current volume is the default.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>All Volumes</Term>
<ListItem>
<Para>Displays a combined Help index for all help volumes
registered on your system.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Selected</Term>
<ListItem>
<Para>Lists available help volumes in a dialog box (see <XRef Linkend="Volume-Select">).
Choose the volumes whose index entries you want to view or search. If you
select volumes and close the dialog box, the Volumes Selected button can
be used to reopen the list of your choices.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</Step>
</Procedure>
<Procedure>
<Title>Show</Title>
<Step>
<VariableList>
<VarListEntry>
<Term>Complete Index&sigspace;</Term>
<ListItem>
<Para>Lists all the index entries found for the volume or
volumes you have chosen.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Entries with:</Term>
<ListItem>
<Para>Type a word or phrase to search for in the index entries
of the volume or volumes you chose.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</Step>
</Procedure>
<Procedure>
<Title>Status Line</Title>
<Step>
<Para>Indicates if you chose the Complete Index option. If
you search the index, the status line displays the search string or reports "No index entries found".
</Para>
</Step>
</Procedure>
<Procedure>
<Title>Index Display Area</Title>
<Step>
<Para>Lists index entries found for the volume or volumes you chose, or
entries that match the search string you entered.
</Para>
<VariableList>
<VarListEntry>
<Term>Start Search</Term>
<ListItem>
<Para>Searches the index for the word or phrase supplied in the
Entries with field. Pressing Return also activates the search.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>Close</Term>
<ListItem>
<Para>Closes the Index Search dialog box.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</Step>
</Procedure>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.103">
<Para><XRef Linkend="Index-Search"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.104">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.105">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.106">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.107">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="Volume-Select">
<Title>Search Volume Selection Dialog Box</Title>
<IndexTerm>
<Primary>Help, Index Search Volume Selection dialog box</Primary>
</IndexTerm>
<Graphic Entityref="Help4HelpSearchVolume" Id="HH4H.REF.fig.6"></Graphic>
<Para>&sigspace;</Para>
<Para>The Search Volume dialog box lists help volumes available on your system.
You can select one or more volumes, whose index entries are then displayed
in the Index Search dialog box. To deselect a volume, click the
volume name again.</Para>
<Para>When you close the Search Volume dialog box, the Select Volumes button in
the Index Search dialog box can be used to reopen the list of choices.</Para>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.108">
<Para><XRef Linkend="Index-Search"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.109">
<Para><XRef Linkend="HelpWindowsAndDialogBoxes"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.110">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.111">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.112">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.113">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="Execution-Policy">
<Title>Execution Link Confirmation Dialog Box</Title>
<IndexTerm>
<Primary>Help, Execution Link Confirmation dialog box</Primary>
</IndexTerm>
<IndexTerm>
<Primary>hyperlinks, execution link policy</Primary>
</IndexTerm>
<IndexTerm>
<Primary>execution link, policy</Primary>
</IndexTerm>
<Para>An execution hyperlink executes a command instead of displaying
a help topic. Because execution links interact with your
system, you can choose how you want the Help System to respond
when an execution link is selected.</Para>
<Para>The Help System default behavior is to display a confirmation
dialog box.</Para>
<Graphic Entityref="Help4HelpExecutionDlg" Id="HH4H.REF.fig.7"></Graphic>
<Para>Execution policy is controlled by the Help dialog widget resource
<ComputerOutput>DtNexecutionPolicy</ComputerOutput>. The default value is
<ComputerOutput>help_execute_query_unaliased</ComputerOutput>.</Para>
<Para>To change the default behavior, you add the
execution policy resource to your <ComputerOutput>.Xdefaults</ComputerOutput>
file for the application you want to change.</Para>
<Para>The set of resource values is:</Para>
<VariableList>
<VarListEntry>
<Term><ComputerOutput>help_execute_all</ComputerOutput></Term>
<ListItem>
<Para>Executes all execution links without
displaying a confirmation dialog box.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><ComputerOutput>help_execute_query_unaliased</ComputerOutput></Term>
<ListItem>
<Para>Displays a dialog box
only for those links which do not have execution aliases defined. An
execution alias is a resource that assigns a name to the command executed
by an execution link.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><ComputerOutput>help_execute_query_all</ComputerOutput></Term>
<ListItem>
<Para>Displays a dialog box for all
execution links</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><ComputerOutput>help_execute_none</ComputerOutput></Term>
<ListItem>
<Para>Disables all execution links, but
displays the execution command in a dialog box</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Procedure>
<Title>Example</Title>
<Step>
<Para>To disable all execution links within your application, perform
these steps:
</Para>
<OrderedList>
<ListItem Id="HH4H.REF.item.114">
<Para>Create an <ComputerOutput>.Xdefaults</ComputerOutput> file in your home directory or
edit the current <ComputerOutput>.Xdefaults</ComputerOutput> file to include this
resource:</Para>
<ProgramListing><Symbol Role="Variable">application_name</Symbol>*executionPolicy:help_execute_none
</ProgramListing>
</ListItem>
<ListItem Id="HH4H.REF.item.115">
<Para>Replace <Emphasis>application_name</Emphasis> with the name of the application
you want to change. If you are unsure of the name of the application,
consult your application documentation.</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.116">
<Para>Start the application.</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.117">
<Para>To test your change, choose the application Help menu and display a topic
that contains an execution link.
</Para>
</ListItem>
</OrderedList>
<Note>
<Para>Before modifying the execution policy for an application's help
volume, carefully review all execution link commands and their interaction
with your system.</Para>
</Note>
<Para>&sigspace;
For more information about the Help System execution policy
refer to the <Emphasis>Help System Author's and Programmer's Guide</Emphasis>.
</Para>
</Step>
</Procedure>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.118">
<Para><XRef Linkend="Hyperlinks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.119">
<Para><XRef Linkend="HelpWindowsAndDialogBoxes"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.120">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.121">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.122">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.123">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
</Sect1>
<Sect1 Id="HelpWindowConfiguration">
<Title>Help Window Configuration</Title>
<IndexTerm>
<Primary>help window, color resources</Primary>
</IndexTerm>
<IndexTerm>
<Primary>color, in help windows</Primary>
</IndexTerm>
<Para>You can change the colors of the topic tree and topic display
area in a help window. You can also modify the default size of
help windows.
</Para>
<ItemizedList Mark="&bull;">
<ListItem Id="HH4H.REF.item.124">
<Para><XRef Linkend="ToChangeHelpWindowColorsForAnApplication"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.125">
<Para><XRef Linkend="ToChangeHelpWindowDefaultSize"></Para>
</ListItem>
</ItemizedList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.126">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.127">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.128">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.129">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
<Sect2 Id="ToChangeHelpWindowColorsForAnApplication">
<Title>To Change Help Window Colors for an Application</Title>
<OrderedList>
<ListItem Id="HH4H.REF.item.130">
<Para>Create an <ComputerOutput>.Xdefaults</ComputerOutput> file in your home directory or
edit your current <ComputerOutput>.Xdefaults</ComputerOutput> file to include the
resources shown in the following example. The name of the color you
have chosen follows the : (colon) in the resource specification.</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.131">
<Para>Replace <Symbol Role="Variable">application_name</Symbol> with the name of the application
you want to change. If you do not know the name of the application,
consult your application documentation.</Para>
<Para>For a list of available colors, check with
your system administrator or refer to your system documentation.</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.132">
<Para>Start the application.</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.133">
<Para>To check the new colors, choose the application Help menu.
</Para>
</ListItem>
</OrderedList>
<Procedure>
<Title>Example</Title>
<Step>
<Para>This entry changes the background and foreground colors of
the topic tree (TocArea) and topic display area (DisplayArea)
for general help (DtHelpDialog) and quick help (DtHelpQuickDialog)
windows.</Para>
<Para>Because quick help windows do not have a topic tree, the
<ComputerOutput>TocArea</ComputerOutput> is omitted in the quick help
window resources.</Para>
<ProgramListing><Symbol Role="Variable">application_name</Symbol>*XmDialogShell.DtHelpDialog*DisplayArea.background: blue
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell.XmDialogShell.DtHelpDialog*DisplayArea.background: blue
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell.DtHelpDialog*DisplayArea.foreground: goldenrod
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell.XmDialogShell.DtHelpDialog*DisplayArea.foreground: yellow
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell.DtHelpDialog*TocArea.background: blue
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell*XmDialogShell.DtHelpDialog*TocArea.background: blue
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell.DtHelpDialog*TocArea.foreground: yellow
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell*XmDialogShell.DtHelpDialog*TocArea.foreground:yellow
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell.DtHelpQuickDialog*DisplayArea.background: blue
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell.XmDialogShell.DtHelpQuickDialog*DisplayArea.background: blue
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell.DtHelpQuickDialog*DisplayArea.foreground: yellow
<Symbol Role="Variable">application_name</Symbol>*XmDialogShell.XmDialogShell.DtHelpQuickDialog*DisplayArea.foreground: yellow
</ProgramListing>
</Step>
</Procedure>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.134">
<Para><XRef Linkend="HelpWindowConfiguration"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.135">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.136">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.137">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.138">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
<Sect2 Id="ToChangeHelpWindowDefaultSize">
<Title>To Change Help Window Default Size</Title>
<IndexTerm>
<Primary>help windows, changing default size</Primary>
</IndexTerm>
<Para>You can change the default window size for general help or quick help
windows by modifying resources. The &dquote;rows&dquote; resource
determines window height and the &dquote;columns&dquote; resource sets
the window width. The display font affects window dimensions.
</Para>
<OrderedList>
<ListItem Id="HH4H.REF.item.139">
<Para>Create an <ComputerOutput>.Xdefaults</ComputerOutput> file in your home directory or
edit your current <ComputerOutput>.Xdefaults</ComputerOutput> file.</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.140">
<Para>Choose which resources you want to add from the examples which follow.</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.141">
<Para>Replace <Symbol Role="Variable">application_name</Symbol> with the name of the application you
want to change and supply new rows and columns values. If you do not know
the name of the application, consult your application documentation.</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.142">
<Para>Start the application.</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.143">
<Para>To check the new window size, choose the application's Help menu. If
you have modified one of the quick help window types, be sure to
choose a topic that is displayed in the type of window you have changed.
</Para>
</ListItem>
</OrderedList>
<Procedure>
<Title>Examples</Title>
<Step>
<Para>For all general help windows:
</Para>
<ProgramListing><Symbol Role="Variable">application_name</Symbol>*DtHelpDialog.rows: 65
<Symbol Role="Variable">application_name</Symbol>*DtHelpDialog.columns: 45
</ProgramListing>
<Para>For all quick help windows:</Para>
<Note>
<Para>The Help System uses a quick help window to display
copyright information, glossary terms, definition links, and
Using Help information. This example changes all instances
of quick help windows.
</Para>
</Note>
<ProgramListing><Symbol Role="Variable">application_name</Symbol>*DtHelpQuickDialog.rows: 25
<Symbol Role="Variable">application_name</Symbol>*DtHelpQuickDialog.rows: 25
</ProgramListing>
<Para>For quick help windows used to display Using Help and copyright
information:</Para>
<ProgramListing><Symbol Role="Variable">application_name</Symbol>*onHelpDialog.rows: 25
<Symbol Role="Variable">application_name</Symbol>*onHelpDialog.columns: 25
</ProgramListing>
<Para>For definition link quick help windows:</Para>
<ProgramListing><Symbol Role="Variable">application_name</Symbol>*definitionBox.rows: 10
<Symbol Role="Variable">application_name</Symbol>*definitionBox.columns: 20
</ProgramListing>
</Step>
</Procedure>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.144">
<Para><XRef Linkend="HelpWindowConfiguration"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.145">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.146">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.147">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.148">
<Para><Link Type="jump" Linkend="SDL-RESERVED-hometopic">Home Topic</Link>
</Para>
</ListItem>
</ItemizedList>
</Step>
</Procedure>
</Sect2>
</Sect1>
<Sect1 Id="ErrorMessages">
<Title>Help Error Messages</Title>
<IndexTerm>
<Primary>error messages</Primary>
</IndexTerm>
<ItemizedList Mark="&bull;">
<ListItem Id="HH4H.REF.item.149">
<Para>If the Help System cannot find a help volume, it displays
this message:</Para>
<Graphic Entityref="Help4HelpVolErrMsg" Id="HH4H.REF.fig.8"></Graphic>
<Para>Possible causes are:
</Para>
<ItemizedList Mark="&bull;">
<ListItem Id="HH4H.REF.item.150">
<Para>The application's help volume is not installed</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.151">
<Para>Your desktop help search path does not include the directory
where the help volume has been installed.</Para>
<Para>Ask your system administrator to verify that the
application's help volume is properly installed and
that your help search paths are set correctly.</Para>
</ListItem>
</ItemizedList>
</ListItem>
<ListItem Id="HH4H.REF.item.152">
<Para>If the Help Viewer cannot find the ID of a help topic in a help
volume, it displays a message like this:</Para>
<Graphic Entityref="Help4HelpIdErrMsg" Id="HH4H.REF.fig.9"></Graphic>
<Para>Possible causes are:
</Para>
<ItemizedList Mark="&bull;">
<ListItem Id="HH4H.REF.item.153">
<Para>A hyperlink points to a topic that does not exist or
whose ID has been changed</Para>
</ListItem>
<ListItem Id="HH4H.REF.item.154">
<Para>A hyperlink points to a valid ID in another help volume
that is not installed</Para>
<Para>Ask your system administrator to verify that the
application's help volume is properly installed and
that your help search paths are set correctly.
</Para>
</ListItem>
</ItemizedList>
</ListItem>
<ListItem Id="HH4H.REF.item.155">
<Para>If the run-time help volume (<ComputerOutput>.sdl</ComputerOutput> file) has an
error, the Help Viewer displays this message:</Para>
<Graphic Entityref="Help4HelpTopicErrMsg" Id="HH4H.REF.fig.10"></Graphic>
<Para>Possible causes:
</Para>
<ItemizedList Mark="&bull;">
<ListItem Id="HH4H.REF.item.156">
<Para>The run-time help volume may be incomplete or contain an error.</Para>
<Para>Ask your system administrator to check the help volume.</Para>
</ListItem>
</ItemizedList>
</ListItem>
</ItemizedList>
<Procedure>
<Title>See Also</Title>
<Step>
<ItemizedList Mark="&bull;" Role="tight">
<ListItem Id="HH4H.REF.item.157">
<Para><XRef Linkend="Reference"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.158">
<Para><XRef Linkend="Tasks"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.159">
<Para><XRef Linkend="Table-Of-Contents"></Para>
</ListItem>
<ListItem Id="HH4H.REF.item.160">
<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-->
Reference in New Issue View Git Blame Copy Permalink