home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / HELPPRG.ZIP / HELPSAMP.TXT < prev   
Text File  |  1989-07-05  |  9KB  |  307 lines
  1. .context List Categories
  2. .list
  3. HELPSAMP Help
  4. .context h.default
  5. .context About HELPSAMP
  6. .topic General
  7. This is the main screen of help that first shows when you first open
  8. the database under QuickHelp. It is also the text that will show
  9. under PM using the help DLL, HELPLIB.DLL, a number of ways:
  10.  
  11. \b1)\p It should appear when the user presses F1 in your application
  12. without having a specific help request. This is the default help.
  13.  
  14. \b2)\p When the Help dialog box is already open, if the user presses the
  15. F1 key, as the DLL chains it way up the help tree, it will eventually
  16. chain back to here.
  17.  
  18. It is the highest level help possible. I have also referenced it as
  19. the 'About HELPSAMP' topic.
  20.  
  21. .context HELPSAMP Help
  22. .context HELPINDEX
  23. .topic INDEX OF TOPICS
  24. .list
  25. About HELPSAMP
  26. About Box
  27. File (pull down)
  28. Boxes (pull down)
  29. Chaining Help
  30. Colors in Help
  31. Help In Boxes
  32. Help In Dialog Boxes
  33. Help In Message Boxes
  34. Keystroke Help
  35. New
  36. Open
  37. Save
  38. Save As
  39.  
  40. .context About Box
  41. .category About HELPSAMP
  42. .topic About Box
  43. This is the help screen displayed when F1 is pressed when the About
  44. Dialog box is displayed. It also will display when the HELP
  45. pushbutton is pressed in this box.
  46.  
  47. The About Box displays version information about HELPSAMP
  48.  
  49. .context File (pull down)
  50. .category About HELPSAMP
  51. .topic File (pull down)
  52. Use the choices on the FILE pull-down file oriented procedures
  53.  
  54. \bNew\p     \
  55. Creates a new file.
  56.  
  57. \bOpen\p     \
  58. Opens an existing file.
  59.  
  60. \bSave\p     \
  61. Saves file under current file name.
  62.  
  63. \bSave As\p   \
  64. Saves file under new name.
  65.  
  66. \bAbout\p  \
  67. Displays copyright and version information about HelpSamp.
  68.  
  69. .context New
  70. .category File (pull down)
  71. .topic New
  72. Here is where you would put help text describing the \bNew\p menu
  73. option. By pressing the F1 key from here you will chain back to the
  74. \bFile\p menu help screen. This is because the category of this
  75. context points back there.
  76.  
  77. .context Open
  78. .category File (pull down)
  79. .topic Open
  80. Here is where you would put help text describing the \bOpen\p menu
  81. option. By pressing the F1 key from here you will chain back to the
  82. \bFile\p menu help screen. This is because the category of this
  83. context points back there.
  84.  
  85. .context Save
  86. .category File (pull down)
  87. .topic Save
  88. Here is where you would put help text describing the \bSave\p menu
  89. option. By pressing the F1 key from here you will chain back to the
  90. \bFile\p menu help screen. This is because the category of this
  91. context points back there.
  92.  
  93. .context Save As
  94. .category File (pull down)
  95. .topic Save As
  96. Here is where you would put help text describing the \bSave As\p menu
  97. option. By pressing the F1 key from here you will chain back to the
  98. \bFile\p menu help screen. This is because the category of this
  99. context points back there.
  100.  
  101. .context Boxes (pull down)
  102. .context Help In Boxes
  103. .category About HELPSAMP
  104. .topic Boxes (pull down)
  105. Use the choices on the BOXES pull-down to select miscellaneous
  106. functions that will demontrate how to get help within dialog
  107. boxes and message boxes.
  108.  
  109. \bDialog Box...\p  \
  110. Displays a dialog box
  111. and its corresponding help button. Choosing HELP in the dialog box
  112. will display dialog specific help.
  113.  
  114. \bMessage Box...\p  \
  115. Displays a message box
  116. and its corresponding help button. Choosing HELP in the message box
  117. will display message specific help.
  118.  
  119. .context Help In Dialog Boxes
  120. .category Help In Boxes
  121. .topic Help In Dialogs
  122. This is the help text displayed when you highlight the \bDIALOG
  123. BOXES\p menu choice under the \bBOXES\p menu choice and press the 
  124. F1 key. You can also display this text by choosing the Help
  125. In Dialog Boxes entry in the INDEX listbox.
  126.  
  127. Choosing the \bDialog Box...\p menu entry will display a dialog
  128. box with a help button. Pressing F1 when that dialog box is displayed
  129. will display context sensitive help for that box.
  130.  
  131. .context Help In Message Boxes
  132. .category Help In Boxes
  133. .topic Help In Message Boxes
  134. This is the help text displayed when you highlight the \bMessage
  135. Box 1\p or \bMessage Box 2\p menu choice under the \bBOXES\p menu
  136. choice and press the F1 key. You can also display this
  137. text by choosing the Help In Message Boxes entry in the INDEX listbox.
  138.  
  139. Choosing the \bMessage Box 1...\p or \bMessage Box 2...\p menu entry 
  140. will display a message box with a help button. Pressing F1 when
  141. that message box is displayed will display context sensitive help
  142. for that box.
  143.  
  144. .context Message Box 1
  145. .category Help In Message Boxes
  146. .topic Box 1
  147. Here is the help displayed when F1 is pressed (or pushbutton is
  148. activated) in \bMessage Box 1\p.
  149.  
  150. Notice this help is \unot\p in the index of topics. It can only
  151. be referenced by a direct call from your program. This is great
  152. for error messages.
  153.  
  154. .context Message Box 2
  155. .category Help In Message Boxes
  156. .topic Box 2
  157. Here is the help displayed when F1 is pressed (or pushbutton is
  158. activated) in \bMessage Box 2\p.
  159.  
  160. Notice this help is \unot\p in the index of topics. It can only
  161. be referenced by a direct call from your program. This is great
  162. for error messages.
  163.  
  164. .context KEYS
  165. .context Keystroke Help
  166. .category About HELPSAMP
  167. .topic Keys
  168. The keys are arranged in groups. Use:
  169.  
  170. -\bsystem\p keys to switch between programs \
  171. -\bwindow\p keys to move
  172. around in a program window  \
  173. -\bpop-up window\p keys to select 
  174. and edit in pop-up windows.
  175.  
  176. When two keys are joined by a plus sign (+), it means that you should
  177. hold down the first key while you press the second key.
  178.  
  179. SYSTEM KEYS
  180.  
  181. switch to next windowed program = \bAlt+tab\p or click on window
  182.  
  183. switch to next program (including full-screen programs) = \bAlt+Esc\p
  184.  
  185. switch to Task Manager = \bCtrl+Esc\p or double-click on icon
  186.  
  187.  
  188. WINDOW KEYS
  189.  
  190. go to/from system menu = \bShift+Esc\p or Alt+spacebar
  191.  
  192. go to/from system menu of text window = \bShift+Esc\p or Alt
  193.  
  194. go to/from action bar = \bF10\p or Alt
  195.  
  196. move among choices on action bar and pulldowns = \barrow\p keys
  197.  
  198. move to choice on action bar = \bletter\p that is underlined in
  199. choice name
  200.  
  201. select choice on pull-down = \bletter\p that is underlined in
  202. choice name
  203.  
  204. scroll one line in list = \barrow\p keys or click on scroll bar
  205. arrows
  206.  
  207. go to first item in list = \bHome\p
  208.  
  209. go to last item in list = \bEnd\p
  210.  
  211. go to next list entry whose name starts with a certain letter = 
  212. \bfirst letter of any entry name\p
  213.  
  214. scroll contents of window up one page = \bPage Up\p or F7 or click
  215. on scroll bar above slider
  216.  
  217. scroll contents of window down one page = \bPage Down\p or F8 or
  218. click on scroll bar below slider
  219.  
  220. scroll contents of window left one page = \bCtrl+Page Up\p, Shift+F7,
  221. or click on scroll bar to left of slider
  222.  
  223. scroll contents of window right one page = \bCtrl+Page Down\p, 
  224. Shift+F8 or click on scroll bar to right of slider
  225.  
  226. move window = \bAlt+F7\p or drag window title bar
  227.  
  228. size window = \bAlt+F8\p or drag window border
  229.  
  230. minimize window = \bAlt+F9\p or click on "down arrow" icon
  231.  
  232. maximize window = \bAlt+F10\p or click on "up arrow" icon
  233.  
  234. restore window = \bAlt+F5\p or click on "double arrow" icon
  235.  
  236. close window = \bF3\p of Alt+F4 or double-click on system menu
  237.  
  238. get help = \bF1\p or hold mouse button down over choice and press F1
  239.  
  240. keys help (while in help) = \bF9\p or click on KEYS pushbutton
  241.  
  242. help index (while in help) = \bF11\p or click on INDEX pushbutton
  243.  
  244. go to/from help and program = \bAlt+F6\p or click on window
  245.  
  246.  
  247. POP-UP WINDOW KEYS
  248.  
  249. move to another field in the group = \barrow\p keys or click on field
  250.  
  251. move to another group of field = \btab\p or click on group
  252.  
  253. set checkbox on/off = \bSpacebar\p or click on checkbox
  254.  
  255. remove pop-up window = \bEsc\p or click on CANCEL pushbutton
  256.  
  257. complete pop-up window = \bEnter\p or click on appropriate pushbutton
  258.  
  259.  
  260. EDITING KEYS
  261.  
  262. beginning of field = \bHome\p or Ctrl+left arrow key
  263.  
  264. end of field = \bEnd\p or Ctrl+right arrow key
  265.  
  266. delete character to the right of the cursor = \bDel\p
  267.  
  268. delete character to the left of the cursor = \bLeft arrow delete\p
  269. (backspace) key
  270.  
  271. erase to end of field = \bCtrl+Del\p
  272.  
  273. select text in a field = \bShift+arrow\p keys or drag
  274.  
  275. delete selected text completely = \bDel\p
  276.  
  277. delete selected text, but copy it to clipboard = \bShift+Del\p
  278.  
  279. copy selected text to clipboard = \bCtrl+Ins\p
  280.  
  281. copy selected text from clipboard to selected position = 
  282. \bShift+Ins\p
  283.  
  284. replace selected text with clipboard contents = \bShift+Ins\p
  285.  
  286. .context Colors in Help
  287. .category About HELPSAMP
  288. .topic Colors
  289. You can highlight your help text in many ways using HELPLIB. Below
  290. you will see examples of the different colors available:
  291.  
  292. NORMAL text looks like this
  293.  
  294. \bBOLD text shows up like this\p
  295.  
  296. \iITALICS text shows up like this\p
  297.  
  298. \uUNDERLINE text like this\p
  299.  
  300. \b\iThe combination of BOLD & ITALICS\p
  301.  
  302. Any other combination of \\b, \\i, and \\u will result in text
  303. that you can't see!!
  304.  
  305. .context EOF
  306.  
  307.