Help ReferencereferenceSee AlsoHome Topic
Help Menushelp window menusmenus, in help windowThe Help menus in the help window are:
See AlsoHome Topic
help window menus&sigspace;Help File Menuhelp, File menuPrintOpens the Print dialog
CloseCloses the help window
When using Help Manager to view help information, the
Help File menu includes a New Window command.
New WindowCreates a copy of the current general help
window
See AlsoHome Topic
Help Edit Menuhelp, Edit menuCopyCopies selected text to the clipboard
See AlsoHome Topic
Help Search Menuhelp, Search menuIndexOpens the Index Search dialog box, which lists
the help volume's key words and phrasesSee AlsoHome Topic
Help Navigate Menuhelp, Navigate menuBacktrackReturns to the previous topic.Home TopicTakes you to the "home topic," or the first
topic of a help volume.HistoryOpens the History dialog box, which lists help volumes and
topics you've visited.The Backtrack and Home Topic commands are available in a pop-up menu
in the topic display area.
See AlsoHome Topic
Help Menuhelp, Help menuOverview - Using Help&sigspace;Provides help on using help windowsTable Of ContentsDisplays an outline of the topics in a help volumeTasksDisplays task instructions for using the Help SystemReferenceDisplays reference summaries for various Help features, such
as windows and dialog boxes, menus, and resourcesMouse And KeyboardProvides information on using the mouse and keyboard
commands in help windowsAbout HelpDisplays the version and copyright information for the Help System
See AlsoHome Topic
Help Pop-up MenuA Help pop-up menu is available in a general help window. 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.)BactrackReturns to the previous topic.
Home TopicReturns to the first topic of a help volume.
See AlsoHome Topic
Help Menu Shortcut Keyshelp, shortcut keysshortcut keysaccelerator keysUse these shortcut keys to activate Help menu commands:
CommandShortcut KeyPrintControl+P
CloseAlt+F4
CopyControl+C
IndexControl+I
BacktrackControl+B
HomeTopicControl+H
If your keyboard does not have an Alt key,
ask your system administrator to identify the corresponding key or
refer to your system documentation.
&sigspace;See AlsoHome Topic
Mouse Actions and Keyboard Commandskeyboard selectiontext, selecting with keyboardselection, with keyboardkeyboard commandsmouse, actions in help windowsMouse ActionsAction&sigspace;BehaviorClick mouse button 1Selects a topic in the topic tree or a
hyperlink and displays the content in the current help window.
Hold mouse button 1 and dragCopies selected text to the clipboard.Control+button&sigspace;1Selects a topic in the topic tree or
hyperlink and displays the content in a new window.Shift+button&sigspace;1Same as above.
Alt+button&sigspace;1Same as above.
If your keyboard does not have an Alt key ask your system administrator to
identify the corresponding key or refer to your system documentation.
&sigspace;Keyboard Commandskeyboard, selecting topicstopics, selecting with keyboardTo 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.You can use these keyboard commands in the following help window
areas:Topic TreeKeyCursor ActionUp ArrowUp one line
Down ArrowDown one line
ReturnDisplay help topic for selected title
Control+Return&sigspace;Display help topic for selected
title in a new window
Control+/Select topic tree list
Control+\Deselect topic tree list
Topic Display AreaKeyBehaviorUp Arrow or Left ArrowMove highlight to previous hyperlink
Down Arrow or Right ArrowMove highlight to next hyperlinkControl+/Select entire topic
Control+\Deselect entire topic
Control+CCopy selection to clipboard
Control+VPaste selection to clipboard
ReturnDisplay help topic for the
selected hyperlink
Control+Return&sigspace;Display help topic for the
selected hyperlink in a new window
Shift+F10Displays the pop-up menu Help WindowKeyBehaviorEscapeCancels an operation such as
scrolling or resizing. Otherwise, if there is no current operation, closes the help window.
Alt key+Up ArrowMoves window to top of window stack.
Alt key+Down Arrow&sigspace;Moves window to bottom of window
stack.
Buttons
Press Tab to move the selection highlight to the desired button and
press Return. Vertical Scroll BarsKeyCursor MovementUp ArrowScroll up
Down ArrowScroll down
Control+Up ArrowScroll to top of list or topic
Control+Down Arrow&sigspace;Scroll to end of list or topic
PageUp or PreviousScroll one screen up
PageDown or NextScroll one screen down
Horizontal Scroll BarsKeyCursor MovementLeft ArrowScroll left
Control+Left ArrowScroll to leftmost edge of data
Right ArrowScroll right
Control+Right Arrow&sigspace;Scroll to rightmost edge of dataSee AlsoHome Topic
Help Windows And Dialog Boxeshelp window, types ofSee AlsoHome Topic
General Help Windowgeneral help windowwindow, general helpA 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.
Any underlined text is a hyperlink.
You use hyperlinks to &dquote;jump&dquote; to other topics.
See To Select a Hyperlink for a description of hyperlinks.&sigspace;A general help window has these Help Buttons:BacktrackReturns to a previous topic.HistoryLists topics and help volumes that you visited and
enables you to redisplay a topic.IndexOpens a help index that you can search to find help
on a subject.
&sigspace;See AlsoHome Topic
Quick Help Windowquick help windowwindow, quick helpA quick help window is a streamlined help window. It has a topic display
area and one or more dialog buttons.
&sigspace;ButtonActionCloseCloses the quick help window
BacktrackGoes to the previous topic
PrintDisplays a Print dialog box
HelpDisplays Help on the quick help window
See AlsoHome Topic
History Dialog BoxHelp, History dialog box&sigspace;Help Volumes Visited&sigspace;Lists help volumes you have visitedHelp Topics VisitedList topics you have visited
To return to a volume or help topic, click its title in the History list.&sigspace;See AlsoHome Topic
Print Dialog BoxHelp, Print dialog box&sigspace;PrinterThe Help System uses your default printer (set by the LPDEST environment variable).CopiesType the number of copies you want to print.Paper SizeClick the paper size button to display the following choices:Letter8.5 x 11 in
Legal8.5 x 14 in
Executive7.25 x 10.5 in
A4210 x 297 mm
B5182 x 257 mm
Topics To Print&sigspace;&sigspace;Select the topic or topics to print:Current TopicPrint only the displayed topic (the default)Current and SubtopicsPrint the current topic
and any subtopics it containsTable of Contents and Index&sigspace;Print the Table of
Contents and Index of the help volumeEntire VolumePrint Table of Contents, Index, and all topics in the help volume
PrintPrints the topic or topics you have chosenCancelCloses the Print dialog boxHelpProvides a description of the Print dialog box
See AlsoHome Topic
Index Search Dialog BoxHelp, Index Search dialog boxSearchCurrentDisplays a Help index for the volume that you are viewing. The
current volume is the default.All VolumesDisplays a combined Help index for all help volumes
registered on your system.SelectedLists available help volumes in a dialog box (see ).
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.
ShowComplete Index&sigspace;Lists all the index entries found for the volume or
volumes you have chosen.Entries with:Type a word or phrase to search for in the index entries
of the volume or volumes you chose.Status LineIndicates 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".
Index Display AreaLists index entries found for the volume or volumes you chose, or
entries that match the search string you entered.
Start SearchSearches the index for the word or phrase supplied in the
Entries with field. Pressing Return also activates the search.CloseCloses the Index Search dialog box.
See AlsoHome Topic
Search Volume Selection Dialog BoxHelp, Index Search Volume Selection dialog box&sigspace;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.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.See AlsoHome Topic
Execution Link Confirmation Dialog BoxHelp, Execution Link Confirmation dialog boxhyperlinks, execution link policyexecution link, policyAn 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.The Help System default behavior is to display a confirmation
dialog box.Execution policy is controlled by the Help dialog widget resource
DtNexecutionPolicy. The default value is
help_execute_query_unaliased.To change the default behavior, you add the
execution policy resource to your .Xdefaults
file for the application you want to change.The set of resource values is:help_execute_allExecutes all execution links without
displaying a confirmation dialog box.help_execute_query_unaliasedDisplays 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.help_execute_query_allDisplays a dialog box for all
execution linkshelp_execute_noneDisables all execution links, but
displays the execution command in a dialog boxExampleTo disable all execution links within your application, perform
these steps:
Create an .Xdefaults file in your home directory or
edit the current .Xdefaults file to include this
resource:application_name*executionPolicy:help_execute_none
Replace application_name with the name of the application
you want to change. If you are unsure of the name of the application,
consult your application documentation.Start the application.To test your change, choose the application Help menu and display a topic
that contains an execution link.
Before modifying the execution policy for an application's help
volume, carefully review all execution link commands and their interaction
with your system.&sigspace;
For more information about the Help System execution policy
refer to the Help System Author's and Programmer's Guide.
See AlsoHome Topic
Help Window Configurationhelp window, color resourcescolor, in help windowsYou 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.
See AlsoHome Topic
To Change Help Window Colors for an ApplicationCreate an .Xdefaults file in your home directory or
edit your current .Xdefaults 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.Replace application_name with the name of the application
you want to change. If you do not know the name of the application,
consult your application documentation.For a list of available colors, check with
your system administrator or refer to your system documentation.Start the application.To check the new colors, choose the application Help menu.
ExampleThis 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.Because quick help windows do not have a topic tree, the
TocArea is omitted in the quick help
window resources.application_name*XmDialogShell.DtHelpDialog*DisplayArea.background: blue
application_name*XmDialogShell.XmDialogShell.DtHelpDialog*DisplayArea.background: blue
application_name*XmDialogShell.DtHelpDialog*DisplayArea.foreground: goldenrod
application_name*XmDialogShell.XmDialogShell.DtHelpDialog*DisplayArea.foreground: yellow
application_name*XmDialogShell.DtHelpDialog*TocArea.background: blue
application_name*XmDialogShell*XmDialogShell.DtHelpDialog*TocArea.background: blue
application_name*XmDialogShell.DtHelpDialog*TocArea.foreground: yellow
application_name*XmDialogShell*XmDialogShell.DtHelpDialog*TocArea.foreground:yellow
application_name*XmDialogShell.DtHelpQuickDialog*DisplayArea.background: blue
application_name*XmDialogShell.XmDialogShell.DtHelpQuickDialog*DisplayArea.background: blue
application_name*XmDialogShell.DtHelpQuickDialog*DisplayArea.foreground: yellow
application_name*XmDialogShell.XmDialogShell.DtHelpQuickDialog*DisplayArea.foreground: yellow
See AlsoHome Topic
To Change Help Window Default Sizehelp windows, changing default sizeYou 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.
Create an .Xdefaults file in your home directory or
edit your current .Xdefaults file.Choose which resources you want to add from the examples which follow.Replace application_name 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.Start the application.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.
ExamplesFor all general help windows:
application_name*DtHelpDialog.rows: 65
application_name*DtHelpDialog.columns: 45
For all quick help windows: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.
application_name*DtHelpQuickDialog.rows: 25
application_name*DtHelpQuickDialog.rows: 25
For quick help windows used to display Using Help and copyright
information:application_name*onHelpDialog.rows: 25
application_name*onHelpDialog.columns: 25
For definition link quick help windows:application_name*definitionBox.rows: 10
application_name*definitionBox.columns: 20
See AlsoHome Topic
Help Error Messageserror messagesIf the Help System cannot find a help volume, it displays
this message:Possible causes are:
The application's help volume is not installedYour desktop help search path does not include the directory
where the help volume has been installed.Ask your system administrator to verify that the
application's help volume is properly installed and
that your help search paths are set correctly.If the Help Viewer cannot find the ID of a help topic in a help
volume, it displays a message like this:Possible causes are:
A hyperlink points to a topic that does not exist or
whose ID has been changedA hyperlink points to a valid ID in another help volume
that is not installedAsk your system administrator to verify that the
application's help volume is properly installed and
that your help search paths are set correctly.
If the run-time help volume (.sdl file) has an
error, the Help Viewer displays this message:Possible causes:
The run-time help volume may be incomplete or contain an error.Ask your system administrator to check the help volume.See AlsoHome Topic