home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 579b.lha / CustomHelp / CHmanual / Glossary.ch < prev    next >
Text File  |  1991-10-25  |  9KB  |  211 lines
  1. \pc Custom Help \ Glossary
  2.  
  3.   
  4. Ancestor Files:
  5. \l9    All files containing Ancestor Pages.
  6. \l
  7. Ancestor Page:
  8. \l9    Any page in the direct line of Parent Pages from a\
  9.             specific page back to the system Base Page.
  10. \l
  11. Auxiliary Files:
  12. \l9    The files containing the information necessary for the program\
  13. to run. These are the CH.cmd File and CH.prefs File. In addition the\
  14. optional file, CH.menu, contains the DW menu configuration. All of\
  15. these files must reside in the CH Directory.
  16. \l
  17. Base Files:
  18. \l9    The Data Files that are read in when the CH program is invoked.\
  19. These files contain the entry points in the CH page system. Each file\
  20. should contain at least one child page of the Base Group. This may\
  21. be either a Menu Page or an External Page. CH searches the\
  22. CH Directory for files matching the pattern "Base.#?" to find the\
  23. Base Files and build the Base Page. The Base Files remain\
  24. in memory the entire time that CH is active therefore you should try to\
  25. keep them small to conserve memory while containing all the information\
  26. you wish to be readily available. Pages in other files will have to be\
  27. loaded from disk by CH before being displayed.
  28. \rStarting/Startup Options
  29. \l
  30. Base Group:
  31. \l9    The Base Page (Parent Page of the group) and it's Child Page's.
  32. \l
  33. Base Page:
  34. \l9    The page that is built when CH is started, using the names of the\
  35. child pages of group "Base" found in the Base Files.\
  36. When the DW is opened for the first time the Base Page will be displayed.
  37. \rFiles/General Data File Info
  38. \l
  39. Command:
  40. \l9    A CH Command consists of an alpha-numeric character or characters\
  41. used to initiate a Instruction.\
  42. Each Command initiates a specific Instruction.\
  43. These Commands are configurable by the user and may be from one to\
  44. twenty characters long. While viewing the DW press the HELP key for\
  45. a complete list of Commands and the Instructions they execute.
  46. \l
  47. Command Read Mode:
  48. \l9    This is the mode used for reading Command input. It is entered\
  49. when the user enters the first character of a Command. During Command\
  50. Read Mode the DW title bar displays the message "Command Read:    Press\
  51. ESCAPE to abort" and the message area of the DW contains the entered\
  52. characters and a list of "Possible:" Commands. Use BACKSPACE to edit\
  53. the entered value. ESCAPE exits from Command Read Mode immediately,\
  54. without executing the Instruction. The associated Instruction is\
  55. executed when the entire Command is entered or the RETURN key is pressed,\
  56. if there is only one "Possible:" Command at that time.
  57. \l
  58. CH:
  59. \l9    Custom Help.
  60. \l
  61. CH Directory:
  62. \l9    The directory where the data and auxiliary files reside. The\
  63. CH Directory may be set in several ways. First, if a DIRECTORY or -D\
  64. Startup Option is used that will become the CH Directory. Next, if\
  65. a Startup Option is not used the directory "Assigned" the name "CHData:"\
  66. is it. Last, if neither of the first two methods are used the current\
  67. directory is the default CH Directory. If started from a CLI or\
  68. shell program, this is the CLI current directory. If started from WorkBench\
  69. the current directory is the one where the CH program resides. This\
  70. directory must contain the Base Files and the Auxiliary Files.
  71. \l
  72. Child Page:
  73. \l9    This is a way of refering to a page as it relates to the Parent Page\
  74. of a group. The Child Pages are one level down from the Parent Page.
  75. \l
  76. Data File:
  77. \l9    A CH Data File is any file that has been formatted for use by the\
  78. CH program. It must contain as least one Page Specification. Word Wrap,\
  79. Paragraph Indent, Related Item and Style Special Characters are all\
  80. optional.
  81. \l
  82. Descendant Page:
  83. \l9    This includes all of the pages of a Menu Page, down through it\
  84. Child Pages, and their Child Pages, and so on.
  85. \l
  86. Display Window (DW):
  87. \l9    This is the window that CH uses to display the data found in the\
  88. Data Files. It will appear on the current screen when the Hot Key\
  89. combination is pressed. see Using the Program/Gadgets and Areas for\
  90. details.
  91. \rUsing/Gadgets and Areas
  92. \l
  93. History:
  94. \l9    The History contains a list of the last ten pages accessed in\
  95. chronological order. Use the Last History Page Instruction to display\
  96. the history in reverse chronological order. While viewing the History\
  97. you may use the Next History Page Instruction to scan foreward through\
  98. the list.
  99. \rUsing/History Buffer
  100. \l
  101. Hot Key:
  102. \l9    The key combination required to open the DW.\
  103. The Hot Key and Qualifier are taken from the CH.prefs File when the\
  104. program is started. Startup Options allow you to override the values\
  105. found there.
  106. \l
  107. Instruction:
  108. \l9    A CH Instruction is the actual operation that CH performs.\
  109. A distinction must be made between an Instruction and a Command.\
  110. The Command being the key or keys necessary to initiate an Instruction.
  111. \l
  112. Mark:
  113. \l9    The mark is used to save a location that you might want to refer back\
  114. to. Once you have marked a location to return to it you just enter the\
  115. function key you have assigned to it or click on the Mark Gadget.
  116. \rUsing/Marks
  117. \l
  118. Menu Page:
  119. \l9    See Parent Page.
  120. \l
  121. Page:
  122. \l9    The block of text that is treated as a unit by the program. This\
  123. can be any size, it is not limited by the size of the screen, and is\
  124. scrollable in the DW.
  125. \l                    
  126. Page Group:
  127. \l9    A Page Group consists of one Parent(Menu) Page and a group of\
  128. Child Pages. The Page Group is the basis of the CH hierarchal system.\
  129. By defining the groups in your system you determine the access path to\
  130. all of the pages in the system.
  131. \l
  132. Page Name:
  133. \l9    The Page Name is used for search Instructions, Related Items and\
  134. Automatic Menu Pages. In a CH Page it is given in the Page\
  135. Specification.\
  136. In a Text File it is the file name. When a CH Page is displayed the\
  137. Page Name will be presented using the Page Name Style control characters.\
  138. This allows the user to set his own indent, style and colors\
  139. for the Page Name. See Using the Program/User Input Windows/Edit Display\
  140. Values for details.
  141. \rUsing/User/Edit Display Values
  142. \l
  143. Parent Page:
  144. \l9    (Menu Page) This is the top page of a group. Access to any of the\
  145. Child Pages in the group is possible directly from this page. The CH\
  146. multi-level hierarchy of pages is accomplished by meaking a Child Page in\
  147. one group a Parent Page of another group.
  148. \l
  149. Page Specification:
  150. \l9    The special characters placed in the Data File to define\
  151. the beginning of a page or in the case of an External Page the name of the\
  152. file containing the actual page data.
  153. \rFiles/Page Specifiers
  154. \l
  155. Related Items:
  156. \l9    A page may have a group of Related Items associated with it. These\
  157. provide the user with an easy way of moving from a page to any of it's\
  158. related pages. When the Related Item Instruction is selected a window with\
  159. a list of the current page's Related Items is presented to the user. He may\
  160. select one of the items using the up and down arrow keys and the RETURN\
  161. key. CH does an immediate jump to the selected item.
  162. \rUsing/Related Items
  163. \rFiles/Related Item Specifier
  164. \l
  165. Siblings:
  166. \l9    All Child Pages within a group.
  167. \l
  168. Standby Mode:
  169. \l9    The mode entered after the program loads but before the Hot Key\
  170. combination is pressed. In Standby Mode the program runs as a background\
  171. task with no output window. The program goes into Standby Mode after it\
  172. is first started and when leaving the DW. To open the DW on the active\
  173. screen from Standby Mode enter the Hot Key combination.
  174. \l
  175. Startup Options:
  176. \l9    These are the Command line switches if CH is started from a CLI or\
  177. the Tool Types array of the CH icon, if started from WorkBench.
  178. \l
  179. Text File:
  180. \l9    This is any ASCII Text File that is not formatted for use by CustomHelp.\
  181. Text Files are treated as a single page by the CH program. Files accessed as\
  182. Text Files will be\
  183. displayed exactly as they are without the CH display options\
  184. (word wrap, paragraph indent, style conversions, etc.) There are two\
  185. ways of accessing Text Files. 
  186. \rUsing/Text Files
  187. \l
  188. \l    1. External Text Page Specification:
  189. \l12    Any file loaded via this method will be accessed as a Text File,\
  190. reguardless of the presence or absence of Page Specifications.
  191. \l    2. From a Directory Menu Page:
  192. \l12    Even if the file contains Page Specifications.
  193. \l
  194. Unused Files:
  195. \l9    These are any memory resident files not necessary to re-display either\
  196. the current page or any Marked pages. This includes any files containing\
  197. Ancestor Pages of either the current page or any Marked pages.
  198. \rUsing/Memory Management
  199. \l
  200. User Input Windows:
  201. \l9    These are the windows that are opened by the program, on the DW's\
  202. screen, to request information, post info messages and post serious error\
  203. messages. 
  204. \rUs/User Input Windows
  205. \l
  206. Word Wrap:
  207. \l9    This mode causes CH to attempt to break lines of text being displayed\
  208. at the closest word before the right hand side of the DW.
  209. \rUs/Word Wrap
  210.  
  211.