home *** CD-ROM | disk | FTP | other *** search
/ Windows 95 Secrets (4th Edition) / Windows95Secrets4thEdition.iso / tools / helpfile / helpgen / hlpgen.mac < prev    next >
Encoding:
Text File  |  1995-02-15  |  48.1 KB  |  1,477 lines
  1. .rem(=================================)
  2. .rem(|  Macro File for HelpGen Help  |)
  3. .rem(|Copyright 1994 Rimrock Software|)
  4. .rem(|     All rights reserved.      |)
  5. .rem(=================================)
  6. .start(main,Contents,HLPGEN.BMP,HelpGen Help)
  7. .top(Help)
  8. .top(Table of Contents)
  9. .n
  10. .b(Purpose) - Click on icon above.n.n
  11. .b(How to).n
  12. .in
  13. ##.j(lodmac,Load or Create a Macro file)
  14. ##.j(crehpj,Load or Create a Project File)
  15. ##.j(bldrtf,Build an RTF File)
  16. ##.j(bldhlp,Build a Help File)
  17. ##.j(lang,Use the HelpGen Macro Language)
  18. .un
  19. .n
  20. .b(Menu Commands).n
  21. .in
  22. ##.j(file,File Commands)
  23. ##.j(edit,Edit Commands)
  24. ##.j(generate,Build Commands)
  25. ##.j(testem,Test Command)
  26. ##.j(options,Option Commands)
  27. ##.j(help,Help Commands)
  28. .un
  29. .n
  30. .bj(glossary,demo.bmp)
  31. \tab
  32. .b(Glossary).n
  33. .n
  34. If you are unfamiliar with how Windows Help works, choose
  35.  .b(Help | How To Use Help) from the Help menu now.
  36. .end
  37. .rem(=================================)
  38. .rem( Icon topic                      )
  39. .rem(=================================)
  40. .ent(icon,Information,HelpGen ) \qc
  41. HelpGen version 1.21.  \'a9 1994 by Rimrock Software, all rights reserved..n.n \ql
  42. Under normal circumstances, if you want to create a help file with 
  43. the Windows help compiler, you must first create a help topic file 
  44. using a word processor that can save files in Rich Text Format (.p1(RTF)). 
  45. There are several basic problems with that approach:.n
  46. .in
  47. #n(1)Word processors cost a lot of money..n
  48. #n(2)Once you've purchased the word processor, you have to 
  49. learn how to use it.  This may not be a very productive use of 
  50. your programming time..n
  51. #n(3)You also have to learn how to use the word processor to 
  52. produce a file that is properly formatted for the help compiler.  
  53. This involves using items like underlining, double-underlining, 
  54. hidden text, footnotes, etc..n
  55. .un
  56. HelpGen eliminates these problems by allowing you to use your 
  57. favorite ASCII text editor to produce a HelpGen .p1(macro) file, which 
  58. HelpGen uses to create the RTF formatted file required by the 
  59. help compiler..n.n
  60. HelpGen automates the entire process of creating help files:.n
  61. .in
  62. ##Creates a skeleton macro file for you to edit.
  63. ##Invokes your editor to allow you to edit the macro file.
  64. ##Creates a help project file (.HPJ) to tell the help 
  65. compiler how to compile the help file.
  66. ##Generates an RTF file from the macro file.
  67. ##Invokes the help compiler to compile the RTF file into a 
  68. HLP file.
  69. ##Allows you to directly test the result..n
  70. .n
  71. .box
  72. The HelpGen macro engine is based on code written by David Spector, and published 
  73. in Windows/DOS Developer's Journal, Vol. 5, No. 7, July 1994.
  74. .bend
  75. .end
  76. .rem(=================================)
  77. .rem( Load/Create macros topic        )
  78. .rem(=================================)
  79. .ent(lodmac,Load/Create Macro File,How to )
  80. Select the .b(File | Open Macro File) menu option.  Select an existing .MAC file 
  81. or enter the name of a new file.  If you enter the name of a file that does not 
  82. exist, HelpGen will create the file for you, using a .p1(template) that contains the 
  83. minimum items required to build a help file..n
  84. .n
  85. If you have created a new .p1(macro) file, you should use the .b(Edit | Macro File) 
  86. option to make two changes to the file.  The first change is a new title for 
  87. the table of contents.  The default title is xxxx.  The second change is the 
  88. selection of a .BMP graphic to place on the table of contents title line.  The 
  89. default is HlpGen.BMP.
  90. .end
  91. .rem(=================================)
  92. .rem( Load/Create project file topic  )
  93. .rem(=================================)
  94. .ent(crehpj,Load/Create Project File,How to )
  95. HelpGen looks for an associated .p1(project) file when you open the current macro 
  96. file.  If it finds one, HelpGen will enable the .b(Edit | Project File) menu 
  97. item, and you won't have to build a project file.  If it doesn't find a project 
  98. file, HelpGen will enable the .b(Build | Project File) menu item to allow you to 
  99. create a project file.  You must select .b(Build | Project File) to 
  100. create the new project file..n
  101. .n
  102. .box
  103. .b(NOTE:) Before you build a project file, select the .b(Options | Project File) 
  104. menu item and make sure that all the items in that dialog are to your liking.  
  105. Those items will be used to create the project file.
  106. .bend
  107. .end
  108. .rem(=================================)
  109. .rem( how to build RTF file topic     )
  110. .rem(=================================)
  111. .ent(bldrtf,Build an RTF File,How to )
  112. Select the .b(Build | RTF File) menu item.  HelpGen will ask you if you are sure 
  113. you want to create an .p1(RTF) file.  If you answer 'yes', HelpGen will create a .RTF 
  114. file by processing the .MAC file.  Macros will be expanded and .p(rtfcmds,RTF commands) and 
  115. plain text will be passed through to the .RTF file.  When processing is complete, 
  116. HelpGen will tell you and will then enable the .b(Build | HLP File) menu item.
  117. .end
  118. .rem(=================================)
  119. .rem( how to build help file topic    )
  120. .rem(=================================)
  121. .ent(bldhlp,Build a Help File,How to )
  122. Select the .b(Build | HLP File) menu item.  HelpGen will ask you if you are sure 
  123. you want to create a help file.  If you answer 'yes', HelpGen will invoke the 
  124. .p(hlpcmplr,help compiler) you have selected in the .b(Options | Directories) menu item.  This 
  125. will involve shelling out to DOS, since help compilers are DOS programs.  When 
  126. HelpGen gets control again, it will enable the .b(Test) menu item, to allow you 
  127. to test the help file you have just created..n
  128. .n
  129. If there were errors generated during the help compilation, they will be listed in 
  130. the error log file that is shown in .b(Options | Project File)..n
  131. .n
  132. .box
  133. .b(NOTE:) When HelpGen invokes the help compiler, and for some reason the compiler 
  134. can't execute, HelpGen will notify you by displaying an error message.  To possibly 
  135. correct your problem, make sure that the proper help compiler is correctly chosen in 
  136. HelpGen's .b(Options | Directories) menu item.
  137. .bend
  138. .end
  139. .rem(=================================)
  140. .rem( using helpgen TOC topic         )
  141. .rem(=================================)
  142. .ent(lang,Macro Language,Using the HelpGen )
  143. .in
  144. ##.j(langbas,Macro Language Basics)
  145. ##.j(maccmd,Macro Language Commands)
  146. ##.j(rtfcmd,Useful RTF Commands)
  147. .un
  148. .end
  149. .rem(=================================)
  150. .rem( file commands topic             )
  151. .rem(=================================)
  152. .ent(file,File Commands,The )
  153. .in
  154. ##.j(open,Open Macro File)
  155. ##.j(close,Close Macro File)
  156. ##.j(print,Print Macro File)
  157. ##.j(exit,Exit)
  158. .un
  159. .end
  160. .rem(=================================)
  161. .rem( edit commands TOC topic         )
  162. .rem(=================================)
  163. .ent(edit,Edit Commands,The )
  164. .in
  165. ##.j(editmac,Edit Macro File)
  166. ##.j(edithpj,Edit Project File)
  167. .un
  168. .end
  169. .rem(=================================)
  170. .rem( build commands TOC topic        )
  171. .rem(=================================)
  172. .ent(generate,Build Commands,The )
  173. .in
  174. ##.j(genhpj,Project File)
  175. ##.j(genrtf,RTF File)
  176. ##.j(genhlp,HLP File)
  177. .un
  178. .end
  179. .rem(=================================)
  180. .rem( test command topic              )
  181. .rem(=================================)
  182. .ent(testem,Test Command,The )
  183. The .b(Test) menu item allows you to test the help file that you have 
  184. just generated.  It will only be enabled after you have generated a 
  185. help file.
  186. .s
  187. .bmpl(testrtf.bmp)You may also select this menu item with the .p1(toolbar) 
  188. Test Help File button.
  189. .end
  190. .rem(=================================)
  191. .rem( options commands TOC topic      )
  192. .rem(=================================)
  193. .ent(options,Options Commands,The )
  194. .in
  195. ##.j(optdir,Directories)
  196. ##.j(opthpj,Project File)
  197. .un
  198. .end
  199. .rem(=================================)
  200. .rem( help commands TOC topic         )
  201. .rem(=================================)
  202. .ent(help,Help Commands,The )
  203. .in
  204. ##.j(hlpcon,Contents)
  205. ##.j(about,About HelpGen)
  206. .un
  207. .end
  208. .rem(=================================)
  209. .rem( open macro file topic           )
  210. .rem(=================================)
  211. .ent(open,Open Macro File, )
  212. Open an existing .p1(macro) file, or create a new macro file to be edited 
  213. (.b(File | Open Macro File) menu item).  A check will be made for a 
  214. corresponding .p1(project) file.  If a project file exists, then the 
  215. .b(Edit | Project File) menu item will be enabled.  If a project file does 
  216. not exist, then the .b(Build | Project File) menu item will be enabled.  
  217. The HelpGen .p(titlebar,title bar) is updated to reflect the current macro file name.
  218. .s
  219. .bmpl(openrtf.bmp)You may also select this menu item with the .p1(toolbar) Open 
  220. Macro File button.
  221. .end
  222. .rem(=================================)
  223. .rem( close macro file topic          )
  224. .rem(=================================)
  225. .ent(close,Close Macro File, )
  226. The Close command closes all files and disables all HelpGen menu items that are 
  227. associated with open files (.b(File | Close Macro File) menu item).  The 
  228. HelpGen .p(titlebar,title bar) is updated to show that no .p1(macro) file is currently open.
  229. .s
  230. .bmpl(closertf.bmp)You may also select this menu item with the .p1(toolbar) Close 
  231. Macro File button.
  232. .end
  233. .rem(=================================)
  234. .rem( print macro file topic          )
  235. .rem(=================================)
  236. .ent(print,Print Macro File, )
  237. The Print command will print the current .p1(macro) file on any printer 
  238. (.b(File | Print Macro File) menu item).  You will be asked to select the 
  239. proper printer before any printing takes place.
  240. .s
  241. .bmpl(printrtf.bmp)You may also select this menu item with the .p1(toolbar) Print 
  242. Macro File button.
  243. .end
  244. .rem(=================================)
  245. .rem( exit topic                      )
  246. .rem(=================================)
  247. .ent(exit,Exit to Program Manager, )
  248. The Exit command closes all open files and shuts down the HelpGen program 
  249. (.b(File | Exit) menu item).
  250. .end
  251. .rem(=================================)
  252. .rem( edit macro file topic           )
  253. .rem(=================================)
  254. .ent(editmac,Edit Macro File, )
  255. The .b(Edit | Macro File) command executes a text editor and allows you to make 
  256. changes to the current .p1(macro) file.  The default text editor is NOTEPAD.EXE.  The 
  257. default editor may be changed using the .b(Options | Directories) menu item.
  258. .s
  259. .bmpl(edmacrtf.bmp)You may also select this menu item with the .p1(toolbar) Edit 
  260. Macro File button.
  261. .s
  262. .box
  263. .b(NOTE:) When HelpGen invokes the text editor, and for some reason the editor 
  264. can't be executed, HelpGen will notify you by displaying an error message.  
  265. To possibly correct your problem, make sure that the text editor is correctly 
  266. chosen in HelpGen's Options | Directories menu item.
  267. .bend
  268. .end
  269. .rem(=================================)
  270. .rem( edit project file topic         )
  271. .rem(=================================)
  272. .ent(edithpj,Edit Project File, )
  273. The .b(Edit | Project File) menu item executes a text editor and allows you to make 
  274. changes to the current .p1(project) file.  The default text editor is NOTEPAD.EXE.  The 
  275. default editor may be changed using the .b(Options | Directories) menu item.
  276. .s
  277. .bmpl(edhpjrtf.bmp)You may also select this menu item with the .p1(toolbar) Edit 
  278. Project File button.
  279. .s
  280. .box
  281. .b(NOTE:) When HelpGen invokes the text editor, and for some reason the editor 
  282. can't execute, HelpGen will notify you by displaying an error message.  
  283. To possibly correct your problem, make sure that the text editor is correctly 
  284. chosen in HelpGen's Options | Directories menu item.
  285. .bend
  286. .end
  287. .rem(=================================)
  288. .rem( build project file topic        )
  289. .rem(=================================)
  290. .ent(genhpj,Build Project File, )
  291. If you don't yet have a .p1(project) file for your current .p1(macro) file, this menu 
  292. item will be enabled (.b(Build | Project File) menu item).  It will create 
  293. a project file for you, based on the entries contained in the .b(Options) menu.  
  294. You may then make any changes to this file using the .b(Edit | Project File) 
  295. menu item.  The project file will have the same filename as the macro file, 
  296. with an extension of .HPJ.
  297. .s
  298. .bmpl(buhpjrtf.bmp)You may also select this menu item with the .p1(toolbar) Build 
  299. Project File button.
  300. .end
  301. .rem(=================================)
  302. .rem( build RTF file topic            )
  303. .rem(=================================)
  304. .ent(genrtf,Build RTF File, )
  305. The .b(Build | RTF File) menu item uses the current .p1(macro) file to build a Rich Text 
  306. Format (.p1(RTF)) file of the same name.  The RTF file is used as an input file for 
  307. the .p(hlpcmplr,help compiler).
  308. .s
  309. .bmpl(burtfrtf.bmp)You may also select this menu item with the .p1(toolbar) Build 
  310. RTF File button.
  311. .end
  312. .rem(=================================)
  313. .rem( build HLP file topic            )
  314. .rem(=================================)
  315. .ent(genhlp,Build HLP File, )
  316. The .b(Build | HLP File) menu item uses the current .p1(project) file and the .p1(RTF) file 
  317. created by HelpGen to create a Microsoft Help File (HLP).  It does this by 
  318. invoking the Microsoft (or other) help compiler.  The default help compiler is 
  319. HC31.EXE.  You may change the default help compiler by using the .b(Options | Directories) 
  320. menu item.
  321. .s
  322. .bmpl(buhlprtf.bmp)You may also select this menu item with the .p1(toolbar) Build 
  323. HLP File button.
  324. .s
  325. .box
  326. .b(NOTE:) When HelpGen invokes the help compiler, and for some reason the compiler 
  327. can't execute, HelpGen will notify you by displaying an error message.  To possibly 
  328. correct your problem, make sure that the proper help compiler is correctly chosen in 
  329. HelpGen's Options | Directories menu item.
  330. .bend
  331. .end
  332. .rem(=================================)
  333. .rem( directories options topic       )
  334. .rem(=================================)
  335. .ent(optdir,Directories,Set )
  336. The .b(Options | Directories) menu item allows you to select the .p(hlpcmplr,help compiler) 
  337. and text editor that HelpGen uses when building a help file or editing text.  The 
  338. entries that you make are also saved in HelpGen's .INI file and will be used each 
  339. time you execute HelpGen.
  340. .end
  341. .rem(=================================)
  342. .rem( project file options topic      )
  343. .rem(=================================)
  344. .ent(opthpj,Project File Options,Set )
  345. The .b(Options | Project File) menu item allows you to specify the options that 
  346. will be installed in a .p1(project) file that is created by HelpGen.  Some of these 
  347. options are saved in HelpGen's .INI file, so they may be used in subsequent 
  348. executions of HelpGen.  Specifically, the Compression type, Warnings, Report status, 
  349. Copyright notice and Error Log are all saved in the .INI file..n
  350. .n
  351. .i(Title).n
  352. The Title specifies the string that is placed on the Help File's .p(titlebar,title bar) when the help 
  353. file is executed..n
  354. .n
  355. .i(Copyright).n
  356. The Copyright specifies the string that is placed inside of the help file's About box.
  357. This box is activated by executing the help file and selecting .b(Help | About Help)..n
  358. .n
  359. .i(Error Log).n
  360. The Error Log is the file that the .p(hlpcmplr,help compiler) uses to write error messages to.  If 
  361. you have errors during a help compilation, look at this file to see what the errors 
  362. were..n
  363. .n
  364. .i(Icon File).n
  365. The Icon File entry specifies the icon that will be used when the help file is minimized.  
  366. This entry will override the default question mark icon..n
  367. .n
  368. .i(Bitmap Root).n
  369. The Bitmap Root specifies the directory that is used to store bitmap files, if they 
  370. are not in the current directory..n
  371. .n
  372. .i(Compression).n
  373. The Compression option specifies what type of compression is used when building 
  374. the help file.  .b(0) specifies no compression, .b(Medium) specifies 40% compression 
  375. and .b(High) specifies 50% compression..n
  376. .n
  377. .i(Warnings).n
  378. The Warnings option sets the level of error messages that the help 
  379. compiler will display during compilation. .b(Some) means only the most severe messages will 
  380. be displayed, .b(Many) means a medium amount of error messages will be displayed, 
  381. and .(All) means display all messages..n
  382. .n
  383. .i(Report).n
  384. The Report option determines the type of error messages that are displayed 
  385. during help file compilation.
  386. .end
  387. .rem(=================================)
  388. .rem( help contents topic             )
  389. .rem(=================================)
  390. .ent(hlpcon,Help Contents, )
  391. The .b(Help | Contents) menu item executes the help file you are currently reading.
  392. .s
  393. .bmpl(helprtf.bmp)You may also select this menu item with the .p1(toolbar) Help 
  394. Contents button.
  395. .end
  396. .rem(=================================)
  397. .rem( about helpgen topic             )
  398. .rem(=================================)
  399. .ent(about,About HelpGen, )
  400. The .b(Help | About HelpGen) menu item provides information about the current version 
  401. of the HelpGen program. 
  402. .end
  403. .rem(=================================)
  404. .rem( language basics topic           )
  405. .rem(=================================)
  406. .ent(langbas,Language Basics, )
  407. HelpGen Macro Files consist of distinct blocks of text. These blocks are 
  408. marked by HelpGen .p(macro,macros).  The first block is the \'2estart/\'2eend/\'2eend_file block:.n
  409. .n
  410. .[
  411. \li720
  412. \'2estart(......).n
  413. \tab Table of Contents stuff here.....n
  414. \'2eend.n.n
  415. \tab Rest of macro file goes here.....n.n
  416. \'2eend_file.n
  417. .]
  418. .n
  419. The rest of the macro file is broken up into \'2eent/\'2eend and 
  420. \'2epent/\'2eend blocks:.n
  421. .n
  422. .[
  423. \li720
  424. \'2estart(......).n
  425. \tab Table of Contents stuff here.....n
  426. \'2eend.n.n
  427. \'2eent(.....).n
  428. \tab Topic stuff here.....n
  429. \'2eend.n.n
  430. \'2eent(.....).n
  431. \tab Topic stuff here.....n
  432. \'2eend.n.n
  433. \'2eent(.....).n
  434. \tab Topic stuff here.....n
  435. \'2eend.n.n
  436. \'2epent(.....).n
  437. \tab Popup stuff here.....n
  438. \'2eend.n.n
  439. \'2epent(.....).n
  440. \tab Popup stuff here.....n
  441. \'2eend.n.n
  442. \'2eend_file.n
  443. .]
  444. .n
  445. Note the use of white space to separate the various blocks.  You may 
  446. also separate the blocks with remarks:.n
  447. .n
  448. .[
  449. \li720
  450. \'2erem(===== Beginning of topic 1 =====).n
  451. \'2eent(.....).n
  452. \tab Topic stuff here.....n
  453. \'2eend.n
  454. \'2erem(===== Beginning of topic 2 =====).n
  455. \'2eent(.....).n
  456. \tab Topic stuff here.....n
  457. \'2eend.n
  458. .]
  459. .n
  460. In order to display each of these blocks, you need to have jumps (\'2ej or 
  461. \'2ej1 for the \'2eent/\'2eend blocks and \'2ep or \'2ep1 for the 
  462. \'2epent/\'2eend blocks) somewhere in your macro file.  Since the help 
  463. file begins at the Table of Contents, there should definitely be some 
  464. jumps in that .p1(topic)..n
  465. .n
  466. All the rest of the HelpGen macros are basically window dressing for 
  467. the topic blocks.  See the various macro commands for examples of how 
  468. to use them..n
  469. .n
  470. HelpGen generates an RTF file that specifies four basic text fonts; 
  471. font 0 is MS San Serif, font 1 is Roman, font 2 is Courier and font 3 
  472. is Symbol.  Font 0 is used for topic headers, font 1 is used for 
  473. normal text in a topic and font 2 is used inside of the \'2e[ and 
  474. \'2e] macros.  Font 3 is not currently used..n
  475. .end
  476. .rem(=================================)
  477. .rem( macro commands TOC topic        )
  478. .rem(=================================)
  479. .ent(maccmd,Macro Language Commands, )
  480. .in
  481. ##.j(cmdstr,\'2estart)
  482. ##.j(cmdent,\'2eent)
  483. ##.j(cmdpent,\'2epent)
  484. ##.j(cmdend,\'2eend)
  485. ##.j(cmdj,\'2ej)
  486. ##.j(cmdj1,\'2ej1)
  487. ##.j(cmdp,\'2ep)
  488. ##.j(cmdp1,\'2ep1)
  489. ##.j(cmdbj,\'2ebj)
  490. ##.j(cmdtop,\'2etop)
  491. ##.j(cmdbmp,\'2ebmp)
  492. ##.j(cmdbmpl,\'2ebmpl)
  493. ##.j(cmdbmpr,\'2ebmpr)
  494. ##.j(cmdbox,\'2ebox)
  495. ##.j(cmdbend,\'2ebend)
  496. ##.j(cmdrem,\'2erem)
  497. ##.j(cmdin,\'2ein)
  498. ##.j(cmdun,\'2eun)
  499. ##.j(cmdpp,\'23\'23)
  500. ##.j(cmdpb,\'23b)
  501. ##.j(cmdpn,\'23n)
  502. ##.j(cmdb,\'2eb)
  503. ##.j(cmdi,\'2ei)
  504. ##.j(cmdob,\'2e[)
  505. ##.j(cmdcb,\'2e])
  506. ##.j(cmdn,\'2en)
  507. ##.j(cmds,\'2es)
  508. ##.j(cmdef,\'2eend_file)
  509. .un
  510. .end
  511. .rem(=================================)
  512. .rem( RTF commands TOC topic          )
  513. .rem(=================================)
  514. .ent(rtfcmd,RTF Commands,Some Useful )
  515. .in
  516. ##.j(cmdbrdrdb,\\brdrdb)
  517. ##.j(cmdbrdrs,\\brdrs)
  518. ##.j(cmdbrdrsh,\\brdrsh)
  519. ##.j(cmdbrdrth,\\brdrth)
  520. ##.j(cmdli,\\li)
  521. ##.j(cmdri,\\ri)
  522. ##.j(cmdql,\\ql)
  523. ##.j(cmdqr,\\qr)
  524. ##.j(cmdqj,\\qj)
  525. ##.j(cmdqc,\\qc)
  526. ##.j(cmdtab,\\tab)
  527. ##.j(cmdhh,\\'hh)
  528. .un
  529. .n
  530. .box
  531. .b(NOTE:) All .p(rtfcmds,RTF commands) should be separated from regular 
  532. text by some kind of 'white space'.  This includes a space (' ') or a 
  533. carriage return.
  534. .bend
  535. .end
  536. .rem(=================================)
  537. .rem( start macro topic               )
  538. .rem(=================================)
  539. .ent(cmdstr,\'2estart Macro,The )
  540. .b(SYNTAX:) \'2estart(label,topic,bitmap_file,application_name).n
  541. .n
  542. .b(EXPLANATION:) This .p1(macro) marks the beginning of a macro file.  
  543. It produces an attractive header for the Table of Contents .p1(topic).  
  544. .b(label) and .b(topic) are as described for the \'2eent macro.  
  545. .b(bitmap_file) is the filename of a \'2eBMP file generated by 
  546. a bitmap editor such as Windows Paintbrush.  .b(application_name) 
  547. is the title that will appear in the header of the Table of 
  548. Contents topic.  You must provide a topic entry labeled 'icon' 
  549. which will be jumped to when the user clicks on the icon in the 
  550. Table of Contents header.  The \'2estart statement also requires 
  551. a corresponding \'2eend to indicate the end of the table of contents..n
  552. .n
  553. .b(EXAMPLE:).n.n
  554. .[
  555. \li720
  556. \'2estart(main,Contents,DEMO\'2eBMP,A Help Demonstration).n
  557. This is the table of contents topic. It is ended by the 
  558. next line..n
  559. \'2eend.n
  560. .n
  561. \'2eent(icon,Version,Help File ).n
  562. This is a mandatory topic.  We jump to here when the 
  563. DEMO\'2eBMP icon is clicked..n
  564. \'2eend.n
  565. .n
  566. \'2eend_file.n
  567. .]
  568. .n
  569. .b(SEE ALSO:) .j(cmdef,\'2eend_file)
  570. .end
  571. .rem(=================================)
  572. .rem( ent macro topic                 )
  573. .rem(=================================)
  574. .ent(cmdent,\'2eent Macro,The )
  575. .b(SYNTAX:) \'2eent(label,topic,prefix).n
  576. .n
  577. .b(EXPLANATION:) This .p1(macro) marks the start of a .p1(topic) entry.  
  578. .b(label) is used to refer to the topic in the \'2ej and \'2ej1 
  579. macros, .b(topic) is the name that will appear in 
  580. the topic header and in the Search dialog box; and .b(prefix) is a 
  581. string that will appear as a prefix in the header (if the topic is 
  582. "Frogs" and the prefix is "The", the header will be "The Frogs" but 
  583. the entry in the Search dialog box will be "Frogs").  The prefix can 
  584. be an empty string..n
  585. .n
  586. .b(EXAMPLE:).n
  587. .n
  588. .[
  589. \li720
  590. \'2eent(file,File Commands, ).n
  591. \'2ein.n
  592. \'23\'23\'2ej(open,Open File)\'2en.n
  593. \'2eun.n
  594. \'2eend.n
  595. .n
  596. \'2eent(open,Open File, ).n
  597. This command allows you to open an existing file..n
  598. \'2eend.n.n
  599. .]
  600. .b(SEE ALSO:) .j(cmdend,\'2eend), .j(cmdj,\'2ej), .j(cmdj1,\'2ej1).n
  601. .end
  602. .rem(=================================)
  603. .rem( pent macro topic                )
  604. .rem(=================================)
  605. .ent(cmdpent,\'2epent Macro,The )
  606. .b(SYNTAX:) \'2epent(label,topic).n
  607. .n
  608. .b(EXPLANATION:) This .p1(macro) is identical to \'2eent, except 
  609. that it creates .p1(popup) topic boxes instead of .p1(topic) pages.  
  610. This type of popup box is usually used for definitions.  .b(label) 
  611. is used to refer to the topic in the \'2ep and \'2ep1 macros 
  612. described below.  .b(topic) should match the topic label in 
  613. the corresponding \'2ep or \'2ep1 macro..n
  614. .n
  615. .b(EXAMPLE:).n
  616. .n
  617. .[
  618. \li720
  619. \'2eent(size,Font Size,Changing ).n
  620. This item allows you to change the size of the display font.  The 
  621. new size can be anywhere from 6 \'2ep1(points) to 72 points..n
  622. \'2eend.n
  623. .n
  624. \'2epent(points,Points).n
  625. A sizing standard for text.  There are 72 points to the inch.  
  626. Therefore, 6 points is 6/72" = 1/12"..n
  627. \'2eend.n.n
  628. .]
  629. .b(SEE ALSO:) .j(cmdend,\'2eend), .j(cmdp,\'2ep), .j(cmdp1,\'2ep1).n
  630. .end
  631. .rem(=================================)
  632. .rem( end macro topic                 )
  633. .rem(=================================)
  634. .ent(cmdend,\'2eend Macro,The )
  635. .b(SYNTAX:) \'2eend.n
  636. .n
  637. .b(EXPLANATION:) This .p1(macro) marks the end of a .p1(topic) entry 
  638. that was started with \'2eent or \'2epent..n
  639. .n
  640. .b(EXAMPLE:) See the examples for \'2estart, \'2eent and \'2epent..n
  641. .n
  642. .b(SEE ALSO:) .j(cmdstr,\'2estart), .j(cmdent,\'2eent), .j(cmdpent,\'2epent).n
  643. .end
  644. .rem(=================================)
  645. .rem( j macro topic                   )
  646. .rem(=================================)
  647. .ent(cmdj,\'2ej Macro,The )
  648. .b(SYNTAX:) \'2ej(label,string).n
  649. .n
  650. .b(EXPLANATION:) This .p1(macro) creates an underlined .b(string) and 
  651. uses the string as a jump area.  If the user clicks on a jump area, 
  652. the .p1(topic) represented by .b(label) is shown on the screen..n
  653. .n
  654. .b(EXAMPLE:).n
  655. .n
  656. .[
  657. \li720
  658. \'2eent(layout,Page Layout,The ).n
  659. How to Lay Out.n
  660. \'2es.n
  661. \'2ej(pageno,Page Numbers)\'2en.n
  662. \'2ej1(Headers)\'2en.n
  663. \'2ej1(Footers)\'2en.n
  664. \'2eend.n
  665. .n
  666. \'2eent(pageno,Page Numbers, Laying Out ).n
  667. Text for page number layout goes here..n
  668. \'2eend.n
  669. .n
  670. \'2eent(Headers,Headers,Laying Out ).n
  671. Text for page header layout goes here..n
  672. \'2eend.n
  673. .n
  674. \'2eent(Footers,Footers,Laying Out ).n
  675. Text for page footer layout goes here..n
  676. \'2eend.n.n
  677. .]
  678. .b(SEE ALSO:) .j(cmdent,\'2eent), .j(cmdj1,\'2ej1), .j(cmdbj,\'2ebj).n
  679. .end
  680. .rem(=================================)
  681. .rem( j1 macro topic                  )
  682. .rem(=================================)
  683. .ent(cmdj1,\'2ej1 Macro,The )
  684. .b(SYNTAX:) \'2ej1(label).n
  685. .n
  686. .b(EXPLANATION:) This .p1(macro) is identical to a \'2ej with its 
  687. .b(label) and .b(string) being identical.  This macro is used for 
  688. brevity..n
  689. .n
  690. .b(EXAMPLE:) See the example for the \'2ej command..n
  691. .n
  692. .b(SEE ALSO:) .j(cmdent,\'2eent), .j(cmdj,\'2ej).n
  693. .end
  694. .rem(=================================)
  695. .rem( p macro topic                   )
  696. .rem(=================================)
  697. .ent(cmdp,\'2ep Macro,The )
  698. .b(SYNTAX:) \'2ep(label,string).n
  699. .n
  700. .b(EXPLANATION:) This .p1(macro) underlines .b(string) with a dotted 
  701. line and uses it as a jump area.  If the user clicks on the jump area, 
  702. the topic represented by .b(label) is shown in a .p1(popup) window.  
  703. This is used to show definitions..n
  704. .n
  705. .b(EXAMPLE:).n
  706. .n
  707. .[
  708. \li720
  709. \'2eent(cmds,Keyboard Commands,New ).n
  710. The keyboard that supports Chicago has three extra keys; the 
  711. \'2ep1(LWIN) key, the \'2ep1(RWIN) key and the \'2ep(application,APP) key..n
  712. \'2eend.n
  713. .n
  714. \'2epent(application,APP).n
  715. When pressed, brings up the context menu at the current select 
  716. position..n
  717. \'2eend.n
  718. .n
  719. \'2epent(LWIN,LWIN).n
  720. Sets the focus to the Chicago User Interface.  Same 
  721. functionality as the RWIN key, but uses a different 
  722. scan code..n
  723. \'2eend.n
  724. .n
  725. \'2epent(RWIN,RWIN).n
  726. Sets the focus to the Chicago User Interface.  Same 
  727. functionality as the LWIN key, but uses a different 
  728. scan code..n
  729. \'2eend.n.n
  730. .]
  731. .b(SEE ALSO:) .j(cmdpent,\'2epent), .j(cmdp1,\'2ep1).n
  732. .end
  733. .rem(=================================)
  734. .rem( p1 macro topic                  )
  735. .rem(=================================)
  736. .ent(cmdp1,\'2ep1 Macro,The )
  737. .b(SYNTAX:) \'2ep1(label).n
  738. .n
  739. .b(EXPLANATION:)  This .p1(macro) is identical to \'2ep with its 
  740. .b(label) and .b(string) being identical.  This macro can be used 
  741. for brevity..n
  742. .n
  743. .b(EXAMPLE:) See the example for the \'2ep command..n
  744. .n
  745. .b(SEE ALSO:) .j(cmdpent,\'2epent), .j(cmdp,\'2ep).n
  746. .end
  747. .rem(=================================)
  748. .rem( bj macro topic                  )
  749. .rem(=================================)
  750. .ent(cmdbj,\'2ebj Macro,The )
  751. .b(SYNTAX:) \'2ebj(label,bitmap_name).n
  752. .n
  753. .b(EXPLANATION:)  This .p1(macro) is creates a graphical jump area 
  754. using .b(bitmap_name) as the graphic.  If the user clicks on the 
  755. jump area, the topic represented by .b(label) is shown on the screen..n
  756. .n
  757. .b(EXAMPLE:).n
  758. .n
  759. .[
  760. \li720
  761. \'2eent(filecmds,File Commands, ).n
  762. \'2ebj(new,new\'2ebmp) New File.n
  763. \'2ebj(open,open\'2ebmp) Open File.n
  764. \'2ebj(close,close\'2ebmp) Close File.n
  765. \'2eend.n
  766. .n
  767. \'2eent(new,New File, ).n
  768. Text for new file command goes here..n
  769. \'2eend.n
  770. .n
  771. \'2eent(open,Open File, ).n
  772. Text for open file command goes here..n
  773. \'2eend.n
  774. .n
  775. \'2eent(close,Close File, ).n
  776. Text for close file command goes here..n
  777. \'2eend.n
  778. .n
  779. .]
  780. .b(SEE ALSO:) .j(cmdent,\'2eent), .j(cmdj,\'2ej).n
  781. .end
  782. .rem(=================================)
  783. .rem( top macro topic                 )
  784. .rem(=================================)
  785. .ent(cmdtop,\'2etop Macro,The )
  786. .b(SYNTAX:) \'2etop(string).n
  787. .n
  788. .b(EXPLANATION:) This .p1(macro) is used inside of \'2eent and \'2epent 
  789. entries to add .b(string) as another associated topic name to the 
  790. Search dialog box..n
  791. .n
  792. .b(EXAMPLE:).n
  793. .n
  794. .[
  795. \li720
  796. \'2epent(mouse,Pointing Devices).n
  797. \'2etop(Trackball).n
  798. \'2etop(Graphics Tablet).n
  799. \'2etop(Mouse).n
  800. \'2etop(Pointing Stick).n
  801. \'2etop(Joy Stick).n
  802. A device that moves the graphical cursor around the 
  803. screen and that allows you to select objects..n
  804. \'2eend.n.n
  805. .]
  806. .b(SEE ALSO:) .j(cmdent,\'2eent), .j(cmdpent,\'2epent).n
  807. .end
  808. .rem(=================================)
  809. .rem( bmp macro topic                 )
  810. .rem(=================================)
  811. .ent(cmdbmp,\'2ebmp Macro,The )
  812. .b(SYNTAX:) \'2ebmp(pathname).n
  813. .n
  814. .b(EXPLANATION:)  This .p1(macro) inserts a named \'2eBMP bitmap 
  815. file on the current line.  The bitmap is positioned as though it 
  816. were just another character..n
  817. .n
  818. .b(EXAMPLE:).n
  819. .n
  820. .[
  821. \li720
  822. \'2eent(open,Open Macro File, ).n
  823. Use the \'2ebmp(openrtf\'2ebmp) Open Macro File button to open the file..n
  824. \'2eend.n.n
  825. .]
  826. .b(SEE ALSO:) .j(cmdbmpl,\'2ebmpl), .j(cmdbmpr,\'2ebmpr).n
  827. .end
  828. .rem(=================================)
  829. .rem( bmpl macro topic                )
  830. .rem(=================================)
  831. .ent(cmdbmpl,\'2ebmpl Macro,The )
  832. .b(SYNTAX:) \'2ebmpl(pathname).n
  833. .n
  834. .b(EXPLANATION:) This .p1(macro) inserts a named \'2eBMP bitmap 
  835. file at the far left side of the current line.  Any text following 
  836. the \'2ebmpl entry is wrapped around the bitmap..n
  837. .n
  838. .b(EXAMPLE:).n
  839. .n
  840. .[
  841. \li720
  842. \'2eent(close,Close Macro File, ).n
  843. \'2ebmpl(closertf\'2ebmp)Close the macro file and all associated 
  844. files.  Disable any menu items relating to open files..n
  845. \'2eend.n.n
  846. .]
  847. .b(SEE ALSO:) .j(cmdbmp,\'2ebmp), .j(cmdbmpr,\'2ebmpr).n
  848. .end
  849. .rem(=================================)
  850. .rem( bmpr macro topic                )
  851. .rem(=================================)
  852. .ent(cmdbmpr,\'2ebmpr Macro,The )
  853. .b(SYNTAX:) \'2ebmpr(pathname).n
  854. .n
  855. .b(EXPLANATION:) This .p1(macro) inserts a named \'2eBMP bitmap 
  856. file at the far right side of the current line.  Any text following 
  857. the \'2ebmpr entry is wrapped around the bitmap..n
  858. .n
  859. .b(EXAMPLE:).n
  860. .n
  861. .[
  862. \li720
  863. \'2eent(keydisp,Key Information,Display ).n
  864. \'2ebmpr(keydisp\'2ebmp)The key display area shows 
  865. the scan codes that will be sent for this particular 
  866. key - unshifted, shifted, control and alternate..n
  867. \'2eend.n.n
  868. .]
  869. .b(SEE ALSO:) .j(cmdbmp,\'2ebmp), .j(cmdbmpl,\'2ebmpl).n
  870. .end
  871. .rem(=================================)
  872. .rem( box macro topic                 )
  873. .rem(=================================)
  874. .ent(cmdbox,\'2ebox Macro,The )
  875. .b(SYNTAX:) \'2ebox.n
  876. .n
  877. .b(EXPLANATION:) This .p1(macro) draws a box around the current 
  878. paragraph.  It applies to all subsequent paragraphs up to the 
  879. \'2ebend command.  Box drawing should only be done in normal 
  880. text areas in \'2eent or \'2epent areas..n
  881. .n
  882. .b(EXAMPLE:).n
  883. .n
  884. .[
  885. \li720
  886. \'2eent(about,About HelpGen, ).n
  887. Display a box containing version information and 
  888. copyright information..n
  889. \'2en.n
  890. \'2ebox.n
  891. \'2eb(NOTE:) The integer portion of the version number 
  892. indicates a major revision and the decimal portion 
  893. indicates a minor revision..n
  894. \'2ebend.n
  895. \'2es.n
  896. All dialog boxes use icon-style pushbuttons and 
  897. graphical elements..n
  898. \'2eend.n.n
  899. .]
  900. .b(SEE ALSO:) .j(cmdbend,\'2ebend).n
  901. .end
  902. .rem(=================================)
  903. .rem( bend macro topic                )
  904. .rem(=================================)
  905. .ent(cmdbend,\'2ebend Macro,The )
  906. .b(SYNTAX:) \'2ebend.n
  907. .n
  908. .b(EXPLANATION:) This .p1(macro) completes the box drawing that was 
  909. started with a \'2ebox command..n
  910. .n
  911. .b(EXAMPLE:) See the \'2ebox example..n
  912. .n
  913. .b(SEE ALSO:) .j(cmdbox,\'2ebox).n
  914. .end
  915. .rem(=================================)
  916. .rem( rem macro topic                 )
  917. .rem(=================================)
  918. .ent(cmdrem,\'2erem Macro,The )
  919. .b(SYNTAX:) \'2erem(text).n
  920. .n
  921. .b(EXPLANATION:) This .p1(macro) allows comments to be inserted 
  922. into the macro file..n
  923. .n
  924. .b(EXAMPLE:).n
  925. .n
  926. .[
  927. \li720
  928. \'2erem(-----------------------------------------------).n
  929. \'2erem( Macro file for RENAULT.EXE help).n
  930. \'2erem(-----------------------------------------------).n
  931. \'2estart(main,Contents,renault\'2ebmp,Renault Help).n
  932. \'2erem(Insert table of Contents here).n
  933. \'2eend.n
  934. \'2eend_file.n.n
  935. .]
  936. .b(SEE ALSO:).n
  937. .end
  938. .rem(=================================)
  939. .rem( in macro topic                  )
  940. .rem(=================================)
  941. .ent(cmdin,\'2ein Macro,The )
  942. .b(SYNTAX:) \'2ein.n
  943. .n
  944. .b(EXPLANATION:) This .p1(macro) starts an indented text section, 
  945. which usually contains a list of items.  The indented section is 
  946. a hanging indent, which means that the first line is indented less 
  947. than the following lines.  Each beginning line will look good if 
  948. it begins with either a number or a bullet..n
  949. .n
  950. .b(EXAMPLE:).n
  951. .n
  952. .[
  953. \li720
  954. \'2eent(sellcars,Sell Cars,How to ).n
  955. \'2ein.n
  956. \'23n(1)Find a customer.\'2en.n
  957. \'23n(2)Convince them this is the car of their dreams, no matter 
  958. how bad it is.\'2en.n
  959. \'23n(3)Close the sale.  Get their John Hancock on the bottom line.\'2en.n
  960. \'2eun.n
  961. \'2eend.n.n
  962. .]
  963. .b(SEE ALSO:) .j(cmdun,\'2eun), .j(cmdpp,\'23\'23), .j(cmdpb,\'23b), .j(cmdpn,\'23n).n
  964. .end
  965. .rem(=================================)
  966. .rem( un macro topic                  )
  967. .rem(=================================)
  968. .ent(cmdun,\'2eun Macro,The )
  969. .b(SYNTAX:) \'2eun.n
  970. .n
  971. .b(EXPLANATION:) This .p1(macro) ends ('unindents') an indented text 
  972. section..n
  973. .n
  974. .b(EXAMPLE:) See the example for the \'2ein command..n
  975. .n
  976. .b(SEE ALSO:) .j(cmdin,\'2ein).n
  977. .end
  978. .rem(=================================)
  979. .rem( pound pound macro topic         )
  980. .rem(=================================)
  981. .ent(cmdpp,\'23\'23 Macro,The )
  982. .b(SYNTAX:) \'23\'23.n
  983. .n
  984. .b(EXPLANATION:) This .p1(macro) represents a bullet for a list 
  985. item.  It should be followed immediately by text..n
  986. .n
  987. .b(EXAMPLE:).n
  988. .n
  989. .[
  990. \li720
  991. \'2eent(advantages,Quilt Advantages, ).n
  992. \'2es.n
  993. \'23\'23Uses no electricity.\'2en.n
  994. \'23\'23All natural construction.\'2en.n
  995. \'23\'23Reduces number of blankets needed.\'2en.n
  996. \'2eend.n.n
  997. .]
  998. .b(SEE ALSO:) .j(cmdun,\'2eun), .j(cmdpb,\'23b), .j(cmdpn,\'23n).n
  999. .end
  1000. .rem(=================================)
  1001. .rem( pound b macro topic             )
  1002. .rem(=================================)
  1003. .ent(cmdpb,\'23b Macro,The )
  1004. .b(SYNTAX:) \'23b(text).n
  1005. .n
  1006. .b(EXPLANATION:) This .p1(macro) represents a list item that starts 
  1007. with a bullet and with the given .b(text) in boldface.  It should 
  1008. be followed immediately by text..n
  1009. .n
  1010. .b(EXAMPLE:).n
  1011. .n
  1012. .[
  1013. \li720
  1014. \'2eent(glossary,Glossary, Keyboard ).n
  1015. \'2es.n
  1016. \'23b(Autorepeat)If held down a key will begin to send 
  1017. its code repeatedly.\'2en.n
  1018. \'23b(Mode key)Modifier keys, used in conjunction with normal 
  1019. keys.  Includes shift, control and alternate.\'2en.n
  1020. \'23b(Scan code)A byte value or values sent to the computer.\'2en.n
  1021. \'2eend.n.n
  1022. .]
  1023. .b(SEE ALSO:) .j(cmdun,\'2eun), .j(cmdpp,\'23\'23), .j(cmdpn,\'23n).n
  1024. .end
  1025. .rem(=================================)
  1026. .rem( pound n macro topic             )
  1027. .rem(=================================)
  1028. .ent(cmdpn,\'23n Macro,The )
  1029. .b(SYNTAX:) \'23n(1).n
  1030. .n
  1031. .b(EXPLANATION:) This .p1(macro) represents a numbered list item.  
  1032. It should be followed immediately by text..n
  1033. .n
  1034. .b(EXAMPLE:) See the example for the \'2ein command..n
  1035. .n
  1036. .b(SEE ALSO:) .j(cmdun,\'2eun), .j(cmdpp,\'23\'23), .j(cmdpb,\'23b).n
  1037. .end
  1038. .rem(=================================)
  1039. .rem( b macro topic                   )
  1040. .rem(=================================)
  1041. .ent(cmdb,\'2eb Macro,The )
  1042. .b(SYNTAX:) \'2eb(string).n
  1043. .n
  1044. .b(EXPLANATION:) This .p1(macro) presents the given .b(string) in 
  1045. bold face type..n
  1046. .n
  1047. .b(EXAMPLE:).n
  1048. .n
  1049. .[
  1050. \li720
  1051. \'2eent(startup,Engine Startup, ).n
  1052. Always ensure there is no gas fume build-up in 
  1053. the bilge. \'2eb(THIS IS VERY IMPORTANT.)\'2en.n
  1054. Switch on the ignition and press the start button.\'2en.n
  1055. \'2eend.n.n
  1056. .]
  1057. .b(SEE ALSO:) .j(cmdi,\'2ei).n
  1058. .end
  1059. .rem(=================================)
  1060. .rem( i macro topic                   )
  1061. .rem(=================================)
  1062. .ent(cmdi,\'2ei Macro,The )
  1063. .b(SYNTAX:) \'2ei(string).n
  1064. .n
  1065. .b(EXPLANATION:) This .p1(macro) presents the given .b(string) in 
  1066. italic type..n
  1067. .n
  1068. .b(EXAMPLE:).n
  1069. .n
  1070. .[
  1071. \li720
  1072. \'2eent(chars,Characters,Game ).n
  1073. Your opponents in the game consist of \'2ei(trolls), 
  1074. rabid \'2ei(dogs) and defenseless \'2ei(kittens)..n
  1075. \'2eend.n.n
  1076. .]
  1077. .b(SEE ALSO:) .j(cmdb,\'2eb).n
  1078. .end
  1079. .rem(=================================)
  1080. .rem( [ macro topic                   )
  1081. .rem(=================================)
  1082. .ent(cmdob,\'2e[ Macro,The )
  1083. .b(SYNTAX:) \'2e[.n
  1084. .n
  1085. .b(EXPLANATION:) This .p1(macro) marks the beginning of a region of text 
  1086. that will appear in a bold, fixed-width font.  This is suitable for 
  1087. showing program examples or tables.  NOTE: Since 
  1088. .p1(RTF) files use the open and close curly braces as part of their 
  1089. syntax, if you want to display them in your help file, you must 
  1090. 'escape' them by putting a backslash in front of them.  This is shown 
  1091. in the example below..n
  1092. .n
  1093. .b(EXAMPLE:).n
  1094. .n
  1095. .[
  1096. \li720
  1097. \'2eent(progctl,Control,Program ).n
  1098. The program is controlled with a message router:.n
  1099. \'2es.n
  1100. \'2ein.n
  1101. \'2e[.n
  1102. switch(wParam)\'2en.n
  1103. \\\{\'2en.n
  1104. \\tab case ID_OPEN: . . . \'2en.n
  1105. \\tab \\tab break;\'2en.n
  1106. \\tab case ID_CLOSE: . . . \'2en.n
  1107. \\tab \\tab break;\'2en.n
  1108. \\\}\'2en.n
  1109. \'2e].n
  1110. \'2eun.n
  1111. \'2eend.n.n
  1112. .]
  1113. .b(SEE ALSO:) .j(cmdcb,\'2e]).n
  1114. .end
  1115. .rem(=================================)
  1116. .rem( ] macro topic                   )
  1117. .rem(=================================)
  1118. .ent(cmdcb,\'2e] Macro,The )
  1119. .b(SYNTAX:) \'2e].n
  1120. .n
  1121. .b(EXPLANATION:) This .p1(macro) marks the end of a region that was started with \'2e[.  There should be a \'2e] for 
  1122. every \'2e[..n
  1123. .n
  1124. .b(EXAMPLE:) See the example for the \'2e[ command..n
  1125. .n
  1126. .b(SEE ALSO:) .j(cmdob,\'2e[).n
  1127. .end
  1128. .rem(=================================)
  1129. .rem( n macro topic                   )
  1130. .rem(=================================)
  1131. .ent(cmdn,\'2en Macro,The )
  1132. .b(SYNTAX:) \'2en.n
  1133. .n
  1134. .b(EXPLANATION:) This .p1(macro) is used at the end of a line, or on a line of its own, to indicate the actual end 
  1135. of the line.  When \'2en is not used, separate lines are simply run together and used to fill whatever WinHelp 
  1136. window width the user has chosen..n
  1137. .n
  1138. .b(EXAMPLE:).n
  1139. .n
  1140. .[
  1141. \li720
  1142. \'2eent(drjnk,Health,To Your ).n
  1143. This sentence will adjust itself to the.n
  1144. width of the help window, since there is no.n
  1145. \\'2en at the end of each line.\'2en\'2en.n.n
  1146. This sentence will not adjust itself,\'2en.n
  1147. since there is a \\'2en at the end of\'2en.n
  1148. each line.\'2en.n
  1149. \'2eend.n.n
  1150. .]
  1151. .b(SEE ALSO:) .j(cmds,\'2es).n
  1152. .end
  1153. .rem(=================================)
  1154. .rem( s macro topic                   )
  1155. .rem(=================================)
  1156. .ent(cmds,\'2es Macro,The )
  1157. .b(SYNTAX:) \'2es.n
  1158. .n
  1159. .b(EXPLANATION:) This .p1(macro) is used between lines to skip a space.  If \'2es is used, then don't use \'2en.
  1160. .n
  1161. .b(EXAMPLE:).n
  1162. .n
  1163. .[
  1164. \li720
  1165. \'2eent(morjnk,Health,To My ).n
  1166. This paragraph will be printed with the appropriate.n
  1167. word wrapping and line wrapping. All parts of the.n
  1168. paragraph will remain connected..n
  1169. \'2es.n
  1170. The \'2es above will separate this paragraph from.n
  1171. the preceeding paragraph.  The separation is slightly.n
  1172. more than a single line spacing..n
  1173. \'2eend.n.n
  1174. .]
  1175. .b(SEE ALSO:) .j(cmdn,\'2en).n
  1176. .end
  1177. .rem(=================================)
  1178. .rem( end_file macro topic            )
  1179. .rem(=================================)
  1180. .ent(cmdef,\'2eend_file Macro,The )
  1181. .b(SYNTAX:) \'2eend_file.n
  1182. .n
  1183. .b(EXPLANATION:) This .p1(macro) marks the end of the macro file..n
  1184. .n
  1185. .b(EXAMPLE:) See the example for the \'2estart command..n
  1186. .n
  1187. .b(SEE ALSO:) .j(cmdstr,\'2estart).n
  1188. .end
  1189. .rem(=================================)
  1190. .rem( brdrdb command topic            )
  1191. .rem(=================================)
  1192. .ent(cmdbrdrdb,\\brdrdb Command,The )
  1193. .b(EXPLANATION:) This command changes the border line style to a double line.  It is used as a modifier to 
  1194. the \'2ebox command..n
  1195. .n
  1196. .b(EXAMPLE:).n
  1197. .n
  1198. .[
  1199. \li720
  1200. \'2ebox.n
  1201. \\brdrdb.n
  1202. This text will be displayed in a box with a double line border..n
  1203. \'2ebend.n
  1204. .]
  1205. .end
  1206. .rem(=================================)
  1207. .rem( brdrs command topic             )
  1208. .rem(=================================)
  1209. .ent(cmdbrdrs,\\brdrs Command,The )
  1210. .b(EXPLANATION:) This command  changes the border line style to a single line (this is the default).  It is 
  1211. used as a modifier to the \'2ebox command..n
  1212. .n
  1213. .b(EXAMPLE:).n
  1214. .n
  1215. .[
  1216. \li720
  1217. \'2ebox.n
  1218. \\brdrth.n
  1219. This text will be displayed in a box with a thick border..n
  1220. \\brdrs.n
  1221. And this text will be displayed in a another box with a single 
  1222. line border..n
  1223. \'2ebend.n
  1224. .]
  1225. .end
  1226. .rem(=================================)
  1227. .rem( brdrsh command topic            )
  1228. .rem(=================================)
  1229. .ent(cmdbrdrsh,\\brdrsh Command,The )
  1230. .b(EXPLANATION:) This command changes the border line style to shaded style.  It is used as a modifier to 
  1231. the \'2ebox command..n
  1232. .n
  1233. .b(EXAMPLE:).n
  1234. .n
  1235. .[
  1236. \li720
  1237. \'2ebox.n
  1238. \\brdrsh.n
  1239. This text will be displayed in a box with a shaded border..n
  1240. \'2ebend.n
  1241. .]
  1242. .end
  1243. .rem(=================================)
  1244. .rem( brdrth command topic            )
  1245. .rem(=================================)
  1246. .ent(cmdbrdrth,\\brdrth Command,The )
  1247. .b(EXPLANATION:) This command changes the border line style to a thick line.  It is used as a modifier to 
  1248. the \'2ebox command..n
  1249. .n
  1250. .b(EXAMPLE:) See the example for the \\brdrs command..n
  1251. .n
  1252. .end
  1253. .rem(=================================)
  1254. .rem( li command topic                )
  1255. .rem(=================================)
  1256. .ent(cmdli,\\li Command,The )
  1257. .b(EXPLANATION:) This command changes the left margin indentation to the value that 
  1258. immediately follows the command.  The value is expressed in .p1(twips).  
  1259. To reset the margin to its default, use \\li180..n
  1260. .n
  1261. .b(EXAMPLE:).n
  1262. .n
  1263. \'2e[.n
  1264. \\li720.n
  1265. \\ri720.n
  1266. This sentence will be indented on the left and right margins by 
  1267. 720/1440 = 1/2"..n
  1268. \'2e].n
  1269. \\li180.n
  1270. \\ri180.n
  1271. .end
  1272. .rem(=================================)
  1273. .rem( ri command topic                )
  1274. .rem(=================================)
  1275. .ent(cmdri,\\ri Command,The )
  1276. .b(EXPLANATION:) This command changes the right margin indentation to the value that 
  1277. immediately follows the command.  The value is expressed in .p1(twips).  
  1278. To reset the margin to its default, use \\ri180..n
  1279. .n
  1280. .b(EXAMPLE:) See the example for the \\li command..n
  1281. .end
  1282. .rem(=================================)
  1283. .rem( ql command topic                )
  1284. .rem(=================================)
  1285. .ent(cmdql,\\ql Command,The )
  1286. .b(EXPLANATION:) This command changes the paragraph style to left justified.  This is the default 
  1287. paragraph style..n
  1288. .n
  1289. .b(EXAMPLE:).n
  1290. .n
  1291. .[
  1292. \li720
  1293. \\qc.n
  1294. This paragraph will have every line centered in the 
  1295. help window..n
  1296. \'2es.n
  1297. \\ql.n
  1298. Now we are back to the default left justified paragraph..n
  1299. .]
  1300. .end
  1301. .rem(=================================)
  1302. .rem( qr command topic                )
  1303. .rem(=================================)
  1304. .ent(cmdqr,\\qr Command,The )
  1305. .b(EXPLANATION:) This command changes the paragraph style to right justified..n
  1306. .n
  1307. .b(EXAMPLE:).n
  1308. .n
  1309. .[
  1310. \li720
  1311. This paragraph is normally left justified..n
  1312. \'2es.n
  1313. \\qr.n
  1314. And this paragraph is right justified..n
  1315. \'2es.n
  1316. .]
  1317. .end
  1318. .rem(=================================)
  1319. .rem( qj command topic                )
  1320. .rem(=================================)
  1321. .ent(cmdqj,\\qj Command,The )
  1322. .b(EXPLANATION:) This command changes the paragraph style to fully justified..n
  1323. .n
  1324. .b(EXAMPLE:).n
  1325. .n
  1326. .[
  1327. \li720
  1328. \\qj.n
  1329. The quick brown fox normally jumps over the lazy dog's 
  1330. back in a fully justified fashion..n
  1331. \'2es.n
  1332. .]
  1333. .end
  1334. .rem(=================================)
  1335. .rem( qc command topic                )
  1336. .rem(=================================)
  1337. .ent(cmdqc,\\qc Command,The )
  1338. .b(EXPLANATION:) This command changes the paragraph style to centered lines..n
  1339. .n
  1340. .b(EXAMPLE:) See the example for the \\ql command..n
  1341. .n
  1342. .end
  1343. .rem(=================================)
  1344. .rem( tab command topic               )
  1345. .rem(=================================)
  1346. .ent(cmdtab,\\tab Command,The )
  1347. .b(EXPLANATION:) This command places a tab character in the macro and in the generated RTF file..n
  1348. .n
  1349. .b(EXAMPLE:) See the example for the \'2e[ macro language command..n
  1350. .n
  1351. .end
  1352. .rem(=================================)
  1353. .rem( 'hh command topic               )
  1354. .rem(=================================)
  1355. .ent(cmdhh,\\'hh Command,The )
  1356. .b(EXPLANATION:) This command allows you to put extended characters into a help file.  Some commonly 
  1357. used extended characters are.n
  1358. .n
  1359. \tab\\'a9  =>  \'a9.n
  1360. \tab\\'ae  =>  \'ae.n
  1361. \tab\\'bc  =>  \'bc.n
  1362. \tab\\'bd  =>  \'bd.n
  1363. \tab\\'be  =>  \'be.n
  1364. \tab\\'99  =>  \'99  (trademark symbol. This one may not work correctly, depending on the help compiler).n
  1365. .n
  1366. .b(EXAMPLE:).n
  1367. .n
  1368. .[
  1369. \li720
  1370. \\'a9 1994 Rimrock Software.  All rights reserved.\'2en.n
  1371. Distributed on 3\\'bd double density floppy disk..n
  1372. .]
  1373. .end
  1374. .rem(=================================)
  1375. .rem( glossary topic                  )
  1376. .rem(=================================)
  1377. .ent(glossary,Glossary, )
  1378. .in
  1379. ##.p(hlpcmplr,help compiler)
  1380. ##.p1(macro)
  1381. ##.p1(popup)
  1382. ##.p1(project)
  1383. ##.p1(RTF)
  1384. ##.p(rtfcmds,RTF commands)
  1385. ##.p1(template)
  1386. ##.p(titlebar,title bar)
  1387. ##.p1(toolbar)
  1388. ##.p1(topic)
  1389. ##.p1(twips)
  1390. .un
  1391. .end
  1392. .rem(=================================)
  1393. .rem( macro popup                     )
  1394. .rem(=================================)
  1395. .pent(macro,macro, )
  1396. The replacement of a long series of .p1(RTF) commands with a single 
  1397. command word and (optional) series of arguments.
  1398. .end
  1399. .rem(=================================)
  1400. .rem( template popup                  )
  1401. .rem(=================================)
  1402. .pent(template,template, )
  1403. A series of text lines that constitute the minimal macro 
  1404. file that will convert to an RTF file and compile to a 
  1405. help file.
  1406. .end
  1407. .rem(=================================)
  1408. .rem( project popup                   )
  1409. .rem(=================================)
  1410. .pent(project,project, )
  1411. A file with the extension .HPJ, that contains options that 
  1412. specifies how a help file is to be built.  Required by the 
  1413. help compiler.
  1414. .end
  1415. .rem(=================================)
  1416. .rem( RTF popup                       )
  1417. .rem(=================================)
  1418. .pent(RTF,RTF, )
  1419. Rich Text Format, a standard text file formatting standard. An 
  1420. RTF file consists of .p(rtfcmds,RTF commands) and normal text.
  1421. .end
  1422. .rem(=================================)
  1423. .rem( RTF commands popup              )
  1424. .rem(=================================)
  1425. .pent(rtfcmds,RTF commands, )
  1426. Special commands in an .p1(RTF) file that describe how text is to be 
  1427. displayed.  These commands start with a backslash (\\) character.
  1428. .end
  1429. .rem(=================================)
  1430. .rem( help compiler popup             )
  1431. .rem(=================================)
  1432. .pent(hlpcmplr,help compiler, )
  1433. The program that creates a help (.HLP) file from the .RTF file, 
  1434. using the rules detailed in the .HPJ file.
  1435. .end
  1436. .rem(=================================)
  1437. .rem( toolbar popup                   )
  1438. .rem(=================================)
  1439. .pent(toolbar,toolbar, )
  1440. The line of graphical push buttons that are located directly 
  1441. below HelpGen's menu bar.
  1442. .end
  1443. .rem(=================================)
  1444. .rem( title bar popup                 )
  1445. .rem(=================================)
  1446. .pent(titlebar,title bar, )
  1447. The area at the top of the HelpGen program window that contains 
  1448. the program name, file name, system menu button and window size 
  1449. controls.
  1450. .end
  1451. .rem(=================================)
  1452. .rem( topic popup                     )
  1453. .rem(=================================)
  1454. .pent(topic,topic, )
  1455. A block of text in a help file that will be displayed as a single 
  1456. display page.
  1457. .end
  1458. .rem(=================================)
  1459. .rem( popup popup                     )
  1460. .rem(=================================)
  1461. .pent(popup,popup, )
  1462. A small window that appears when you select a topic with a dotted 
  1463. underline.  The window will remain until you click the left mouse 
  1464. button again.
  1465. .end
  1466. .rem(=================================)
  1467. .rem( twips popup                     )
  1468. .rem(=================================)
  1469. .pent(twips,twips, )
  1470. A 20th of a point.  There are 72 points in an inch, so there 
  1471. are 1440 twips in an inch.
  1472. .end
  1473. .rem(=================================)
  1474. .rem( End of HelpGen macro file       )
  1475. .rem(=================================)
  1476. .end_file
  1477.