DECwindows (helphelp) — VMS 5.2
Additional information available:
Aboutframe
=Title About DECwindows Help =INCLUDE overview =INCLUDE overview over_basics Software Version: VMS Version 5.1 Help Version: New documentation The information in these texts is subject to change without notice and should not be construed as a commitment by Digital Equipment Corporation. The software described in these texts is furnished under a license and may be used or copied only under the terms of such license. No responsibility is assumed for the use or reliability of software on equipment that is not supplied by Digital Equipment Corporation or its affiliated companies. Copyright © 1988 by Digital Equipment Corporation All rights reserved
Glossary
=Title Help Glossary This is a glossary for DECwindows Help terms. No generic DECwindows terms are defined here. Select the term you require from the list of additional topics below.
Additional information available:
topic
=title Topic =keyword topic =INCLUDE overview over_guide_functions =INCLUDE overview A topic is a basic unit in the Help library. If it is longer than the window, the scroll bar can be used to view the rest of the topic.
Go to
=title Go To =keyword Go To =include overview menus_go menus_go_goto To perform a Go To operation on a topic means to finish with the topic you are currently viewing, close it, and open a new window containing the requested new topic. This is to be compared to Visit, where the current window remains open, and an additional window is opened to display the requested new topic.
history
=title History =keyword history =include overview menus_search menus_search_history Every time you perform a Visit or Go To operation on a Help topic, Help records the title. The list of titles that this creates is called a History. The Go Back button and menu item use this history to display each previous topic as you request it. You can also access the History through the History menu item of the Search menu. This enables you to quickly return to a topic which is a long way back in the History list.
keyword
=title Keyword =keyword keyword =include overview menus_search menus_search_keyword Many help topics have keywords associated to them. These provide an additional way to find the topic you are looking for, when you are not sure what the title of such a topic might be. Keywords can be viewed and searched through the Keyword... menu item of the search menu.
Visit
=title Visit =keyword visit =include overview menus_go menus_go_visit To Visit a topic means to leave the current topic open in its window, and open an additional window to display the requested new topic. This is to be compared to Go To, where the current topic window is closed, and the new topic replaces it.
Overview
=Title Overview of Help on Help =keyword overview =include overview over_guide_functions cshelp =include overview over_guide_functions buttons_goback =include overview over_guide_functions buttons_exit This is the Help on Help overview. The Help system works in much the same way as other DECwindows applications, so learning how Help behaves will teach you a lot about how to use other applications. You need to be able to perform four basic tasks: - Select an additional topic - Return to a previous topic - Use context-sensitive help - Exit from Help For more information on any of these tasks, double click MB1 on the appropriate additional topic below. If you want help on all of the tasks, start with Selecting Additional Topics. To dismiss Help on Help click on the Exit button below.
Additional information available:
over basicsOver guide functionsMenus FileMenus EditMenus GoMenus Search
Menus Help
over basics
=TITLE DECwindows Basics =keyword basics session manager help =include overview =include overview Over_guide_functions =include overview Over_guide_functions cshelp Basic information about using DECwindows, such as how to manage windows, how to use dialog boxes, and how to use scroll bars, is available from Session Manager help. Also, many DECwindows terms are explained in Session Manager help. To get Session Manager help, move the pointer to the icon box and press mouse button 1 (MB1) twice quickly on the session manager icon. The session manager icon is the icon that contains your user name and the name of your system. The Session Manager window is displayed on your screen. Move the pointer to the Help menu in the Session Manager window. Press and hold MB1 to pull down the Help menu. Move the pointer to the overview menu item and release MB1. Overview provides details about using DECwindows.
Over guide functions
=Title Selecting Additional Topics =keyword selecting topics Most Help topics include a list of related topics in the additional topics area. To see one of these additional topics, position the pointer over the topic you want and double click MB1. To see a list of all topics, select Title... from the Search menu. To continue on this tour, double click on Returning to Previous Topics from the list of additional topics below.
Additional information available:
buttons gobackcshelpbuttons exitOver guide window
buttons goback
=Title Returning to Previous Topics =keyword buttons goback =include overview over_guide_functions cshelp =include overview over_guide_functions buttons_exit =include overview over_guide_functions over_guide_window =INCLUDE overview =INCLUDE overview over_guide_functions There are two buttons at the bottom of the Help window, labelled Go Back and Exit. Selecting the Go Back button displays the previous topic. This is useful if you want to review something, or you find that you have taken the wrong path and you are not getting the help you thought you were going to get. To use the Go Back button simply click on it. To complete this tour, double click on Exiting Help from the list of additional topics below.
cshelp
=TITLE What is Context-Sensitive Help? =KEYWORD context-sensitive =INCLUDE overview over_guide_functions buttons_exit =include overview over_guide_functions buttons_goback =INCLUDE overview over_guide_functions =INCLUDE overview Context-sensitive help is a way of getting the information you need from the Help library, without having to work through from the Overview. To use this facility, you press the Help button on the keyboard, move the pointer over the subject on the screen that you want help on, then click MB1. This operation is just like using the shift key - you hold down the Help key until you have clicked MB1, then release the Help key. If context-sensitive help is available on the subject you have chosen, it will be displayed by the Help system, just as it would be if you had found the information by navigating from the Overview. If there is no help on your chosen topic, generally the Overview will be displayed instead.
buttons exit
=Title Exiting Help =keyword buttons goback =include overview over_guide_functions buttons_goback =include overview over_guide_functions cshelp =INCLUDE overview over_guide_functions =include overview over_guide_functions over_guide_window =INCLUDE overview menus_file =INCLUDE overview menus_edit =INCLUDE overview menus_go =INCLUDE overview menus_search =INCLUDE overview menus_help =INCLUDE overview There are two buttons in the Help window, labelled Go Back and Exit. Selecting the Exit button at closes the Help window and returns control to the application you were running when you asked for help. To use the Exit button you simply click on it. For information on other Help features, make an appropriate selection from the list of additional topics. Select one of the menus to look at some advanced help features.
Over guide window
=Title Help Window =keyword window help =INCLUDE overview menus_file =INCLUDE overview menus_edit =INCLUDE overview menus_go =INCLUDE overview menus_search =INCLUDE overview menus_help =include overview over_guide_functions buttons_goback =include overview over_guide_functions buttons_exit __________________________________ File Edit View Search Help Menu bar __________________________________ The text. Keywords from this text are picked out and displayed in Help topic the list below. Additional Topics: __________________________________ Topics Additional topics __________________________________ To find out more about a particular section of the Help window, select it from the list below.
Additional information available:
over guide help frameover guide list box
over guide help frame
=title Help Topics =keyword topic =include overview over_guide_functions over_guide_window over_guide_list_box =include overview over_guide_functions buttons_goback =include overview over_guide_functions buttons_exit =include csh resizing The help topic is the part of the window where the text itself is displayed. If the text is too wide for the current window, it can be resized. If the text is too long for the current window, it can be scrolled, using the scroll bar.
over guide list box
=title List of Additional Topics =keyword additionaltopics list =include overview over_guide_functions over_guide_window over_guide_help_frame =include overview over_guide_functions buttons_goback =include overview over_guide_functions buttons_exit =include overview over_guide_functions =include overview menus_go The list of additional topics identifies topics that can be selected from the current help topic. Selections can be made by double clicking on a topic, or by selecting the topic and then making a choice from the View menu.
Menus File
=Title File Menu
=keyword file save
=include overview menus_edit
=include overview menus_go
=include overview menus_search
=include overview menus_help
--------------- The file menu contains two menu items,
File Save As... and Exit.
---------------
| Save As... | The Save As... menu item saves a copy
| Exit | of the current help topic in a file.
|____________| You can use topics saved in this way as
input to other documents, or to print
out the information contained in a particularly useful
Help topic.
The Exit menu item closes the current Help window. Note
that this does not affect any other Help window that
might be open at the same time.
Menus Edit
=Title Edit Menu
=keyword edit
=include overview menus_file
=include overview menus_go
=include overview menus_search
=include overview menus_help
---------------- The Edit menu consists of two menu
Edit items. The Copy menu item copies
---------------- a selected portion of text into the
| Copy | clipboard.
| Select All |
|____________| The Select All menu item copies the
whole of the current help topic to
the clipboard.
For further details, select the appropriate menu item
from the list below.
Additional information available:
Menus Edit CopyMenus Edit Select
Menus Edit Copy
=Title Copy Menu Item =keyword copy =include overview menus_edit menus_edit_select =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help The Copy menu item in the Edit menu copies the selected portion of text into the clipboard. This is useful for copying details into another application, for example to fill in a text block in a paint program, or insert a detail into a Calendar meeting agenda. If you want to copy the whole topic, it is quicker to use the Select All menu item.
Menus Edit Select
=Title Select All Menu Item =keyword select copy =include overview menus_edit menus_edit_copy =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help The Select All menu item in the Edit menu is an easy way to select the whole of the current help topic. It can then be copied to the clipboard. Like Copy, this is useful for copying details into another application, for example to fill in a text block in a paint program, or insert a detail into a Calendar meeting agenda. Select All is more convenient to use when you want to copy an entire Help topic, but the effect is exactly the same as if you had selected all the text in the topic and then chosen the Copy option.
Menus Go
=Title View Menu
=keyword view
=include overview menus_file
=include overview menus_edit
=include overview menus_search
=include overview menus_help
-------------------- The difference between Go To and
View Visit is that Go To replaces
-------------------- the current help topic with a new
| Go To | one, while Visit creates a new
| Go Back | window for the new topic, so that
| Go To Overview | both the current topic and the new
|----------------| one are displayed simultaneously.
| Visit |
| Visit Glossary | Overview is the top level help
|________________| topic, the Glossary is a list of
terms specific to the application.
For more information on any View menu item, select the
appropriate menu item from the list below.
Additional information available:
Menus Go GotoMenus Go BackMenus Go VisitMenus Go Gotoover
Menus Go Visitgloss
Menus Go Goto
=Title Go To Menu Item =keyword Go To =include overview menus_go menus_go_back =include overview menus_go menus_go_gotoover =include overview menus_go menus_go_visit =include overview menus_go menus_go_visitgloss =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help After you have selected a topic from the list of additional topics, you can perform a Go To or Visit operation on that selection. If no topic is selected, these menu items are dimmed. Double clicking on the selected topic achieves the same result as selecting a topic and then selecting the Go To menu item. If you perform a Go To operation on the selection, the current help topic in the Help window is replaced by the new choice. In the Help system, performing a Go To operation is the most common operation. So in Help, selecting something from the list of additional topics by double clicking MB1 performs a Go To Topic operation. See the Visit menu item for the alternative to Go To.
Menus Go Back
=Title Go Back Menu Item =keyword go back =include overview menus_go menus_go_visit =include overview menus_go menus_go_goto =include overview menus_go menus_go_gotoover =include overview menus_go menus_go_visitgloss =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help Go Back replaces the current help topic with the preceding Help topic. It is possible to step back through all the Help topics you have seen. Stepping back through previous topics in this way can also be achieved using the Go Back button, which has exactly the same function as this menu item, or by using the History... menu item from the Search menu. Both these methods can be quicker than using this menu item, particularly if you want to go a long way back.
Menus Go Visit
=Title Visit Menu Item =keyword visit =include overview menus_go menus_go_goto =include overview menus_go menus_go_back =include overview menus_go menus_go_gotoover =include overview menus_go menus_go_visitgloss =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help After you have selected a topic from the list of additional topics, you can perform a Visit or Go To operation on that selection. If no topic is selected, these menu items are dimmed. When you perform a Visit operation on a chosen topic, the Help system displays the new topic in a separate window, so that you can see both old and new topics at the same time. This makes it possible to read two or more help topics simultaneously. See the Go To menu item for the alternative to Visit.
Menus Go Gotoover
=Title Go To Overview Menu Item =keyword overview Go To =include overview menus_go menus_go_goto =include overview menus_go menus_go_back =include overview menus_go menus_go_visit =include overview menus_go menus_go_visitgloss =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help Choosing the Go To Overview menu item causes the current help topic to be replaced by the Overview help topic for the current application. This topic provides access to the whole Help library for the current application.
Menus Go Visitgloss
=Title Visit Glossary Menu Item =keyword glossary visit Go To =include overview menus_go menus_go_goto =include overview menus_go menus_go_back =include overview menus_go menus_go_gotoover =include overview menus_go menus_go_visit =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help Choosing the Visit Glossary menu item causes the current application glossary to be displayed in a separate Help window. A term can then be selected from the glossary, and its definition is displayed in the Glossary window. Note: Not all applications use the Glossary menu item. In these cases, the Visit Glossary menu item from the View menu and the Glossary... menu item from the Help menu are dimmed or missing.
Menus Search
=Title Search Menu
=keyword search
=include overview menus_file
=include overview menus_edit
=include overview menus_go
=include overview menus_help
--------------- The Search menu contains three menu
Search items. The History... menu item allows
--------------- you to search through and choose from
| History... | a list of the Help topics you have
| Title... | already seen.
| Keyword... |
|____________| The Title... and Keyword... menu items
allow you to search through lists of
the titles or keywords of the current Help library.
For further details, select the requisite menu item
from the list of additional topics below.
Additional information available:
Menus Search HistoryMenus Search TitleMenus Search Keyword
Menus Search History
=Title History... Menu Item =include overview menus_search menus_search_title =include overview menus_search menus_search_keyword =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help Every topic that you select while in a Help session is recorded by the History... menu item. Selecting the History... menu item gives you see this record. Choose the History... menu item. A dialog box appears, listing all the topics viewed during the current Help session. The list is in chronological order, but duplicates are discarded. Select a topic in the usual way: double click on the topic to Go To the topic, or single click and then choose an operation by clicking on the desired push buttons. The Go Back button also uses the history record, in this case stepping back one topic at a time. The History... menu item provides a short cut if the topic you want is a long way back.
Menus Search Title
=Title Title... Menu Item =keyword search title =include overview menus_search menus_search_keyword =include overview menus_search menus_search_history =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help Every help topic has a title. The Title... menu item can be used to find a particular topic quickly. Selecting the Title... menu item causes a dialog box to appear. Click on the Apply button to display all the titles in the current Help library in the box. To make a more specific search, enter a word or phrase in the Title field, and click on the Apply button. Only those titles containing your word or phrase are then listed. After you have found the topic you require, select the topic in the usual way: double click on the topic to Go To the topic, or single click and then choose an operation by clicking on the desired push buttons.
Menus Search Keyword
=Title Keyword... Menu Item =keyword search keyword =include overview menus_search menus_search_history =include overview menus_search menus_search_title =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help The Keyword... dialog box finds help topics that relate to a keyword you choose from a list of keywords. The available keywords are displayed in a list in the Keyword... dialog box. To use the keywords, either select one from the list, or enter one directly in the Keyword field at the top of the box. Then click on the Apply button. The Topic Titles list will then display all the titles which match your chosen keyword. After you have found the topic you require, select the topic in the usual way: double click on the topic to Go To the topic, or single click and then choose an operation by clicking on the desired push buttons.
Menus Help
=Title Help Menu =keyword help =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search --------------- The Help menu contains three menu | Help | items. The Help menu item provides --------------- access to the Overview topic of the | Help | current application Help library. | Glossary | | About | The Glossary menu item visits the |_____________| current application's glossary. The About menu item provides copyright information about the current application software. For further details, select the appropriate menu item from the list below.
Additional information available:
Menus Help HelpMenus Help GlossaryMenus Help About
Menus Help Help
=Title Overview Menu Item =keyword help =include overview menus_help menus_help_glossary =include overview menus_help menus_help_about =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help Choosing this menu item causes a Help window to open, displaying the Overview topic. All the help for the application is available from this topic. You make an appropriate selection from the list of additional topics. Not all the topic titles are displayed in the additional topics lists -- the lists would get too long. If you do not see what you are looking for, pick something close, and then scan the additional topics list of the new topic. Alternatively, do a title search by selecting Title... from the Search menu. For example, in the Overview topic for the Calendar application, only the menu names are displayed in the list, not the individual menu items. So here, you would choose the menu name first, and then select the menu item you are looking for from the next list.
Menus Help Glossary
=Title Glossary Menu Item =keyword glossary =include overview menus_help menus_help_about =include overview menus_help menus_help_help =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help Choosing the Glossary menu item causes the Help Glossary to be displayed in a separate Help window. You can then select a term from the Glossary, which will cause its definition to be displayed in the Glossary window.
Menus Help About
=Title About Menu Item =keyword about =include overview menus_help menus_help_help =include overview menus_help menus_help_glossary =include overview menus_file =include overview menus_edit =include overview menus_go =include overview menus_search =include overview menus_help The About menu item provides information about the current application software, for example the formal name, the copyright notice, and the version number. This information provides legal protection for application software.