home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / help / a285_1 / MHelp < prev   
Text File  |  1993-06-02  |  11KB  |  207 lines

  1. Help on Help
  2. .SECTION contents
  3. .PAGE contents
  4. |E{TITLE}Contents for How to use Help
  5.  
  6. If you have not used help before, choose Help Introduction. Use the |G{Glossary,scroll_bar}scroll bar|E{NORMAL} to view information not visible in the Help window.
  7.  
  8. |E{BOLD}To choose a Help topic
  9. |B|TClick on the highlighted |G{Glossary,topic}topic|E{NORMAL} you want to look at.
  10.  
  11. |E{BOLD}Introduction
  12. |J{intro,intro}Help Introduction
  13.  
  14. |E{BOLD}How to...
  15. |J{actions,annotate}Annotate a help topic
  16. |J{actions,jump}Choose a jump
  17. |J{actions,bookmark}Define and use Bookmarks
  18. |J{actions,find}Finding specific topics
  19. |J{actions,get_help}Get Help from your Application
  20. |J{actions,print}Print a Help Topic
  21. |J{actions,search}Search for a Help Topic
  22.  
  23. |E{BOLD}Commands and buttons
  24. |J{menu,edit}Edit Menu Commands
  25. |J{menu,help}Help Menu Commands
  26. |J{menu,print}Print Menu Commands
  27. |J{menu,butt}Help Buttons
  28. .SECTION intro
  29. .PAGE intro
  30. |E{TITLE}Help Introduction
  31.  
  32. The Help Program is an interactive aid to learning to use applications. It enables you to quickly find out information that you need while using a program, without having to search through lots of bulky manuals. In addition, it guides you to other relevant subjects, and records the pages you have already looked at so that you can find them again more easily.
  33.  
  34. The Help Program allows you to place |G{Glossary,bookmark}bookmarks|E{NORMAL} in the text and to add |G{Glossary,annotation}annotations|E{NORMAL} of your own for future reference. You can work your way through the information either by using the |G{Glossary,button}buttons|E{NORMAL} at the top of the Help Window, or by using |G{Glossary,jump}jumps|E{NORMAL} to find related information. The Glossary can be used to find the meanings of words that you are unfamiliar with, or which you do not understand in the context that you see them. Try that now by clicking on one of the underlined words in this paragraph.
  35.  
  36. |J{contents,contents}Contents Page
  37. .SECTION menu
  38. .PAGE butt
  39. |E{TITLE}Help Buttons 1
  40.  
  41. At the top of the Help Window are seven buttons to help you read and modify your help files.
  42.  
  43. |S{index}
  44. |E{BOLD}The Contents Button
  45. Pressing the Contents Button takes you back to the first page of the help file, which is a list of the major topics which you can choose from.
  46.  
  47. |J{actions,search}|S{examine}
  48. |E{BOLD}The Search Button
  49. The Search Button helps you to look for a particular item in the current help file. Pressing it opens a window in which you can enter a |G{Glossary,scroll_bar}keyword|E{NORMAL} and help will attempt to find all references to that word and present them in a list from which you can choose an entry for further examination.
  50.  
  51. |S{rewind} |S{forward}
  52. |E{BOLD}The Browse Buttons
  53. Each help file is split up into sections of related |G{Glossary,topic}topics|E{NORMAL}. The Browse buttons allow you to move backwards and forwards through the topics in the current section.
  54.  
  55. |J{,butt2}Continued...
  56. .PAGE butt2
  57. |E{TITLE}Help Buttons 2
  58.  
  59. |J{actions,retrace}|S{backtrack}
  60. |E{BOLD}The Retrace Button
  61. Pressing this reveals a list of the topics that you have examined from the current help file, and lets you revisit any one of them by clicking on it.
  62.  
  63. |J{actions,annotate}|S{paper_clip}
  64. |E{BOLD}The Annotation Button
  65. You can add your own text to a help file entry as aides-memoires for future reference. You do this by clicking on the Annotation Button, which produces a window into which annotations can be typed. Annotations are saved with the help text so that they will be there when you next read the help text.
  66.  
  67. |J{actions,bookmark}|S{bookmark}
  68. |E{BOLD}The Bookmark Button
  69. To help you quickly relocate items of specific interest, you can place bookmarks in the help text. The bookmark menu allows you to set a bookmark or go to one that had been set before. Bookmarks are saved with the help text, so they will be there the next time you read it.
  70.  
  71. |E{SUBTITLE}Related Topics
  72. |J{actions,annotate}Making an Annotation
  73. |J{actions,bookmark}Defining and using Bookmarks
  74. .PAGE edit
  75. |E{TITLE}Edit Menu Commands
  76. .PAGE help
  77. |E{TITLE}Help Menu Commands
  78.  
  79. |E{BOLD}Help on Help
  80.  
  81. This menu entry can be chosen to re-load this help file while viewing the help file of another application. This is useful to remind you how to use parts of the Application Help program.
  82.  
  83. |E{BOLD}Interactive Help
  84.  
  85. Selecting this option will load the Interactive Help Program if it is available.
  86.  
  87. |E{SMALL}If the Interactive Help Program does not load even when there is adequate free memory it may be necessary to 'revive' it by clicking |G{Glossary,menu}menu|E{SMALL} over the acorn at the extreme right hand side of the icon bar at the bottom of the screen, moving the pointer on to the arrow shape beside 'New task' and typing:
  88.  
  89.     |E{SMALL}RMReinit !Help
  90.  
  91. |E{SMALL}Then pressing the Return key.
  92.  
  93.  
  94. .PAGE print
  95. |E{TITLE}Print Menu Commands
  96. .SECTION actions
  97. .PAGE find
  98. |E{TITLE}Finding specific topics
  99.  
  100. There are many ways to help you find your way to particular help topics. The easiest ways are to use the |J{menu,butt}Browse Buttons|E{NORMAL} or to |J{actions,jump}choose a jump|E{NORMAL}. The following methods are often useful, especially when you are examining a big help file:
  101.  
  102. 1|H|J{,bookmark}Bookmarks
  103. 2|H|J{menu,butt}Displaying the Help Contents Page
  104. 3|H|J{,retrace}Retracing your steps
  105. 4|H|J{,search}Searching for a Help Topic
  106. .PAGE annotate
  107. |E{TITLE}Making an Annotation
  108.  
  109. It is possible to add your own comments to a help topic by entering annotations. An Annotation is made by clicking on the Annotation Button at the top of the help window:
  110.  
  111. |S{paper_clip}
  112. The Annotation window will appear, allowing you to type directly in to it. You can also drag files in to the window. When you have finished, click |E{BOLD}OK|E{NORMAL} to confirm the text you are entering and save it to disc with the help file, or |E{BOLD}Cancel|E{NORMAL} to discard it. A page in the help text that has an annotation is distinguished by the red paper clip on the Annotation button:
  113.  
  114. |S{spaper_clip}
  115. A page with no annotation has the black paper clip annotation button shown near the top of this page.
  116.  
  117. |E{BOLD}To remove an annotation
  118. Click on the Annotation Button to display the Annotation window, then press the |E{BOLD}Delete|E{NORMAL} button.
  119. .PAGE bookmark
  120. |E{TITLE}Defining and using Bookmarks
  121.  
  122. It is possible to set a bookmark to help you find a page of particular interest when you read the help text again. To do this, first click on the Bookmark Button at the top of the Help Window:
  123.  
  124. |S{bookmark}
  125. You will see a menu whose first entry is |E{BOLD}Set Bookmark|E{NORMAL}. Simply click on that entry to set a bookmark there. The lower part of the menu shows the names of all the pages where bookmarks are set. To visit one of these pages, click on its entry. If a page already has a bookmark, the first entry will say |E{BOLD}Remove Bookmark|E{NORMAL}. You can click on that to remove the bookmark if you want.
  126.  
  127. |E{BOLD}Related topics
  128. |J{,search}Searching for a Help Topic
  129. |J{,retrace}Retracing your steps
  130. .PAGE jump
  131. |E{TITLE}Choosing a jump
  132. .PAGE get_help
  133. |E{TITLE}Getting Help from your Applications
  134.  
  135. |E{SUBTITLE}Getting Help from Applications in filer windows
  136.  
  137. To get help on an application in a filer window, click the middle mouse button, |E{BOLD}Menu|E{NORMAL}, over it and move over the entry that gives the filename of the object that you are interested in. A submenu will appear in which there will be a |E{BOLD}Help|E{NORMAL} option. If it is greyed out, then no help is available.
  138.  
  139. |E{SUBTITLE}Getting Help from Running Applications
  140.  
  141. Some applications can provide help whilst they are running. They do this in two ways. Sometimes a window will have a help button in it which can be pressed to bring up a help page relevant to that window. It is also possible to get help on a window by positioning the pointer inside it and pressing |E{BOLD}Alt-F1|E{NORMAL}.
  142.  
  143. .PAGE print
  144. |E{TITLE}Printing Help Topics
  145.  
  146. To print the current page of help information, simply move across |E{BOLD}Print|E{NORMAL} in the Help Window Menu, and select |E{BOLD}Print this Page|E{NORMAL}. Alternatively, you can select Print all Pages. A |G{Glossary,dbox}dialogue box|E{NORMAL} will appear with a field into which you can type the number of copies you wish to print. An |G{Glossary,optic}Option icon|E{NORMAL} in this box allows you to switch annotations on and off. Annotations are printed on separate pages following the page which they supplement.
  147. .PAGE search
  148. |E{TITLE}Searching for a Help Topic
  149.  
  150. The Help Application provides a powerful searching facility to help you find topics that are not easily reached using other methods. To start a search, press the Search Button:
  151.  
  152. |S{examine}
  153. The Search Window will appear. This has three areas, at the top is a box in to which you can type the name of a topic you wish to look for. Alternatively, you can use the |G{Glossary,scroll_bar}scroll bar|E{NORMAL} just below to search through a list of some of the topics that are covered in the help file. Clicking on one of these will enter it in to the box at the top of the window. Press |E{BOLD}Find|E{NORMAL} when you have chosen the topic that you wish to search for. In the lower half of the window is another box with a scroll bar beside it. A list of pages with references to the named topic will appear in this lower box. You can choose one of them by clicking on it and then pressing |E{BOLD}OK|E{NORMAL}. Alternatively, you can |G{Glossary,double}Double-Click|E{NORMAL} on one of the topics and the page will be found, leaving the Search Window open, allowing you to select another of the listed pages, or begin another search.
  154.  
  155. |E{BOLD}Related topics
  156. |J{,bookmark}Bookmarks
  157. |J{,retrace}Retracing your steps
  158. .PAGE retrace
  159. |E{TITLE}Retracing your steps
  160.  
  161. The Retrace Button looks like this:
  162.  
  163. |S{backtrack}
  164.  
  165. It can be used in two distinct ways:
  166.  
  167. The simplest way to use it is to click on it with |G{Glossary,select}Select|E{NORMAL}. This causes a list of the pages that you have already visited in the current help file to be displayed. You can revisit any one of them just by clicking on the relevant entry.
  168.  
  169. You can also click the Retrace Button with |G{Glossary,adjust}Adjust|E{NORMAL}. This takes you back to the page that you were looking at immediately before the current page.
  170.  
  171. |E{BOLD}Related topics
  172. |J{,bookmark}Bookmarks
  173. |J{,search}Searching for a Help Topic
  174. .SECTION Glossary
  175. .PAGE adjust
  176. .PAGE annotation
  177. .PAGE bookmark
  178. .PAGE button
  179. .PAGE dbox
  180. .PAGE double
  181. .PAGE jump
  182. .PAGE menu
  183. .PAGE optic
  184. .PAGE select
  185. .PAGE scroll_bar
  186. .PAGE topic
  187. .SEARCH
  188. adjust
  189. annotation
  190. application
  191. bookmark
  192. button
  193. dbox
  194. glossary
  195. help
  196. introduction
  197. jump
  198. menu
  199. optic
  200. pointer
  201. print
  202. search
  203. scroll_bar
  204. topic
  205. window
  206. .END
  207.