home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 12 / CD_ASCQ_12_0294.iso / maj / 4405 / hlpdk.inf (.txt) < prev    next >
OS/2 Help File  |  1993-11-03  |  53KB  |  1,816 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. HLPDK System Overview ΓòÉΓòÉΓòÉ
  3.  
  4.  
  5.  ΓòöΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòù
  6.  Γòæ                                                                          Γòæ
  7.  Γòæ                                 ISoft D&M                                Γòæ
  8.  Γòæ                                 POB. 5517                                Γòæ
  9.  Γòæ                           Coralville IA 52241                            Γòæ
  10.  Γòæ                                   U.S.A                                  Γòæ
  11.  Γòæ                                                                          Γòæ
  12.  ΓòÜΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓòÉΓò¥
  13.  
  14. The Help Engine Development Kit is a system that allows you to create 
  15. hyper-text database help systems with topics and hot links, using a simple text 
  16. editor and the help compiler. 
  17.  
  18. The help databases can be distributed (free of charge) with the HELPENG or HE 
  19. help engine display programs. 
  20.  
  21. The help database format is release to the public domain, if you own the 
  22. Paradox Engine you can use the help databases with your own programs. 
  23.  
  24. Borland Pascal Users can purchase the Help Engine Source Code even for 
  25. Applications that do not use the paradox engine, using the Native Mem format. 
  26.  
  27. The helpC compiler that is part of this development kit includes the ability to 
  28. create Windows Help source files from the same source the dos help sources are 
  29. created!. Write your help once, and create help databases for Dos, Windows, 
  30. OS/2 and DESQview/X ! 
  31.  
  32. Supported Formats : Native(PX), Native (Mem), Win30, Win31, QuickHelp, 
  33. Microsoft Multimedia Viewer, THELP, TVHC, POPHELP, DESQview/X, OS/2, Text, Word 
  34. Processors (RTF) 
  35.  
  36. From the same source you created your hypertext database, you can create a text 
  37. document with automatic table of contents and index sections! 
  38.  
  39. Using the RTF target you can prepare your professional documentation by 
  40. generating word processors documents, all from the same source! 
  41.  
  42. Features : 
  43.  
  44. Topics, Popups, Links, Keywords, Text Formats, Navigational and Structural 
  45. facilities, Target Code insertion, Multiple module files, Automatic 
  46. Pascal/C/C++ reference generation, Exception handling, Multiple file target 
  47. databases, Graphics, Sound, Groups, Application Launch, Automatic exports 
  48. creation, User defined link templates and more. 
  49.  
  50. Contact ISoft D&M if you want to purchase the WINTEXT UI library for Turbo 
  51. Pascal programs, and use the help engine window in your pascal programs. 
  52.  
  53. Related Topics : 
  54. Registration 
  55. Contact 
  56. File List 
  57. Credits 
  58. Help Engine 
  59. Help Compiler 
  60. Quick Start 
  61. Related Products 
  62.  
  63.  
  64. ΓòÉΓòÉΓòÉ 2. Registration ΓòÉΓòÉΓòÉ
  65.  
  66.  
  67.  
  68. ******************************************************************************* 
  69. *         Why Register and registration instructions          * 
  70. ******************************************************************************* 
  71.  
  72. The Help Engine Development Kit (HLPDK) is a shareware product, if you find 
  73. this product valuable, please register it. This section describes the reasons 
  74. you should register. 
  75.  
  76. By registering you will receive a complete discussion of the help engine 
  77. features, and many examples of usage. You will receive a diskette with the 
  78. latest HLPDK version, and DPMI (DOS protected mode) versions of the help 
  79. compiler and engines!. (The memory version of the help engine can display huge 
  80. databases only in the protected mode version). 
  81.  
  82. Your registration will help us to create the next versions of HLPDK, that will 
  83. include more options, and features, some of them might even be your enhancement 
  84. requests!. 
  85.  
  86. A point to consider - If you want to create Windows Help source files, you will 
  87. have to purchase a word processor that can output RTF files, the WORD for 
  88. Windows 2.0 package, for example, is listed at around $500!. 
  89.  
  90. To order your registered copy of HLPDK please do one of the following: 
  91.  
  92.  1.   Order from ISoft D&M: 
  93.  You can order directly from ISoft D&M. Please refer to the supplied 
  94.  HLPDK.REG file. Edit it, print it and mail it (with a check) to: 
  95.     ISoft D&M, 
  96.     POBox 5517 
  97.     Coralville Iowa 52241, U.S.A 
  98.  
  99.  2.   Order from PsL: 
  100.  You can order from Public (software) Library with your MC, Visa, AmEx 
  101.  or Discover card by calling 800-242-4PsL (from overseas: 713-524-6394) or 
  102.  by FAX to 713-524-6398 or by CompuServe to 71355,470. 
  103.  These numbers are for ordering only. ISoft D&M can NOT be reached at those 
  104.  numbers. Please contact ISoft D&M directly for any other type of problem 
  105.  (technical or other), information or request. 
  106.  
  107. Related Topics : 
  108. Contact 
  109. Overview 
  110.  
  111.  
  112. ΓòÉΓòÉΓòÉ 3. CONTACT ΓòÉΓòÉΓòÉ
  113.  
  114.  
  115.  
  116.  Please contact : 
  117.  
  118.  ISoft D&M, 
  119.  P.O.B 5517 
  120.  Coralville IA 52241, 
  121.  U.S.A 
  122.  
  123. ISoft D&M e-mail address : CompuServe - 76350,333 
  124.  
  125.  To contact the author directly : 
  126.  
  127.  Contact :   Loewy Ron, 
  128.         9 Haneveem st. 
  129.         Herzeliya, 46465 
  130.         ISRAEL. 
  131.  
  132. e-mail address : CompuServe - 100274,162 
  133.  
  134. Related Topics : 
  135. Regsiteration 
  136. Overview 
  137.  
  138.  
  139. ΓòÉΓòÉΓòÉ 4. HPLDK Distribution File List ΓòÉΓòÉΓòÉ
  140.  
  141.  
  142.  
  143.  This package contains the following files in the following archives : 
  144.  
  145. Archive A : 
  146. ----------- 
  147.  READMEA.HDK   - File List for Archive A. 
  148.  HELPC.EXE    - Help Compiler. 
  149.  HLPDK.DOC    - This file. 
  150.  HELPC.DOC    - Help Compiler documentation 
  151.  HLPDK.REG    - Registration file. 
  152.  HLPDK.HDF    - Help Development Kit hypertext help database source. 
  153.  HLPDK.HLP    - WinHelp Version of the hlpdk hypertext source. 
  154.  HLPDK.INF    - OS/2 IPF Version of the HLPDK hypertext source. 
  155.  PROGRAMS.TXT  - ISoft D&M shareware products description. 
  156.  HELPDEMO.HDF  - Demo Help Project. 
  157.  2NDDEMO.HDF   - Demo Help Project - file 2. 
  158.  RONP.BMP    - Bitmap used in HLPDK.HDF 
  159.  
  160. Archive B : 
  161. ----------- 
  162.  READMEB.HDK   - File List for Archive B. 
  163.  HELPENG.EXE   - Help Engine (Native Paradox). 
  164.  HE.EXE     - Help Engine (Native Memory). 
  165.  HELPDEMO.HLP  - Demo Help Project file for Windows WINHELP. 
  166.  HLPDK.HDT    - Help Development Kit help database file. (Native Paradox) 
  167.  HLPDK.SET    - Help Development Kit help database file. 
  168.  HLPDKTOP.DB   - Help Development Kit help database file. 
  169.  HLPDKTOP.PX   - Help Development Kit help database file. 
  170.  HLPDKLNK.DB   - Help Development Kit help database file. 
  171.  HLPDKLNK.PX   - Help Development Kit help database file. 
  172.  HLPDKKEY.DB   - Help Development Kit help database file. 
  173.  HLPDKKEY.PX   - Help Development Kit help database file. 
  174.  MULTI1.HDF   - Multiple file target database demo - 1. 
  175.  MULTI2.HDF   - Multiple file target database demo - 2. 
  176.  MAKMULTI.BAT  - Demo multiple file target database batch file. 
  177.  VWRLIB.HDF   - MMViewer Extention Library for 256 color bitmaps. 
  178.  
  179. Related Topics : 
  180. Overview 
  181. Quick Start 
  182.  
  183.  
  184. ΓòÉΓòÉΓòÉ 5. CREDITS ΓòÉΓòÉΓòÉ
  185.  
  186.  
  187. HLPDK, HELPC, The Help Engines, NewsDB, IL2HDK, NG2HDK, RTF2HDK, RC2HDK and 
  188. other products, were written by Ron Loewy. These products are distributed 
  189. worldwide by ISoft D&M. 
  190.  
  191. HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0, 
  192. Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. (Trademarks of Borland 
  193. International). 
  194.  
  195. Windows, Microsoft, HC and Quick Help are trademarks or copyrights of Microsoft 
  196. Corp. 
  197.  
  198. The HELPENG program was written using the WINTEXT UI library, (c) 1991,93 Loewy 
  199. Ron. 
  200.  
  201. THELP, HL and TVHC are Trademarks or copyrights Borland International. 
  202.  
  203. POPHELP is a copyright of TurboPower Software. 
  204.  
  205. TVHC support, and other ideas were suggested by MunLeong Chan. 
  206.  
  207. Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen CASE 
  208. code generators. 
  209.  
  210. Parts of the Help Compiler were generated using Ron Loewy's dbGen database code 
  211. generator. 
  212.  
  213. Yaniv Golan helped me with beta-testing, debugging and suggestions. He is also 
  214. the  author of the HPCHDK and POPHDK packages. 
  215.  
  216. John Murphy notified me of the paragraph formatting difficulties that lead to 
  217. the .PARAGRAPH .END-PARAGRAPH formatting capabilities. 
  218.  
  219. DESQview/X is a trademark of Quarterdeck Office Systems. 
  220.  
  221. MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his excelent 
  222. documentation of DESQview/X help format to generate code to this environment. 
  223.  
  224. The HC31 problem with characters with ordinal values biggen than 127 was solved 
  225. thanks to Mr. Lars Fosdal of Norway. 
  226.  
  227. OS/2 is a registered trademark of International Bussiness Machines. 
  228.  
  229. The Text Cursor restore problem in the help engines was reported by Prof. Timo 
  230. Salmi of the Univ. of VAASA, Finland. 
  231.  
  232. D.J. Murdoch suggested the Cross Reference Report enhancements, and winhelp Go 
  233. To Search list box title problem. 
  234.  
  235. Word for Windows is a trademark of Microsoft corp. 
  236.  
  237. WordPerfect, WordPerfect for Windows are trademarks of WordPerfect corporation. 
  238.  
  239. Lotus, AMI PRO are trademarks of Lotus corp. 
  240.  
  241. Reuben Halevi from ISoft D&M did a lot to make this product real. 
  242.  
  243. Slren Pingel Dalsgaard notified me of the small scroll box bug in helpeng, as 
  244. well as some spelling mistakes in helpC. 
  245.  
  246. Related Topics : 
  247. Overview 
  248.  
  249.  
  250. ΓòÉΓòÉΓòÉ 6. Quick Start ΓòÉΓòÉΓòÉ
  251.  
  252.  
  253.  
  254. From the command line enter HELPC HELPDEMO to compile the demo help database. 
  255.  
  256. After the compilation process is ended, enter HELPENG HELPDEMO to browse the 
  257. demo help database. 
  258.  
  259. If you want to compile for windows : 
  260.  
  261. from the command line enter HELPC HELPDEMO /W31 
  262. and after that HC31 HELPDEMO 
  263. (HC31 is the Microsoft Help Compiler) 
  264.  
  265. from windows, open the HELPDEMO.HLP file from the windows help engine. (Notice 
  266. - if you do not have the HC help compiler from windows, we have included a 
  267. compiled version of HELPDEMO (HELPDEMO.HLP) so you will be able to feel the 
  268. quality of the output that can be generated, and decide if you want to purchase 
  269. the HC31 program (Included with the SDK, BC++, TPW, BP and probably some other 
  270. packages), or download it from one of the sites Microsoft had uploaded it to). 
  271.  
  272. If you use windows 3.0, or want your help file to be compatible with winHelp 
  273. 3.0 use : 
  274.     HELPC /W30 HELPDEMO 
  275.     HC HELPDEMO 
  276.  
  277. To compile for THELP use : 
  278.     HELPC /TH+ HELPDEMO 
  279.     HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL 
  280.  
  281. To compile for QuickHelp : 
  282.     HELPC /QH+ HELPDEMO 
  283.     HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC 
  284.  
  285. To compile for TVHC : 
  286.     HELPC /TV+ HELPDEMO 
  287.     TVHC HELPDEMO.TXT 
  288.  
  289. To compile for POPHELP : 
  290.     HELPC /PH+ HELPDEMO 
  291.     MAKEHELP /Q HELPDEMO 
  292.  
  293. To compile for DESQview/X : 
  294.     HELPC /XD+ HELPDEMO 
  295.     MDVXHELP HELPDEMO.HLP @HELPDEMO.LST 
  296.     COPY HELPDEMO.HLP d:\DVX\HELP 
  297.  
  298. To compile for Native Mem Format : 
  299.     HELPC /MT+ HELPDEMO 
  300. (Use HE HELPDEMO to view that database). 
  301.  
  302. To compile for IPF (OS/2) format : 
  303.     HELPC /OS2 HELPDEMO 
  304.     Switch to an OS/2 session. 
  305.     IPFC /INF HELPDEMO 
  306. (Use the VIEW Command to browse the database). 
  307.  
  308. To compile for the Microsoft Multimedia Viewer 2.0 : 
  309.     HELPC /MMV HELPDEMO 
  310.     Open the MMViewer compiler (WMVC.EXE) 
  311.     File|Open HELPDEMO.MVP 
  312.     Compile (F5) 
  313. (Use the VIEWER2.EXE program to browse the database). 
  314.  
  315. To create a text document with table of contents, glossary and index : 
  316.     HELPC /TXT HELPDEMO 
  317.  
  318. To create a word processor document with table of contents, 
  319. glossary and index : 
  320.     HELPC /RTF HELPDEMO 
  321.     import helpdemo.rtf to your word-processor, and update fields. 
  322.     (e.g. Microsoft WinWord : File|Open to open the document 
  323.                  Answer Yes to convert from Rich Text Format 
  324.                  Press F9 to update embedded format fields 
  325.                  somewhere in the first page (after the 
  326.                  Table Of Contents title), and in the last 
  327.                  page (after the index title).) 
  328.  
  329. Related Topics : 
  330. Overview 
  331. File List 
  332.  
  333.  
  334. ΓòÉΓòÉΓòÉ 7. The Help Engine ΓòÉΓòÉΓòÉ
  335.  
  336.  
  337. To start the help engine program enter HELPENG on the command line, and choose 
  338. the help database you want to view from the list box. Use the Tab key to cycle 
  339. between hot-link words, and press Enter to go to that link. 
  340.  
  341. If you know the name of the SET file of the database you want to activate, you 
  342. can enter it on the command line, and the help engine will display it. 
  343.  
  344. If you have a mouse, you can use it to point at the hi-lighted links, and 
  345. activate them by pressing the left mouse button. 
  346.  
  347. Press the ALT-T key combination to choose from a list of TOPICS in the 
  348. database, Press ALT-B to go back to the previous displayed TOPIC, Press ALT-X 
  349. to exit the help engine. 
  350.  
  351. The exit command can be given by pressing the right mouse button. 
  352.  
  353. Use F10 to open the menu bar, and use the arrow keys to navigate the options. 
  354. When you find the option you are interested in, Use the Enter key to execute 
  355. it, or the Esc key to cancel. The menu bar can be navigated using the mouse as 
  356. well. 
  357.  
  358. To create a new help database please refer to the HELPC documentation file. 
  359.  
  360. If you want to use the Native Mem Format Databases, Please use the supplied 
  361. HE.EXE program. 
  362.  
  363. Related Topics : 
  364. Trouble Shooting 
  365. Overview 
  366.  
  367.  
  368. ΓòÉΓòÉΓòÉ 8. Trouble Shooting ΓòÉΓòÉΓòÉ
  369.  
  370.  
  371. If you receive some kind of an error message while using the help development 
  372. kit please refer to this section. 
  373.  
  374. tableOps: xxxx error message : 
  375.  
  376. This message is generated by the Paradox Engine if an internal error occurs, if 
  377. you receive a message that is not understood (e.g. Table is busy), please try 
  378. one of the following : 
  379.  1. Try running the Help Compiler or the Help Engine with another input and 
  380.   notice if the problem exists, if it does, turn to the next entry, 
  381.   otherwise try to see what the difference between the inputs is. 
  382.  2. Check your free memory, try to move some TSR's from memory, or use the 
  383.   protected mode compiler/engine available with the registered version. 
  384.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE 
  385.   with programs that use the Paradox Engine. If you receive a table busy 
  386.   error, try to see if you have another program that uses the same table 
  387.   in another session (Windows/DESQview etc..). 
  388.  4. PANIC - Please contact the distibuter/author for additional help. 
  389.  
  390. Microsoft's HC31 help compiler will generate a error in RTF file error : 
  391.  
  392.  1. Re-compile using HELPC 4.0+. This should solve the problem, if the problem 
  393.   still exists - please try steps 2 and 3, and notify the author. 
  394.  2. Use a binary disk editor to look at the character at the position x - 1 
  395.   in the RTF file (where x is the error position reported by HC31). 
  396.  3. Try to replace that charqacter from a special PC oem character to a 
  397.   "standard" ascii character (such as *). If the problem still occurs, 
  398.   please contact ISoft D&M/The author, otherwise - you probably came 
  399.   accross a character that HC31 can not handle. In that case - try using 
  400.   HC300b (the one that generates winHelp 3.0 format), or delete these 
  401.   characters from your source HDF file. 
  402.  
  403. Borland's HL help linker will generate a FE02: Out Of Memory error : 
  404.  1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the 
  405.   screen's definitions. 
  406.  
  407. Borland's HL help linker will complain about undefined context numbers : 
  408.  1. You probably have a contents.h file in the current directory, that hl 
  409.   tries to use to bind the help topics to Borland's IDE on-line help, 
  410.   try renaming this file, and re-compile with HL. 
  411.  
  412. HelpC will not create the database when compiling to Native Mem (/MT+) : 
  413.  1. Try compiling with report generation on (/R+) to Native Paradox 
  414.   (/PX+) format. If there are errors, consult the HELPC.LST file, fix 
  415.   them, and re-try. 
  416.  2. If the database is BIG, you might not have enough memory - Remember that 
  417.   Native Mem tables are generated in memory. You will have to use the 
  418.   HelpCX protected mode compiler (Available with the registered version). 
  419.  
  420. HelpEng/HE will complain on an old-database when trying to open a help 
  421. database with it : 
  422.  1. Re-Compile the database using helpC. 
  423.  
  424. HelpEng/HE will complain on un-supported database format, when trying to 
  425. open a database : 
  426.  1. HelpEng can not display Native Mem databases, and HE can not display 
  427.   Native PX databases. Use the other help engine supplied. 
  428.  
  429. HE will not be able to open a Native Mem database : 
  430.  1. Use the protected mode HEX help engine. (Available for registered users). 
  431.  
  432. Where is HL - Borland's Help Linker : 
  433.  1. HL is not included with Borland C++ or Borland Pascal, Borland sells an 
  434.   additional package called Borland Open Architecture (and Borlad OA for 
  435.   Pascal) that include among other things - the THELP help linker. 
  436.  
  437. HelpEng/HE will complain on an old-database when tring to open a help database 
  438. with it : 
  439.  1. Re-Compile the database using helpC. 
  440.  
  441. HelpEng/HE will complain on un-supported database format, when trying to open a 
  442. database : 
  443.  1. HelpEng can not display Native Mem databases, and HE can not display 
  444.   Native PX databases. Use the other help engine supplied. 
  445.  
  446. HE will not be able to open a Native Mem database : 
  447.  1. Use the protected mode HEX help engine. (Available for registered users). 
  448.  
  449. We have encountered some users that ran into problems, because they did not use 
  450. the dos SHARE program. We advise that you will always load the SHARE program in 
  451. your AUTOEXEC.BAT file. 
  452.  
  453. Related Topics : 
  454. Overview 
  455. Help Engine 
  456. Help Compiler 
  457.  
  458.  
  459. ΓòÉΓòÉΓòÉ 9. Help Compiler ΓòÉΓòÉΓòÉ
  460.  
  461.  
  462. The HELPC help compiler is a dos command line program that receives a help 
  463. definition file (.HDF) and produce a help database. 
  464.  
  465.  The helpC command line is : 
  466.  
  467.  HELPC source.fil [/NT:topic-table-name] 
  468.          [/NL:link-table-name] 
  469.          [/ND:data-file-name] 
  470.          [/NK:keywords-table-name] 
  471.          [/D:conditional-define] 
  472.          [/ED=P|C|+] 
  473.          [/EL=x] 
  474.          [/FC+] 
  475.          [/EA+] 
  476.          [/R+]  [/ST-] [/CS+] [/EP+] [/WD-] [/RM-] 
  477.          [/W+]  [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+] [/XD+] 
  478.          [/PX+] [/MT+] [/OS2] [/TXT] [/RTF] [/PP+] [/MMV] 
  479.  
  480. When the target of the compiler is one of the native help engines the output of 
  481. the compiler is a set data file called source.SET, that includes the names of 
  482. the other help database components. 
  483.  
  484. Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler will 
  485. generate a .HPJ and .RTF files that can be used with the Microsoft HC (v3.00b) 
  486. or HC31 help compiler, and output a .HLP windows help file!. 
  487.  
  488. By default the help compiler does not produces a help cross reference report on 
  489. the topics/links used in the database, if the /R+ switch is set, a 
  490. cross-reference report will be generated, and database integrity indicators 
  491. will be given. Notice, however, that with the /R+ switch HELPC is much slower 
  492. than with /R-. 
  493.  
  494. IMPORTANT - Scan the output cross reference report for links defined, that are 
  495. not defined as topics! 
  496.  
  497. Notice - An additional switch is available that instructs the help compiler to 
  498. indicate it's parse and code generation progress. Use the /EP+ switch to see 
  499. that the helpC compiler is active. Please understand that the compile process 
  500. can take a long time, on complex help databases. This switch does nothing more 
  501. that ensure to you that the help compiler is alive. 
  502.  
  503. The /ST switch defines if the topic name defined in the .TOPIC command can 
  504. include embeded spaces. By default this switch is set to /ST- (No embedded 
  505. spaces). 
  506.  
  507. The /CS switch turns Topics and Links case sensativity to ON. Use this switch 
  508. with care - Only if you must have a lower/mixed case index in THELP or POPHELP 
  509. use this switch. Notice that help databases that compile fine with case 
  510. sensativity set to off, might fail to do so in case sensativity on. By deafult 
  511. this switch is set to off (-). 
  512.  
  513. The /XD switch generates code to the MDVXHELP help compiler, available free in 
  514. the file DVXHLP10.ZIP on the Internet. When this switch is given, a set of 
  515. cover and section files is generated, as well as a response file that should be 
  516. used to compile the help database. 
  517.  
  518. The /OS2 switch generates IPF source code. You must compile the generated code 
  519. with IPFC, from within an OS/2 session (window or full screen). 
  520.  
  521. The /WD switch controls Warning Display. By default Warning Display is On, if 
  522. you do not want to see the Warnings issued by the compiler when a topic name or 
  523. link are found to be incompatible with the target source, and helpC translate 
  524. them to be syntax compatible with the target. 
  525.  
  526. Use the /RTF switch to create a word-processor ready RTF file, import this file 
  527. (and update the fields e.g.- F9 in WinWord) to create a professional formatted 
  528. documentation from the same source code!. 
  529.  
  530. Use the /TXT switch to create a text file document from your .HDF source. With 
  531. this feature you can create on-line help and printed documentation from the 
  532. same source!. 
  533.  
  534. The /RM- switch uses disk cross-reference report tables. Usage of this option 
  535. will allow the creation of cross-reference report for huge databases. This 
  536. options will slow the creation of reports, use it only for databases so big 
  537. that the report can not be generated using memory tables. 
  538.  
  539. The /ED= switch creates the external references (if any are defined) in one of 
  540. the following formats : /ED=P (Default) creates the external definitions in a 
  541. pascal unit, /ED=C creates the external definitions in a C header file, and 
  542. /ED=+ creates a C++ header file. 
  543.  
  544. The /EL= switch sets the Error Level used. This switch can be overriden by the 
  545. .ERRORLEVEL statement. The acceptable error levels are : 
  546.  
  547.    0   No Check  - (Default) - No action is taken. 
  548.    1   Trap    - The link is replaced to a special topic named ERROR. 
  549.    2   Strip   - The link is replaced by the Text part only. 
  550.    3   Delete   - The text and link parts are deleted. 
  551.    9   Abort   - helpC will abort with an error message, indicating the 
  552.             line number. 
  553.  
  554. Please refer to the Exception Handling section below about helpC error 
  555. processing. 
  556.  
  557. The /FC+ switch forces topic collection, even if the error level is 0, that 
  558. does not require collection. 
  559.  
  560. Use the /PP+ switch to create an export file, to be used in multiple database 
  561. target files projects. 
  562.  
  563. The /EA+ switch is used to export all topics in a database, durin a PreProcess 
  564. target generation, compared to exporting only topics that have the .EXPORT 
  565. attributes. 
  566.  
  567. The /MMV switch is used to generate Microsoft Multimedia Viewer 2.0 code, You 
  568. must use the WMVC.EXE program that came with your copy of the  Multimedia 
  569. Publishing ToolKit (MM PTK) to compile this code. 
  570.  
  571. Related Topics : 
  572. Overview 
  573. Command Line 
  574. Help Engine 
  575. Technical Documentation 
  576.  
  577.  
  578. ΓòÉΓòÉΓòÉ 10. Command Line ΓòÉΓòÉΓòÉ
  579.  
  580.  
  581. The compiler switches are defined on the command line. These switches can be 
  582. placed before and after the source file name. The compiler will look for a file 
  583. named HELPC.CFG in the current directory, and process it before any command 
  584. line switches are processed. 
  585.  
  586. Switches on the command line will over-ride switches set before them, on the 
  587. command line or in one of the lines of the response options file(s). 
  588.  
  589. Response option files can be specified by prefixing their name with a @ sign. 
  590.  
  591.  
  592.  Examples : 
  593.  
  594.  If our HELPC.CFG file, in the current directory is : 
  595.  
  596. /W31 
  597. /R- 
  598.  
  599.  And we compile using HELPC HELPDEMO 
  600.  
  601.  The helpdemo.hdf file will be compiled, with the target set to winhelp 3.1 
  602.  and no cross-reference report. 
  603.  
  604.  Compile using HELPC HELPDEMO /r+ 
  605.  
  606.  Will create winhelp 3.1 sources, but a report will be generated. 
  607.  
  608.  Compile using HELPC /w- HELPDEMO 
  609.  
  610.  Will generate native format help database, no report is generated. 
  611.  
  612.  If we have a file called MYSWITCH.CFG with the following lines : 
  613.  
  614. /TH+ 
  615. /ST- 
  616. /CS+ 
  617.  
  618.  And we compile using HELPC @MYSWITCH.CFG HELPDEMO 
  619.  
  620.  A THELP source, using Long Topic Names, with case sensitivity will be 
  621.  generated, no cross reference report is generated. (HELPC.CFG contains /r-) 
  622.  
  623. Related Topics : 
  624. Overview 
  625. Help Compiler 
  626.  
  627.  
  628. ΓòÉΓòÉΓòÉ 11. Technical Documentation ΓòÉΓòÉΓòÉ
  629.  
  630.  
  631. The Help Engine database is a combination of text that is read by the user, and 
  632. a Topic and Links database that allows the user to view the topics he is 
  633. interested in, using hyper-text methods. 
  634.  
  635. This document describes the HLPDK language syntax, HELPC compiler operation and 
  636. the native databases structure. 
  637.  
  638. Related Topics : 
  639. Help Compiler 
  640. Help Engine 
  641. Help Definition Format 
  642. Native Format Structure 
  643.  
  644.  
  645. ΓòÉΓòÉΓòÉ 12. Native Database Structure ΓòÉΓòÉΓòÉ
  646.  
  647.  
  648.  
  649.  Each help database is built of 5 components : 
  650.  
  651.  1. Help Data File   - this file contains the raw text data. 
  652.  2. Topic Index    - a database table that contains the topic names, and 
  653.             the references to the topics in the Data File. 
  654.  3. Links Index    - a database table that contains the list of links 
  655.             defined for each topic, and positional data. 
  656.  4. Keywords Index   - a database table that contains the list of keywords, 
  657.             and the topics that have these keywords. 
  658.  5. Set Data File   - a database configuration file that contains the 
  659.             names of the 3 components defined above, and some 
  660.             additional information. 
  661.  
  662. Version 1.x is the bare-bones version that includes only the basic operations 
  663. needed from a hyper-text database, this version is implemented using the 
  664. Paradox Engine V3.0 to manage the Topic and Link index tables. 
  665.  
  666. Version 2.x has a new field in the topic table - the title field, help 
  667. databases that were compiled with V1.x will not be executed by version 2.x, 
  668. they will have to be re-compiled!. 
  669.  
  670. Version 3.x fields have different length - the databases have to be 
  671. re-compiled. 
  672.  
  673. Version 5.0+ has a new entry in the help set file, database have to be 
  674. re-compiled, or the value 128 should be added in the last line of the help set 
  675. file, and the version number should be changed to 5.0. 
  676.  
  677. Version 6.0+ has added the keyword support - a new database table is added, and 
  678. a new set format is defined. Help databases will have to be re-compiled for 
  679. Natice targets. 
  680.  
  681. In Version 7.0 the title field has been expanded once more - to 70 characters. 
  682. Help databases will have to be re-compiled. 
  683.  
  684. In Version 8.0 the tType field was added to the Topics database. Old databases 
  685. will have to be re-compiled. 
  686.  
  687. The format of the help database is released to the public domain, if you 
  688. implement a database viewer on this database structure, I would be happy to 
  689. receive a copy .. 
  690.  
  691. Related Topics : 
  692. Help Compiler 
  693. Help Engine 
  694. Help Definition Format 
  695. Topic Index Format 
  696. Links Index Format 
  697. Keywords Index Format 
  698. Set File Format 
  699.  
  700.  
  701. ΓòÉΓòÉΓòÉ 13. Help Definition Format ΓòÉΓòÉΓòÉ
  702.  
  703.  
  704.  
  705.  The help definition file format is as follows : 
  706.  
  707. | remarks ... 
  708. | remarks ... 
  709. | 
  710. | .ENTRY topic-name 
  711. | [.TITLE optional title for topic] 
  712. | [.TITLEATTR paragraph attributes] 
  713. | [.KEYWORDS optional keywords for topic] 
  714. | [.GROUPS group1 [group2 ..]] 
  715. | [.LIST optional browse list for topic] 
  716. | [.EXPORT] 
  717. | topic text and link reference .. 
  718. | topic text and link reference .. 
  719. | topic text and link reference .. 
  720. | topic text and link reference .. 
  721. | .END-ENTRY 
  722. | 
  723. | remarks ... 
  724. | 
  725. | 
  726. | .ENTRY topic2-name 
  727. | [.KEYWORDS keyword1 keyword2 ..] 
  728. | [.GROUPS group3 [group2 ..]] 
  729. | [.PARAGRAPH [paragraph attributes]] 
  730. | topic 2 text and link reference .. 
  731. | topic 2 text and link reference .. 
  732. | topic 2 text and link reference .. 
  733. | [.END-PARAGRAPH] 
  734. | additional topic2 text ... 
  735. | .END-ENTRY 
  736. | 
  737. | .POPUP popup-name 
  738. | [.TITLE optional title for popup] 
  739. |  definition for some reference 
  740. |  ... 
  741. | .END-POPUP 
  742.  
  743.  As can be seen - lines between the .ENTRY and .END-ENTRY keywords are 
  744.  the lines processed by the help compiler, to create the help database, 
  745.  every other line is considered a remark, and is not parsed or evaluated by 
  746.  the help compiler. 
  747.  
  748.  The topic text and link reference lines are simple text lines, with 
  749.  special link marks. 
  750.  
  751.  A sample will provide the details : 
  752.  
  753. This is a text help line that includes one ~link~link-topic-name~ in it. 
  754.  
  755.  This line will be displayed in the help engine program as : 
  756.  
  757. This is a text help line that includes one link in it. 
  758.  
  759.  The word "link" will be in a different color then the rest of the line, 
  760.  to indicate that this is a link. If the user hi-lights the link, and 
  761.  presses Enter (or points the mouse cursor and clicks), the help engine will 
  762.  look for a topic called "link-topic-name", and display it. 
  763.  
  764.  Browse the HELPDEMO.HDF file for a demo of a help database definition file. 
  765.  
  766.  Notes : 
  767.  
  768.  1. The keywords .TOPIC and .END-TOPIC can be used instead of .ENTRY and 
  769.  .  .END-ENTRY respectively. 
  770.  
  771.   An equivalent pair of keywords are .TOP and .ENDTOP . 
  772.  
  773.   You can use .EXT-TOPIC instead of .TOPIC/.ENTRY etc.. - topics created 
  774.   with that statement are the same as regular topics, only - an external 
  775.   reference is created for them to be linked to a pascal/C/C++ program. 
  776.  
  777.  2. Keywords are NOT case sensitive. (.topic = .TOPIC = .eNTry) 
  778.  
  779.  3. The .TITLE keyword is optional. If no title is defined, the topic name 
  780.   is used as a title. The .TITLEATTR keyword is used to describe the 
  781.   title text attributes. The syntax is the same as the .PARAGRAPH text 
  782.   attributes. Please refer to the Text Attributes section below for further 
  783.   discussion of the optional paragraph attributes. 
  784.  
  785.  4. If you want the ~ sign to appear in your help database, use ~~ in your 
  786.   help source file. (e.g. "This is a ~~" will be "This is a ~" in the final 
  787.   help database.). 
  788.  
  789.  5. The Optional .PARAGRAPH and .END-PARAGRAPH commands in the help topic text, 
  790.   specify the start and the end of a paragraph. This feature is currently 
  791.   supported only for MMViewer, winhelp, RTF and IPF sources. This feature is 
  792.   important if you want to create long paragraphs that will wrap correctly 
  793.   when a user resizes the help window. Please refer to the 
  794.   Text Attributes section below for further discussion of the optional 
  795.   paragraph attributes. 
  796.  
  797.   The .PAR and .ENDPAR keywords can be used instead of the .PARAGRAPH 
  798.   and .END-PARAGRAPH keywords. 
  799.  
  800.  6. When a .PARAGRAPH is issued, a .END-PARAGRAPH MUST be specified at the 
  801.   end of the paragraph. These commands must appear as the first words in 
  802.   a line. The text after the .PARAGRAPH command is NOT part of the text 
  803.   of the help topic. 
  804.  
  805.  
  806.  7. The optional .KEYWORDS command can appear after the .TITLE command 
  807.   (If there is one), or the .TOPIC header (otherwise), Use this command 
  808.   to help the user search for sets of topics that are connected to a 
  809.   specific keyword. The syntax of this command is : 
  810.   .KEYWORDS keyword-1 keyword-2 ... 
  811.   Multiple .KEYWORDS lines are allowed, if there are a lot of KEYWORDS, 
  812.   that will not fit on a single line, multiple .KEYWORDS lines can be 
  813.   used. (NewsDB - The usenet hypertext generator uses that feature). 
  814.  
  815.  8. .POPUP and .END-POPUP (or .ENDPOP) are used to define popup topics that 
  816.   are displayed on the same screen as the original topic that includes the 
  817.   link to them. Popup entries allow the user to consult a glossary, and 
  818.   not lose the topic he was reading. Popups are supported in the winhelp, 
  819.   OS/2 IPF, Native PX/Mem and MMViewer formats. In the other formats Popups are 
  820.   used as standard topics. 
  821.  
  822.  9. In the Text/RTF targets .POPUP entries will be automatically included in a 
  823.   Glossary file that you can add as an appendix to your documentation. 
  824.  
  825. 10. The .GROUPS statement associate a topic with several groups, you can 
  826.   create topics with menus to groups of other topics using the statement 
  827.   ".INSERT GROUP group-name" in your topic text. Please refer to the 
  828.   Groups section of this document for additional discussion of this 
  829.   function. 
  830.   Multiple .GROUPS lines are allowed, if there are a lot of GROUPS, 
  831.   that will not fit on a single line, multiple .GROUPS lines can be 
  832.   used. 
  833.  
  834. 11. The .LIST attribute associates a topic to a browse sequence, in this 
  835.   name. The topic will be after the previous topic that belongs to this 
  836.   list, and before the next topic that belongs to this list. The list 
  837.   browse sequences are currently supported in the WINHELP and MMViewer 
  838.   targets only. 
  839.  
  840. 12. Graphic support is available by using a Graphic Link, a Graphic Link, 
  841.   is a link that has the following format : 
  842.   ~Text to display if not a graphic target~graphic-name~ 
  843.   Where graphic-name is the name of a graphic object defined with the 
  844.   .GRAPHIC statement. Please refer to the Graphics Section below for more 
  845.   information. 
  846.  
  847. 13. If the .EXPORT attribute is specified, HELPC will automatically create 
  848.   a reference to the topic in an export file. This function can be useful 
  849.   when you create a multiple file target database. This command can be very 
  850.   useful when you have to create a complex multi file database, and use a 
  851.   'make' utility to maintain the project. For more information about this 
  852.   attribute, please refer to the Complex Projects section below. 
  853.  
  854. 14. Sound support is available by using a Sound link. This link will play a 
  855.   sound file, when the user clicks the link. The link has the following 
  856.   format :  ~Text-That-Will-Appear~soundLinkName~ 
  857.   Where Text-That-Will-Appear will be displayed on the screen, and whem the 
  858.   text will be clicked, the sound object defined as soundLinkName will be 
  859.   played. Please refer to the Sound section below. 
  860.  
  861. 15. Applications can be launced from the help database by clicking a link, that 
  862.   was defined as an application. The syntax is : ~Text~application-link~ 
  863.   where Text is the text that will appear to the user, and application-link 
  864.   is the identifier of the application that will be executed, as defined in 
  865.   the .APPLICATION statement. Please refer to the Application Launch section 
  866.   below for more information. 
  867.  
  868. 16. User defined links can be created and used in the topic text, please refer 
  869.   to the Links section below for discussion of this feature. 
  870.  
  871. Additional commands include : 
  872.  
  873. | .TEXTCOLOR, .LINKCOLOR and .LINKHIGH - VGA colors of text and links in normal 
  874. and high (selected) states in the native help formats. 
  875.  
  876. The syntax of these commands is : 
  877.  
  878. | .TEXTCOLOR w 
  879.  
  880. or 
  881.  
  882. | .LINKCOLOR x 
  883.  
  884. or 
  885.  
  886. | .LINKHIGH y 
  887.  
  888. Where w, x and y are the color of the text/link, which is a combination of the 
  889. color of the foreground with the color of the background multiplied by 16. 
  890.  
  891. The colors that can be used for both fore and background are : 
  892.  
  893.  Black   = 0 
  894.  Blue    = 1 
  895.  Green   = 2 
  896.  Cyan    = 3 
  897.  Red    = 4 
  898.  Magenta  = 5 
  899.  Brown   = 6 
  900.  LightGray = 7 
  901.  
  902. The colors that can be used only for the foreground are : 
  903.  
  904.  DarkGray   = 8 
  905.  LightBlue   = 9 
  906.  LightGreen  = 10 
  907.  LightCyan   = 11 
  908.  LightRed   = 12 
  909.  LightMagenta = 13 
  910.  Yellow    = 14 
  911.  White     = 15 
  912.  
  913. For example : to set the normal color of a link to light green on blue, use 
  914.  
  915. | .LINKCOLOR 26 
  916.  
  917. where 26 = 10 + 16 * 1. (10 = light green, 1 = blue). 
  918.  
  919. Creating Multiple Source Projects : 
  920.  
  921. Use the .INCLUDE commands in the source of your .HDF file, to include an 
  922. additional source file. .INCLUDE is not supported in the middle of a topic. 
  923.  
  924. For Example : 
  925.  
  926.  .. some stuff 
  927.  
  928. | .include 2ndfile.hdf 
  929.  
  930.  .. additional stuff 
  931.  
  932. will process 2NDFILE.HDF in the middle of our source file. 
  933.  
  934. Please notice - .INCLUDE commands can be nested in your source file, 
  935. it is however not recommended to nest them too deep, helpC does not 
  936. close the input file when a .INCLUDEd file is processed, in order to 
  937. minimize help generation time - there is however, a limit on the number 
  938. of open files that can be used by a program - this is a limit set by dos. 
  939.  
  940. Code Insertion : 
  941.  
  942. Use the .INSERT CODE statement to insert target code that will not be 
  943. translated by helpC. helpC will send un-translated code to the output target 
  944. until a .END-CODE statement is found. 
  945.  
  946. For example - creating a small table in winhelp format : 
  947. | .. normal code 
  948. | .ifdef windows 
  949. | .insert code 
  950. | \pard{\tab column1\tab column2\tab column3}\par 
  951. | \pard{\par col1data\tab col2data ..}\par 
  952. | .end-code 
  953. | .endif 
  954.  
  955. GUI Font based targets : 
  956.  
  957. The .FIXEDFONT command is used to define a non proportional font as the 
  958. default font of the help database. Currently the only targets affected 
  959. by this command are MMViewer, winHelp, RTF. If you find that your help 
  960. databases are not aligned after they are converted to winHelp format, use 
  961. this command and re-compile. This command has no effect on targets that are 
  962. different from the targets mentioned above. 
  963.  
  964. The .PCFONT command is used to define a font that has the standard pc 
  965. character set (Terminal - in windows). If you convert a text based 
  966. database that uses the PC's special characters, use this command to 
  967. set the default font. This command has no effect on targets that are 
  968. different from the targets mentioned above. 
  969.  
  970. Text targets : 
  971.  
  972. The .PAGELENGTH and .PAGEWIDTH statements set the printed page length in 
  973. rows, and width in columns. The syntax is .PAGELENGTH xx or .PAGEWIDTH yy . 
  974.  
  975. Font Pallete : 
  976.  
  977. Use the .SETFONT command to change or add fonts to the font palette, The 
  978. syntax is : .SETFONT font-number 'Font-Name-In-The-Target-Language'. If 
  979. for example we would like to change font number 3 in the windows target 
  980. to be a font X of family Y we would write : 
  981. | .SETFONT 3 'Y X' 
  982.  
  983. Text Attributes : 
  984.  
  985. Use the .TITLEDEFAULTS statement to set the default text attributes of the 
  986. topics titles in the help database. These defaults can be over-ridden with 
  987. the .TITLEATTR statement in the topic definition. Please refer to the Text 
  988. Attributes section below for discussion of paragraph text attributes. 
  989.  
  990. Use the .ATTRDEFAULTS statement to set the default text attributes of 
  991. paragraph text in the database. Please refer to the Text Attributes section 
  992. below. 
  993.  
  994. Error Handling : 
  995.  
  996. Use the .ERRORLEVEL command to set the error level. The syntax is .ERRORLEVEL x 
  997. where x is one of the following : 
  998.  
  999.    0   No Check  - (Default) - No action is taken. 
  1000.    1   Trap    - The link is replaced to a special topic named ERROR. 
  1001.    2   Strip   - The link is replaced by the Text part only. 
  1002.    3   Delete   - The text and link parts are deleted. 
  1003.    9   Abort   - helpC will abort with an error message, indicating the 
  1004.             line number. 
  1005.  
  1006. Please refer to the Exception Handling section below about helpC error 
  1007. processing. 
  1008.  
  1009. Alias Topics : 
  1010.  
  1011. Use the .ALIAS command to substitute a Popup/Topic name with another name. The 
  1012. syntax is .ALIAS newname origname. Whenever a newname link is found, the alias 
  1013. of origname is used. This can be very useful when you want to give multiple 
  1014. names to a topic, or when HLPDK source is the target of an incremental 
  1015. compiler. 
  1016.  
  1017. Graphic Support : 
  1018.  
  1019. Use the .GRAPHIC statement to define a graphic object, that can be referenced 
  1020. elsewhere in your document. The syntax is : 
  1021. | .GRAPHIC graphic-name path-to-graphic-file 
  1022. Please refer to the Graphics section below, for further information. 
  1023.  
  1024. External Links : 
  1025.  
  1026. Use the .EXTLINK command to define links in external database file. With this 
  1027. command you can create multiple file target database projects. Please refer to 
  1028. the Links section below for more information about this feature. 
  1029.  
  1030. Sound Support : 
  1031.  
  1032. Use the .SOUND command statement to define a sound object, that can be used as 
  1033. a Sound link elsewhere in your document. The syntax is : 
  1034. | .SOUND sound-name sound-file-name 
  1035. Please refer to the Sound section below for more information about this 
  1036. feature. 
  1037.  
  1038. Application Launch : 
  1039.  
  1040. The .APPLICATION statement is used to define an application object that can be 
  1041. launced by an application-launch-link. The syntax is : 
  1042. | .APPLICATION application-identifer application-definition 
  1043.  
  1044. where application-identifer is the identifer that will be used in 
  1045. application-launch-links, and application-definition is the path to the 
  1046. application. If the application needs to get parameters, the path and the 
  1047. parameters are specified in quotes. Please refer to the Application Launch 
  1048. section below for additional information. 
  1049.  
  1050. External Routines Support : 
  1051.  
  1052. The .ROUTINE statement can be used to define external routines that can be 
  1053. called from the help database. The syntax is : 
  1054. | .ROUTINE routine-name module-name parameter-definition 
  1055.  
  1056. Where routine-name is the name of the procedure/function to be called, 
  1057. module-name is the name of the library/DLL that the routine resides in (No need 
  1058. to add the .DLL extention), and parameter-definition is the definition of the 
  1059. parameters that the routine receives. The parameter definitions is a string 
  1060. with one character describing each parameters type. The following definitions 
  1061. are used : 
  1062.  
  1063. char   C definition        Pascal definition 
  1064.  
  1065. u    unsigned short (WORD)    Word 
  1066. U    unsigned long  (DWORD)   Longint 
  1067. i    short int          byte 
  1068. I    int             integer 
  1069. s    near char * (PSTR)     PChar 
  1070. S    far char * (LPSTR)     PChar 
  1071. v    void 
  1072.  
  1073. Embedding Files : 
  1074.  
  1075. Use the .EMBEDD statement to add files to your help database. The files defined 
  1076. as embedded will appear in the [baggage] section of your winHelp/MMViewer 
  1077. project definition and will be stored with the rest of the database. 
  1078.  
  1079. The syntax is : 
  1080.  
  1081. | .EMBEDD file-id path-to-file 
  1082.  
  1083. Where file-id is the name the file will be referenced by, and path-to-file is 
  1084. the path to the file on the author's machine. 
  1085.  
  1086. Related Topics : 
  1087. Technical Documentation 
  1088. Conditional Defines 
  1089. Groups 
  1090. Text Attributes 
  1091. Graphics 
  1092. Sound 
  1093.  
  1094.  
  1095. ΓòÉΓòÉΓòÉ 14. Links - internal/external and special ΓòÉΓòÉΓòÉ
  1096.  
  1097.  
  1098. Links are the special "commands" embedded in a topic text, that provide special 
  1099. functionality in the target database. 
  1100.  
  1101. All links are described in the topic text as a combination of text that will 
  1102. appear, and a link identifier. 
  1103.  
  1104. The syntax, in a topic text for a link is : 
  1105.  
  1106.  .. Some Standard Text .. ~Link Text~Link Id~ .. some more text .. 
  1107.  
  1108. Link Id is a unique identifier that describe this link. 
  1109.  
  1110. The most common link, is a topic link, this link allows the user to click on 
  1111. the Link Text, that is usually in a different color than the rest of the text, 
  1112. and by clicking on this texst, the topic in the help engine window is replaced, 
  1113. with the topic that has the same identifier as the Link Id specified in the 
  1114. identifier. (A Topic is defined by a .topic statement somewhere else in the 
  1115. source file). 
  1116.  
  1117. Another type of link, is the Popup link. When the Link Id is the Id of a popup, 
  1118. clicking on the link will display the popup text in a window, and retain the 
  1119. original topic in the help engine window. (A Popup is defined by a .popup 
  1120. statement somewhere else in the source file). 
  1121.  
  1122. Links can be used, to embedd non-textual information in the topic text. A 
  1123. common non-textual is a graphic link, when the Link Id is the Id of a graphic 
  1124. object (defined by a .graphic statement somewhere else in our source), the 
  1125. place of the link will be replaced by a graphic picture, in targets that 
  1126. support graphics (such as WINHELP and OS/2 IPF), and remain the Link Text in 
  1127. targets that do not supprot graphics. 
  1128.  
  1129. Another non-textual link is a sound link. A sound link plays a sound file when 
  1130. a sound object (defined with the .SOUND statement) is clicked by the user. 
  1131.  
  1132. Applications can be lauched from a link, when the link key is the identifer of 
  1133. an application defined with the .APPLICATION statement. 
  1134.  
  1135. Other links can be created using "User Defined Link Templates", with this 
  1136. feature a link template can be created to support additional code translations. 
  1137. Please refer to the Extending HDF section below for additional information on 
  1138. User defined links. 
  1139.  
  1140. When HELPC recognizes a link, the following sequence of link recognition occurs 
  1141. - 
  1142. 1. Try to match link with a graphic object. 
  1143. 2. If failed - try to match link with a sound object. 
  1144. 3. If failed - try to match link with an application object. 
  1145. 4. If failed - try to match link with a user defined link. 
  1146. 5. If failed - try to match link with a popup. 
  1147. 6. If failed - try to match link with a topic. 
  1148. 7. If failed - try to match link with an external topic. (.EXTLINK) 
  1149. 8. If failed - opearate according to the current error-level. 
  1150.  
  1151. Related Topics : 
  1152. Application Launch 
  1153. Graphics 
  1154. Sound 
  1155. Exception Handling 
  1156. Technical Documentation 
  1157. .HDF Syntax 
  1158. Help Compiler 
  1159.  
  1160.  
  1161. ΓòÉΓòÉΓòÉ 15. Conditional Defines ΓòÉΓòÉΓòÉ
  1162.  
  1163.  
  1164. The helpC compiler supports conditional define directives that allow you to 
  1165. tailor your source according to define symbols that are known to the compiler. 
  1166.  
  1167. You can use the .ifdef, .ifndef, .else and .endif directives to test the target 
  1168. of your compile and do different things according to this target. 
  1169.  
  1170. If for example you have a Windows bitmap you want to include in your generated 
  1171. RTF file, when you compile to winhelp format, but, you would like to use a 
  1172. statement in other targets that do not support graphics, you could do the 
  1173. following : 
  1174.  
  1175. | .ifdef windows 
  1176. |  some text {\bmc mybmp.bmp\} some more text 
  1177. | .else 
  1178. |  some text AND STATEMENT HERE some more text 
  1179. | .endif 
  1180.  
  1181. When the compiler will generate the code, the RTF command \bmc will be inserted 
  1182. in the output of the compiler for windows targets (/W30, /W31), and a simple 
  1183. text statement will be inserted otherwise. 
  1184.  
  1185. The conditional directives supported are : 
  1186.  
  1187. | .ifdef  SYMBOL - Compile code only if SYMBOL is defined. 
  1188. | .ifndef SYMBOL - Compile code only if SYMBOL is NOT defined. 
  1189. | .endif     - Any .ifdef/.ifndef should be terminated by a .endif . 
  1190. | .else      - Reverse the previous .ifdef/.ifndef 
  1191.  
  1192. The following SYMBOLS are automatically defined by the compiler : 
  1193.  
  1194. Symbol      When Defined 
  1195. ------      ------------ 
  1196. DEF       /PX+ 
  1197. W31       /W31 
  1198. W30       /W30 
  1199. THS       /TH+ 
  1200. QHS       /QH+ 
  1201. TVH       /TV+ 
  1202. PHS       /PH+ 
  1203. DVX       /XD+ 
  1204. MEM       /MT+ 
  1205. OS2       /OS2 
  1206. TXT       /TXT 
  1207. WINDOWS     /W30, /W31 
  1208. THELP      /TH+ 
  1209. QUICKHELP    /QH+ 
  1210. TVHC       /TV+ 
  1211. NATIVEPARADOX  /PX+ 
  1212. POPHELP     /PH+ 
  1213. DESQVIEW/X    /XD+ 
  1214. NATIVEMEMORY   /MT+ 
  1215. VERx.y      When Compiling with helpC Vx.y 
  1216. NATIVE      /PX+, /MT+ 
  1217. DOCUMENT     /TXT, /RTF 
  1218. RTFBASED     /W+, /RTF, /W30, /W31, /MMV 
  1219. PRP       /PP+ 
  1220. PREPROCESS    /PP+ 
  1221. MMV       /MMV 
  1222. MMVIEWER     /MMV 
  1223. VIEWER      /MMV 
  1224.  
  1225. You can define your own conditional defines on the command line using the /D: 
  1226. switch of helpC. 
  1227.  
  1228. e.g. 
  1229.  
  1230. Source : 
  1231.  
  1232. | ... some text .. 
  1233. | .ifdef mydef 
  1234. |  Special Text for mydef situation 
  1235. | .endif 
  1236. | ... more text 
  1237.  
  1238. and you compile using HELPC /D:MYDEF the special text will be included. 
  1239.  
  1240. Related Topics : 
  1241. Technical Documentation 
  1242. Help Definition 
  1243.  
  1244.  
  1245. ΓòÉΓòÉΓòÉ 16. Text Attributes ΓòÉΓòÉΓòÉ
  1246.  
  1247.  
  1248. Topic's text can receive visual attributes such as a font, size, bold, italic 
  1249. etc.. by using the paragraph attributes on the .PARAGRAPH (.par) line. Text 
  1250. attributes are currently supported in the MMViewer, winhelp and rtf targets. 
  1251.  
  1252. The attributes that can be applied to text are : 
  1253.  
  1254. Font       - The font the text will be displayed in. 
  1255. Bold       - The text is displayed in bold characters. 
  1256. Italic      - The text is displayed in italic characters. 
  1257. Underline    - The text is displayed in underline characters. 
  1258. Size       - The size of the font. 
  1259. Box       - The paragraph can be contained in a box. 
  1260. Align      - The paragraph can be alligned. 
  1261. Color      - The text foreground color. 
  1262.  
  1263. The syntax is : 
  1264.  
  1265. | .PARAGRAPH [attr1 attr1-parameters [attr2 attr2-parameters [..] ]] 
  1266.  
  1267. The allowed parameters to attributes are : 
  1268.  
  1269. 1. FONT font-number-in-font-palette : The font number in the font palette, 
  1270. there 
  1271. is a standard font palette for MMViewer, winhelp and rtf targets that include 
  1272. the following fonts : 
  1273.  
  1274.  0 : Times Roman     (roman Tms Rmn) 
  1275.  1 : Symbol       (decor Symbol) 
  1276.  2 : Helvetica      (swiss Helv) 
  1277.  3 : LinePrinter     (modern LinePrinter) 
  1278.  4 : Terminal      (roman Terminal) 
  1279.  5 : Times New Roman   (roman Times New Roman) 
  1280.  6 : Arial        (swiss Arial) 
  1281.  7 : CG Times (WN)    (roman CG Times (WN)) 
  1282.  8 : Courier       (modern Courier) 
  1283.  9 : Modern       (modern Modern) 
  1284. 10 : Script       (script Script) 
  1285. 11 : Univers (WN)    (swiss Univers (WN)) 
  1286. 12 : Wingdings      (nil Wingdings) 
  1287. 13 : MS Sans Serif    (swiss MS Sans Serif) 
  1288.  
  1289. 2. BOLD ON|OFF - Set bold mode to on/off. 
  1290.  
  1291. 3. ITALIC ON|OFF - Set italic mode to on/off. 
  1292.  
  1293. 4. UNDERLINE ON|OFF - Set underline mode on/off. 
  1294.  
  1295. 5. SIZE font-size - Set the size of the font. 
  1296.  
  1297. 6. BOX NONE|NORMAL|THICK|SHADOW|DOUBLE - Print paragraph in a box which has one 
  1298. of the described borders : NONE is no border at all. 
  1299.  
  1300. 7. ALIGN LEFT|RIGHT|CENTER|JUSTIFY - Print the text in the paragraph aligned 
  1301. to one of the sides, the center or justified in the paragraph. 
  1302.  
  1303. 8. COLOR color-number-in-color-palette - The numbers are the same numbers used 
  1304. for dos native systems and described in the help definition format section 
  1305. above, regarding the .LINKCOLOR, .TEXTCOLOR and .LINKHIGH statements. 
  1306.  
  1307. Example : 
  1308.  
  1309. | .PAR BOX SHADOW FONT 13 BOLD ON 
  1310. |   ... some text here .. 
  1311. | .ENDPAR 
  1312.  
  1313. Will display the paragraph in a shadow bordered box, using font 13 in the 
  1314. palette (MS Sans Serif assuming that the original palette is used) with bold 
  1315. characters. 
  1316.  
  1317. Related Topics : 
  1318. Technical Documentation 
  1319. Help Definition 
  1320.  
  1321.  
  1322. ΓòÉΓòÉΓòÉ 17. Groups Definition and Usage ΓòÉΓòÉΓòÉ
  1323.  
  1324.  
  1325.  
  1326. Topics can be associated to groups using the .GROUPS statement in the topic 
  1327. heading. Menus to these groups can later be created by using the 
  1328. command .INSERT GROUP group-name in the topic text. 
  1329.  
  1330. An example will clarify the use of this function : 
  1331.  
  1332. Let us assume that we have a car's collectors database, where the description 
  1333. of each car is a topic. We would like to present a hierarchy to the user that 
  1334. looks like that : 
  1335.  
  1336. Overview Screen 
  1337.   | 
  1338.   +--------- Cars by Country 
  1339.   |        | 
  1340.   |        +------------ U.S.A ... List of cars manufactured in U.S.A 
  1341.   |        +------------ U.K. 
  1342.   |        +------------ Italy 
  1343.   | 
  1344.   +--------- Cars by Maker 
  1345.   |        | 
  1346.   |        +------------ Alfa-Romeo ... List of Alfa-Romeo models 
  1347.   |        +------------ GM 
  1348.   |        +------------ Mazda 
  1349.   | 
  1350.   +--------- Cars by type 
  1351.           | 
  1352.           +------------ 4x4 & Jeeps 
  1353.           +------------ Sport Cars 
  1354.           +------------ Family Sedans 
  1355.  
  1356. We will create group references in the topics using the .GROUPS statement, 
  1357. The Alfa Romeo Spider 2000 topic will look like : 
  1358.  
  1359. | .topic alfa_romeo_spider_2000 
  1360. | .title Alfa Romeo Spider 2000 
  1361. | .keywords alfa spider convertible sport classic 
  1362. | .groups italian alfa sport 
  1363. | 
  1364. | The Alfa Romeo ... 
  1365. | 
  1366. | 
  1367. | .end-topic 
  1368.  
  1369. The Italian Cars Directory topic will be : 
  1370.  
  1371. | .topic italy_directory 
  1372. | .title Italian Cars Directory 
  1373. | .keywords directory 
  1374. | 
  1375. | Cars Manufactured in Italy : 
  1376. | 
  1377. | .insert group italian 
  1378. | 
  1379. | .end-topic 
  1380.  
  1381. If our database includes 3 cars that have a reference to the Italian group 
  1382. this will be the equivalent of writing : 
  1383.  
  1384. | .topic italy_directory 
  1385. | .title Italian Cars Directory 
  1386. | .keywords directory 
  1387. | 
  1388. | Cars Manufactured in Italy : 
  1389. | 
  1390. | ~Alfa Romeo Spider 2000~alfa_romeo_spider_2000~ 
  1391. | ~Ferrari 308 GTS~Ferrari_308_gts~ 
  1392. | ~Fiat Uno 70S~fiat_uno_70s~ 
  1393. | 
  1394. | .end-topic 
  1395.  
  1396. Related Topics : 
  1397. Technical Documentation 
  1398. .HDF Syntax 
  1399. Conditional Defines 
  1400.  
  1401.  
  1402. ΓòÉΓòÉΓòÉ 18. Exception Handling ΓòÉΓòÉΓòÉ
  1403.  
  1404.  
  1405. helpC provides mechanism to handle link exceptions. An exception is a link to 
  1406. an identifier that is not defined as a Topic or PopUp. In order to help you 
  1407. find these errors helpC contains the cross reference report that can be 
  1408. produced using the /R+ switch. You can browse the HELPC.LST file generated by 
  1409. helpC if a cross reference report is generated, and search for the string ERROR 
  1410. that describes undefined links. 
  1411.  
  1412. helpC provides additional exception handling facilities. When an error is found 
  1413. during compile helpC can perform on of the following actions : 
  1414.  
  1415. 0: No Check - Default - helpC does not do anything. The link is passed as is to 
  1416.        the target. The target help engine/compiler will handle the 
  1417.        exception as it is implemented. 
  1418.  
  1419. 1: Trap   - helpC will replace the link key with the key ERROR. It is the 
  1420.        responsibility of the help database author to provide such a 
  1421.        topic/popup. 
  1422.  
  1423. 2: Strip   - helpC will pass the text of the link to the target with no link 
  1424.        support. The text will appear as normal text. 
  1425.  
  1426. 3: Delete  - Both the text and the link will be deleted and will not appear in 
  1427.        the target. 
  1428.  
  1429. 9: Abort   - helpC will abort, with an error message, indicating the line the 
  1430.        link is defined. This mode is recommended when you are debugging 
  1431.        your help database. 
  1432.  
  1433. You can set the error level using the following techniques : 
  1434.  
  1435. - Use the /EL=x switch on the helpC command line. 
  1436.  
  1437. - Use the .ERRORLEVEL x .HDF statement. 
  1438.  
  1439. Important Points : 
  1440.  
  1441. 1. When errorLevel = 0 (default) no topic database is created during pass 1, if 
  1442. you set .errorlevel somewhere in your source, after some topics/popups have 
  1443. been defined, these topics will not be in the symbol table created by helpC and 
  1444. will be considered an exception!. 
  1445.  
  1446. 2. You can use the /FC+ switch to "Force Collection" of Topics data, even when 
  1447. the ERRORLEVEL is 0. 
  1448.  
  1449. Related Topics : 
  1450. Technical Documentation 
  1451. .HDF Syntax 
  1452. Help Compiler 
  1453.  
  1454.  
  1455. ΓòÉΓòÉΓòÉ 19. Native Graphics Support ΓòÉΓòÉΓòÉ
  1456.  
  1457.  
  1458. Native Graphic support is provided by graphic "links", and graphic object 
  1459. definitions. 
  1460.  
  1461. In order to incorporate graphics into your database, use the .GRAPHIC command 
  1462. to define a graphic object. This command associates a graphic file with a 
  1463. unique identifier. 
  1464.  
  1465. Whenever you want to use the graphic image in one of your topics, you should 
  1466. define a link with the following syntax : 
  1467.  
  1468. ~Link Text in non-graphic targets~graphic-identifier~ 
  1469.  
  1470. If the target of the compiler has no HELPC native graphic support, the "Link 
  1471. Text in non-graphic targets" sentance will be used, if the target is supported, 
  1472. the graphic-identifier will be displayed. 
  1473.  
  1474. In this version of HLPDK native graphics support is provided for WINHELP, 
  1475. Microsoft Multimedia Viewer (MMViewer) and OS/2 IPF Bitmaps. 
  1476.  
  1477. Notice that the graphic-identifier must be unique, and must not be identical to 
  1478. a topic/popup/sound name. Please refer to the Links section for link 
  1479. recognition sequence information. 
  1480.  
  1481. Link Modifiers are attributes that are defined after the link name, separated 
  1482. with the ";" character. 
  1483.  
  1484. The following modifiers are defined for Graphic support : 
  1485.  
  1486. Left  : Align the graphic object to the left of the window. 
  1487. Right  : Align the graphic object to the right of the window. 
  1488. Center : Align the graphic object to the center of the window. 
  1489.  
  1490. Please refer to one of the standard documentation examples that are supplied 
  1491. with the HLPDK package, for demos of graphic use. 
  1492.  
  1493. Related Topics : 
  1494. Technical Documentation 
  1495. .HDF Syntax 
  1496. Help Compiler 
  1497. Links 
  1498.  
  1499.  
  1500. ΓòÉΓòÉΓòÉ 20. Native Sound Support ΓòÉΓòÉΓòÉ
  1501.  
  1502.  
  1503.  
  1504. Sound support is provided by sound "links", and sound object definition. 
  1505.  
  1506. In order to incorporate sound into your database, use the .SOUND command to 
  1507. define a sound object. This command associates a sound file (WAV in windows) 
  1508. with a unique identifier. 
  1509.  
  1510. Whenever you want to use the sound object in one of your topics, you have to 
  1511. define a link with the following syntax : 
  1512.  
  1513. ~Text To Be Clicked On~sound-identifier~ 
  1514.  
  1515. Currently, Sound support is available only in the MMViewer and winHelp targets. 
  1516. The name of the sound object in this version should be a WAV file, that is in 
  1517. the \WINDOWS directory. The WINDOWS MMSYSTEM multi-media support looks for the 
  1518. sound file in this directory!. 
  1519.  
  1520. Related Topics : 
  1521. Technical Documentation 
  1522. .HDF Syntax 
  1523. Help Compiler 
  1524. Links 
  1525.  
  1526.  
  1527. ΓòÉΓòÉΓòÉ 21. Application Launch ΓòÉΓòÉΓòÉ
  1528.  
  1529.  
  1530. Applications can be launched from the help database using application launch 
  1531. links, and application definitions. 
  1532.  
  1533. An application has to be defined using the .APPLICATION statement that uses the 
  1534. following syntax : | .APPLICATION application-id 'application-activation-code' 
  1535. Where application-id is the identifier to the application that will be used in 
  1536. application launch links, and the application-activation-code is the [optional] 
  1537. path to the application and the application executable. If parameters should be 
  1538. specified, the application-activation-code should be surrounded by quotes, with 
  1539. a space separating the path to the application from the parameters. 
  1540.  
  1541. When you want to include an application launch in the topic text, the 
  1542. application-id should be used as the key of a link. 
  1543. e.g. ~Press Here To Run XXX.EXE~application-id~ 
  1544.  
  1545. Related Topics : 
  1546. Technical Documentation 
  1547. .HDF Syntax 
  1548. Help Compiler 
  1549. Links 
  1550.  
  1551.  
  1552. ΓòÉΓòÉΓòÉ 22. Complex Projects (Multiple file target databases) ΓòÉΓòÉΓòÉ
  1553.  
  1554.  
  1555. HELPC supports multiple file target databases, with the use of the following 
  1556. HDF statements : .EXTLINK, and .EXPORT . 
  1557.  
  1558. When a link that exists in an external database is needed, the .EXTLINK 
  1559. statement is used to define the properties and attributes of that link. 
  1560.  
  1561. The most important property - is the database name, that defines which database 
  1562. should be called. Other attributes include the title, keywords, numeric 
  1563. references and groups this external topic should be associated with. 
  1564.  
  1565. If we have a "simple" complex project, with only 2 databases, and links between 
  1566. them, we might not find it difficult to define the "public" links of database 1 
  1567. in database 2, and vice versa, but - if the project involves more databases, we 
  1568. might find it hard to create these public references to all external database, 
  1569. in each database. We can, however, define .EXTLINK statements of the public 
  1570. links of each database, in a separate file, and use the .INCLUDE statement to 
  1571. include them, in the other statements. 
  1572.  
  1573. HELPC can be used, with the /PP+ switch, to create these "reference" export 
  1574. files, with the name of database.EXP when we use the following command : 
  1575. HELPC /PP+ database-name 
  1576.  
  1577. If we want a .EXTLINK statement to be created for a topic, we have to add the 
  1578. .EXPORT attribute to the topic defintion. Amn alternative is to use the /EA+ 
  1579. switch of the HELPC compiler, that exports all topics in the database, in a 
  1580. PreProcess target compile (/PP+). 
  1581.  
  1582. The .EXTLINK statement has the following syntax : 
  1583.  
  1584. | .EXTLINK database 'topic-identifier' 
  1585. | [.TITLE topic-title] 
  1586. | [.REFERENCE topic-numeric-reference] 
  1587. | [.KEYWORDS keyword [keyword ..] ] 
  1588. | [.GROUPS group [group ..] ] 
  1589. | .END-EXTLINK 
  1590.  
  1591. Where database is the name of the external database that the link is in, 
  1592. topic-identifier is the id of the link in the external database, title, 
  1593. keywords and groups have the same meaning as in the .TOPIC definition, and the 
  1594. topc-numeric-reference is a numeric reference associated with the topic, in the 
  1595. external database, if this is needed. 
  1596.  
  1597. Related Topics : 
  1598. Technical Documentation 
  1599. .HDF Syntax 
  1600. Help Compiler 
  1601.  
  1602.  
  1603. ΓòÉΓòÉΓòÉ 23. Extending HDF ΓòÉΓòÉΓòÉ
  1604.  
  1605.  
  1606. The HDF syntax can be extended by creating "User Defined Link Templates", with 
  1607. these templates special links can be created, that can be used to support 
  1608. additional link types. 
  1609.  
  1610. In order to create a user link template, use the following statement : 
  1611.  
  1612. | .USERLINK userlink-id template 
  1613.  
  1614. Where userlink-id is the name of the template, and template defines the way the 
  1615. link will be translated. 
  1616.  
  1617. The template can include the following substitution characters : 
  1618.  
  1619. %%        - Replace with a % 
  1620. %t        - Replace with the text of the link 
  1621. %k        - Replace with the key of the link 
  1622. %1, %2, .. %5  - Replace with parameter #x 
  1623. %o        - Replace with target (output) database name. 
  1624. %c        - Replace with context-id (topic name) of current topic. 
  1625. %g1, %g2, ..   - Replace with the graphic object whose id is in parameter x. 
  1626. %s1, %s2, ..   - Replace with the sound object whose id is in parameter x. 
  1627. %a1, %a2, ..   - Replace with the application object, whose id is in parm x. 
  1628. %e1, %e2, ..   - Replace with the embedded object, whose name is in parm x. 
  1629.          Notice, that only the file name and extention are returned, 
  1630.          while in the %gx, %sx and %ax, the entire path is returned. 
  1631.  
  1632. User links can be used in the topic text with the following syntax : 
  1633.  
  1634.   .. some text ~link-text~userlink-id(param1 param2 ..)~ .. more text 
  1635.  
  1636. Use this command to extend the HDF syntax. You can even create special 
  1637. libraries to support video/animation etc.. from the help databases, with these 
  1638. extentions. 
  1639.  
  1640. e.g. - To create a link to a topic, with a graphic bitmap, we could define the 
  1641. following User Link : (Example for winHelp/MMViewer) 
  1642.  
  1643. | .userlink graphicJump '{\uldb \{bmc %g1\} %t}{\v %2}' 
  1644.  
  1645. And assuming we defined a graphic object as 
  1646.  
  1647. | .graphic mypicture ronp.bmp 
  1648.  
  1649. We could create a graphic links such as : 
  1650.  
  1651.  Click ~Ron Loewy~graphicJump(mypicture ronTopic)~ to know about the author. 
  1652.  
  1653. In the target RTF this will be translated to : 
  1654.  
  1655.  Click {\uldb \{bmc ronp.bmp\} Ron Loewy}{\v ronTopic} to know about the 
  1656. author. 
  1657.  
  1658. Related Topics : 
  1659. Technical Documentation 
  1660. Links 
  1661. .HDF Syntax 
  1662. Help Compiler 
  1663.  
  1664.  
  1665. ΓòÉΓòÉΓòÉ 24. Topic Index Format ΓòÉΓòÉΓòÉ
  1666.  
  1667.  
  1668.  
  1669.  The topic index table format is as follows : 
  1670.  
  1671.  TOPIC   - 40 characters string key - this is the topic "name". 
  1672.  FILENAME  - 38 characters string field - includes the name of the 
  1673.        help raw data file. (Notice - V1.0 ignores the value of this 
  1674.        field, it is here for future expansion). 
  1675.  START   - longint (long) field that contains the offset from the data file 
  1676.        start, to the start of the topics text data, in bytes. 
  1677.  LEN    - longint (long) field that contains the length (in bytes) of the 
  1678.        text data of the topic. 
  1679.  TITLE   - 70 characters string key - the title of the topic. 
  1680.  TTYPE   - 1 character - topic type. Currently supported types are : 
  1681.        'T' = Topic. 
  1682.        'P' = Popup. 
  1683.  
  1684. Related Topics : 
  1685. Technical Documentation 
  1686. Links Index Format 
  1687. Keywords Index Format 
  1688. Set File Format 
  1689.  
  1690.  
  1691. ΓòÉΓòÉΓòÉ 25. Links Index Format ΓòÉΓòÉΓòÉ
  1692.  
  1693.  
  1694.  
  1695.  The links index table format is as follows : 
  1696.  
  1697.  TOPIC   - 40 characters string key - the name of the topic that 
  1698.        has the link. 
  1699.  SEQ    - integer (int) key - contains the sequential number of 
  1700.        the link in the topic. (This way you can assign the links 
  1701.        order in the topic). 
  1702.  LINK    - 40 characters string key - the name of the link topic to 
  1703.        display if the link is chosen. 
  1704.  LINE    - integer (int) field - the line (from the start of the topic) 
  1705.        this link is displayed on. 
  1706.  COL    - integer (int) field - the column this link is displayed on. 
  1707.  TXT    - 70 characters string field - the text to display on the line. 
  1708.  
  1709. Related Topics : 
  1710. Technical Documentation 
  1711. Topic Index Format 
  1712. Keywords Index Format 
  1713. Set File Format 
  1714.  
  1715.  
  1716. ΓòÉΓòÉΓòÉ 26. Set File Format ΓòÉΓòÉΓòÉ
  1717.  
  1718.  
  1719.  
  1720.  The set file is a text file that contains one entry in each line, using 
  1721.  the following format : 
  1722.  
  1723. help-database-engine 
  1724. version-of-generating-compiler 
  1725. topic-index-table name 
  1726. links-index-table name 
  1727. keywords-index-table name 
  1728. help-raw-data-file name 
  1729. number-of-topics 
  1730. length-of-file 
  1731. link-normal-color 
  1732. link-high-color 
  1733. text-normal-color 
  1734.  
  1735. The help-database-engine values available today are DEF=Paradox and MEM=memory 
  1736. Tables. 
  1737.  
  1738. Related Topics: 
  1739. Technical Documentation 
  1740. Topic Index Format 
  1741. Links Index Format 
  1742. Keywords Index Format 
  1743.  
  1744.  
  1745. ΓòÉΓòÉΓòÉ 27. Keywords Index Format ΓòÉΓòÉΓòÉ
  1746.  
  1747.  
  1748.  
  1749.  The keywords index table format is as follows : 
  1750.  
  1751.  KEYWORD  - 40 characters string key - the keyword. 
  1752.  TOPIC   - 40 characters string key - the topic name that this keyword is 
  1753.        assigned to. 
  1754.  
  1755.  Notice - the database will include a row for each keyword, that has the 
  1756.  TOPIC field blank. This is used to display the first list of keywords, that 
  1757.  if chosen, will display the 2nd list of topics that have the chosen keyword 
  1758.  in their .KEYWORDS definition. 
  1759.  
  1760. Related Topics: 
  1761. Technical Documentation 
  1762. Topic Index Format 
  1763. Links Index Format 
  1764. Set File Format 
  1765.  
  1766.  
  1767. ΓòÉΓòÉΓòÉ 28. Related Products ΓòÉΓòÉΓòÉ
  1768.  
  1769.  
  1770.  
  1771. The following products/packages provide additional HLPDK functionality : 
  1772.  
  1773. 1. Name     : IL2HDK - Interrupt List (Ralf Brown) 2 HLPDK convert program. 
  1774.   Version    : 2.3 
  1775.   Availability : IL2HDK22.ZIP. 
  1776.   Status    : Free. 
  1777.   Author    : Ron Loewy. 
  1778.  
  1779. 2. Name     : HPCHDK - HelpPC 2 HLPDK convert program. 
  1780.   Version    : 1.0 
  1781.   Availability : HPCHDK10.ZIP. 
  1782.   Status    : Free. 
  1783.   Author    : Yaniv Golan (s2942275@tech02.technion.ac.il) 
  1784.  
  1785. 3. Name     : SCANHELP - Turbo Pascal Scanner to help. 
  1786.   Version    : 3.13 
  1787.   Availability : SCANH313.ZIP (Contact Author) 
  1788.   Status    : Shareware. 
  1789.   Author    : Duncan J. Murdoch (dmurdoch@mast.QueensU.CA) 
  1790.  
  1791. 4. Name     : NG2HDK - Norton Guides 2 HLPDK convert program. 
  1792.   Version    : 1.0 
  1793.   Availability : NG2HDK10.ZIP 
  1794.   Status    : Free. 
  1795.   Author    : Ron Loewy. 
  1796.  
  1797. 5. Name     : NEWSDB - usenet News Clips Hypertext generator. 
  1798.   Version    : 1.0. 
  1799.   Availability : NEWSDB10.ZIP 
  1800.   Status    : Shareware. 
  1801.   Author    : Ron Loewy. 
  1802.  
  1803. 6. Name     : POPHDK - POPHELP 2 HLPDK convert program. 
  1804.   Version    : 1.0 
  1805.   Availability : POPHDK10.ZIP. 
  1806.   Status    : Free. 
  1807.   Author    : Yaniv Golan (s2942275@tech02.technion.ac.il) 
  1808.  
  1809. 7. Name     : JARG2HDK - Jargon File to HLPDK convert program. 
  1810.   Version    : 1.0 
  1811.   Availability : ? (Contact Author) 
  1812.   Status    : ? 
  1813.   Author    : Slren Pingel Dalsgaard (pingel@daimi.aau.dk) 
  1814.  
  1815. Currently under development : RTF2HDK, RC2HDK, HDKLIB and more .. 
  1816.