home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / progs / help / hlpdk.hdt < prev    next >
Text File  |  1993-09-27  |  47KB  |  1,261 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 5517                                ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. The Help Engine Development Kit is a system that allows you to create 
  12. hyper-text database help systems with topics and hot links, using a simple
  13. text editor and the help compiler. 
  14.  
  15. The help databases can be distributed (free of charge) with the HELPENG or
  16. HE help engine display programs. 
  17.  
  18. The help database format is release to the public domain, if you own the 
  19. Paradox Engine you can use the help databases with your own programs. 
  20.  
  21. Borland Pascal Users can purchase the Help Engine Source Code even
  22. for Applications that do not use the paradox engine, using the Native Mem
  23. format.
  24.  
  25. The helpC compiler that is part of this development kit includes the
  26. ability to create Windows Help source files from the same source the 
  27. dos help sources are created!. Write your help once, and create help
  28. databases for Dos, Windows, OS/2 and DESQview/X !
  29.  
  30. Supported Formats :
  31. Native(PX), Native (Mem), Win30, Win31, QuickHelp, 
  32. THELP, TVHC, POPHELP, DESQview/X, OS/2, Text, Word Processors (RTF)
  33.  
  34. From the same source you created your hypertext database, you can create
  35. a text document with automatic table of contents and index sections!
  36.  
  37. Using the RTF target you can prepare your professional documentation
  38. by generating word processors documents, all from the same source!
  39.  
  40. Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  41. Turbo Pascal programs, and use the help engine window in your pascal
  42. programs.
  43.  
  44. Related Topics :
  45. Registration
  46. Contact
  47. File List
  48. Credits
  49. Help Engine
  50. Help Compiler
  51. Quick Start
  52. Related Products
  53.  
  54.  
  55. *******************************************************************************
  56. *                 Why Register and registration instructions                  *
  57. *******************************************************************************
  58.  
  59. The Help Engine Development Kit (HLPDK) is a shareware product, if you 
  60. find this product valuable, please register it. 
  61. This section describes the reasons you should register.
  62.  
  63. By registering you will receive a complete discussion of the help engine 
  64. features, and many examples of usage. You will receive a diskette with the
  65. latest HLPDK version, and DPMI (DOS protected mode) versions of the help 
  66. compiler and engines!. (The memory version of the help engine can display 
  67. huge databases only in the protected mode version).
  68.  
  69. Your registration will help us to create the next versions of HLPDK, that
  70. will include more options, and features, some of them might even be your
  71. enhancement requests!.
  72.   
  73. A point to consider - If you want to create Windows Help source files,
  74. you will have to purchase a word processor that can output RTF files,
  75. the WORD for Windows 2.0 package, for example, is listed at around $500!.
  76.  
  77. To order your registered copy of HLPDK please do one of the following:
  78.  
  79.  1.     Order from ISoft D&M:     
  80.  You can order directly from ISoft D&M. Please refer to the supplied 
  81.  HLPDK.REG file. Edit it, print it and mail it (with a check) to: 
  82.         ISoft D&M,  
  83.         POBox 5517
  84.         Coralville Iowa 52241, U.S.A
  85.  
  86.  2.     Order from PsL:
  87.  You can order from Public (software) Library with your MC, Visa, AmEx 
  88.  or Discover card by calling 800-242-4PsL (from overseas: 713-524-6394) or 
  89.  by FAX to 713-524-6398 or by CompuServe to 71355,470. 
  90.  These numbers are for ordering only. ISoft D&M can NOT be reached at those 
  91.  numbers. Please contact ISoft D&M directly for any other type of problem 
  92.  (technical or other), information or request.
  93.                                               
  94. Related Topics :
  95. Contact
  96. Overview
  97.  
  98.   Please contact :
  99.  
  100.   ISoft D&M,  
  101.   P.O.B 5517
  102.   Coralville IA 52241,
  103.   U.S.A
  104.  
  105. ISoft D&M e-mail address : CompuServe - 76350,333
  106.  
  107.   To contact the author directly : 
  108.  
  109.   Contact :     Loewy Ron,
  110.                 9 Haneveem st.
  111.                 Herzeliya, 46465
  112.                 ISRAEL.
  113.  
  114. e-mail address : CompuServe - 100274,162
  115.  
  116. Related Topics :
  117. Regsiteration
  118. Overview
  119.  
  120.  This package contains the following files in the following archives :
  121.  
  122. Archive A :
  123. -----------
  124.  READMEA.HDK    - File List for Archive A.
  125.  HELPC.EXE      - Help Compiler.
  126.  HLPDK.DOC      - This file.
  127.  HELPC.DOC      - Help Compiler documentation
  128.  HLPDK.REG      - Registration file.
  129.  HLPDK.HDF      - Help Development Kit hypertext help database source.
  130.  HLPDK.HLP      - WinHelp Version of the hlpdk hypertext source.
  131.  HLPDK.INF      - OS/2 IPF Version of the HLPDK hypertext source.
  132.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  133.  HELPDEMO.HDF   - Demo Help Project.
  134.  2NDDEMO.HDF    - Demo Help Project - file 2.
  135.  
  136. Archive B :
  137. -----------
  138.  READMEB.HDK    - File List for Archive B.
  139.  HELPENG.EXE    - Help Engine (Native Paradox).
  140.  HE.EXE         - Help Engine (Native Memory).
  141.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  142.  HLPDK.HDT      - Help Development Kit help database file. (Native Paradox)
  143.  HLPDK.SET      - Help Development Kit help database file.
  144.  HLPDKTOP.*     - Help Development Kit help database files.
  145.  HLPDKLNK.*     - Help Development Kit help database files.
  146.  HLPDKKEY.*     - Help Development Kit help database files.
  147.  
  148. Related Topics :
  149. Overview
  150. Quick Start
  151.  
  152. HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  153. Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. 
  154. (Trademarks of Borland International).
  155.  
  156. Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  157. of Microsoft Corp.
  158.  
  159. The HELPENG program was written using the WINTEXT UI library, 
  160. (c) 1991,93 Loewy Ron.
  161.  
  162. THELP, HL and TVHC are Trademarks or copyrights Borland International.
  163.  
  164. POPHELP is a copyright of TurboPower Software.
  165.  
  166. TVHC support, and other ideas were suggested by MunLeong Chan.
  167.  
  168. Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen
  169. CASE code generators.
  170.  
  171. Parts of the Help Compiler were generated using Ron Loewy's dbGen database 
  172. code generator.
  173.  
  174. Yaniv Golan helped me with beta-testing, debugging and suggestions.
  175.  
  176. John Murphy notified me of the paragraph formatting difficulties that
  177. lead to the .PARAGRAPH .END-PARAGRAPH formatting capabilities.
  178.  
  179. DESQview/X is a trademark of Quarterdeck Office Systems.
  180.  
  181. MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his
  182. excelent documentation of DESQview/X help format to generate code
  183. to this environment.
  184.  
  185. The HC31 problem with characters with ordinal values biggen than 127
  186. was solved thanks to Mr. Lars Fosdal of Norway.
  187.  
  188. OS/2 is a registered trademark of International Bussiness Machines.
  189.  
  190. The Text Cursor restore problem in the help engines was reported by Prof.
  191. Timo Salmi of the Univ. of VAASA, Finland.
  192.  
  193. D.J. Murdoch suggested the Cross Reference Report enhancements, and winhelp
  194. Go To Search list box title problem.
  195.  
  196. Word for Windows is a trademark of Microsoft corp.
  197.  
  198. WordPerfect, WordPerfect for Windows are trademarks of WordPerfect corporation.
  199.  
  200. Lotus, AMI PRO are trademarks of Lotus corp.
  201.  
  202. Reuben Halevi from ISoft D&M did a lot to make this product real.
  203.  
  204. Related Topics :
  205. Overview
  206.  
  207. From the command line enter HELPC HELPDEMO to compile the demo help database.
  208.  
  209. After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  210. demo help database.
  211.  
  212. If you want to compile for windows :
  213.  
  214. from the command line enter HELPC HELPDEMO /W31
  215. and after that HC31 HELPDEMO
  216. (HC31 is the Microsoft Help Compiler)
  217. from windows, open the HELPDEMO.HLP file from the windows help engine.
  218. (Notice - if you do not have the HC help compiler from windows, we have
  219. included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  220. able to feel the quality of the output that can be generated, and decide
  221. if you want to purchase the HC31 program (Included with the SDK, BC++, 
  222. TPW, BP and probably some other packages), or download it from one of the
  223. sites Microsoft had uploaded it to).
  224.  
  225. If you use windows 3.0, or want your help file to be compatible with
  226. winHelp 3.0 use :
  227.         HELPC /W30 HELPDEMO
  228.         HC HELPDEMO
  229.  
  230. To compile for THELP use : 
  231.         HELPC /TH+ HELPDEMO
  232.         HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
  233.  
  234. To compile for QuickHelp : 
  235.         HELPC /QH+ HELPDEMO
  236.         HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
  237.  
  238. To compile for TVHC :
  239.         HELPC /TV+ HELPDEMO
  240.         TVHC HELPDEMO.TXT
  241.  
  242. To compile for POPHELP :
  243.         HELPC /PH+ HELPDEMO
  244.         MAKEHELP /Q HELPDEMO
  245.  
  246. To compile for DESQview/X :
  247.         HELPC /XD+ HELPDEMO
  248.         MDVXHELP HELPDEMO.HLP @HELPDEMO.LST
  249.         COPY HELPDEMO.HLP d:\DVX\HELP
  250.  
  251. To compile for Native Mem Format :
  252.        HELPC /MT+ HELPDEMO
  253. (Use HE HELPDEMO to view that database).
  254.  
  255. To compile for IPF (OS/2) format :
  256.        HELPC /OS2 HELPDEMO 
  257.        Switch to an OS/2 session.
  258.        IPFC /INF HELPDEMO
  259. (Use the VIEW Command to browse the database).
  260.  
  261. To create a text document with table of contents, glossary and index :
  262.        HELPC /TXT HELPDEMO
  263.  
  264. To create a word processor document with table of contents, 
  265. glossary and index :
  266.        HELPC /RTF HELPDEMO
  267.        import helpdemo.rtf to your word-processor, and update fields.
  268.        (e.g. Microsoft WinWord : File|Open to open the document
  269.                                  Answer Yes to convert from Rich Text Format
  270.                                  Press F9 to update embedded format fields
  271.                                  somewhere in the first page (after the 
  272.                                  Table Of Contents title), and in the last 
  273.                                  page (after the index title).)
  274. Related Topics :
  275. Overview
  276. File List
  277.  
  278. To start the help engine program enter HELPENG on the command line, and 
  279. choose the help database you want to view from the list box. Use the Tab key
  280. to cycle between hot-link words, and press Enter to go to that link.
  281.  
  282. If you know the name of the SET file of the database you want to activate, you
  283. can enter it on the command line, and the help engine will display it.
  284.  
  285. If you have a mouse, you can use it to point at the hi-lighted links, and 
  286. activate them by pressing the left mouse button.
  287.  
  288. Press the ALT-T key combination to choose from a list of TOPICS in the 
  289. database, Press ALT-B to go back to the previous displayed TOPIC, Press
  290. ALT-X to exit the help engine.
  291.  
  292. The exit command can be given by pressing the right mouse button.
  293.  
  294. Use F10 to open the menu bar, and use the arrow keys to navigate the 
  295. options. When you find the option you are interested in, Use the Enter
  296. key to execute it, or the Esc key to cancel. The menu bar can be navigated
  297. using the mouse as well.
  298.  
  299. To create a new help database please refer to the HELPC documentation
  300. file.
  301.  
  302. If you want to use the Native Mem Format Databases, Please use the supplied
  303. HE.EXE program. 
  304.  
  305. Related Topics :
  306. Trouble Shooting
  307. Overview
  308.  
  309. If you receive some kind of an error message while using the help development
  310. kit please refer to this section.
  311.  
  312. tableOps: xxxx error message :
  313. This message is generated by the Paradox Engine if an internal error occurs,
  314. if you receive a message that is not understood (e.g. Table is busy), 
  315. please try one of the following :
  316.  1. Try running the Help Compiler or the Help Engine with another input and 
  317.     notice if the problem exists, if it does, turn to the next entry,
  318.     otherwise try to see what the difference between the inputs is.
  319.  2. Check your free memory, try to move some TSR's from memory, or use the
  320.     protected mode compiler/engine available with the registered version.
  321.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE
  322.     with programs that use the Paradox Engine. If you receive a table busy
  323.     error, try to see if you have another program that uses the same table 
  324.     in another session (Windows/DESQview etc..).
  325.  4. PANIC - Please contact the distibuter/author for additional help.
  326.  
  327. Microsoft's HC31 help compiler will generate a error in RTF file error :
  328.  
  329.  1. Re-compile using HELPC 4.0+. This should solve the problem, if the problem
  330.     still exists - please try steps 2 and 3, and notify the author. 
  331.  2. Use a binary disk editor to look at the character at the position x - 1
  332.     in the RTF file (where x is the error position reported by HC31).
  333.  3. Try to replace that charqacter from a special PC oem character to a 
  334.     "standard" ascii character (such as *). If the problem still occurs,
  335.     please contact ISoft D&M/The author, otherwise - you probably came 
  336.     accross a character that HC31 can not handle. In that case - try using
  337.     HC300b (the one that generates winHelp 3.0 format), or delete these 
  338.     characters from your source HDF file.
  339.  
  340. Borland's HL help linker will generate a FE02: Out Of Memory error :
  341.  1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the
  342.     screen's definitions.
  343.  
  344. Borland's HL help linker will complain about undefined context numbers :
  345.  1. You probably have a contents.h file in the current directory, that hl
  346.     tries to use to bind the help topics to Borland's IDE on-line help,
  347.     try renaming this file, and re-compile with HL.
  348.  
  349. HelpC will not create the database when compiling to Native Mem (/MT+) :
  350.  1. Try compiling with report generation on (/R+) to Native Paradox
  351.     (/PX+) format. If there are errors, consult the HELPC.LST file, fix 
  352.     them, and re-try.
  353.  2. If the database is BIG, you might not have enough memory - Remember that
  354.     Native Mem tables are generated in memory. You will have to use the
  355.     HelpCX protected mode compiler (Available with the registered version).
  356.  
  357. HelpEng/HE will complain on an old-database when trying to open a help
  358. database with it :
  359.  1. Re-Compile the database using helpC.
  360.  
  361. HelpEng/HE will complain on un-supported database format, when trying to
  362. open a database :
  363.  1. HelpEng can not display Native Mem databases, and HE can not display
  364.     Native PX databases. Use the other help engine supplied.
  365.  
  366. HE will not be able to open a Native Mem database :
  367.  1. Use the protected mode HEX help engine. (Available for registered users).
  368.  
  369. Where is HL - Borland's Help Linker :
  370.  1. HL is not included with Borland C++ or Borland Pascal, Borland sells an
  371.     additional package called Borland Open Architecture (and Borlad OA for 
  372.     Pascal) that include among other things - the THELP help linker.
  373.  
  374. HelpEng/HE will complain on an old-database when tring to open a help
  375. database with it :
  376.  1. Re-Compile the database using helpC.
  377.  
  378. HelpEng/HE will complain on un-supported database format, when trying to
  379. open a database :
  380.  1. HelpEng can not display Native Mem databases, and HE can not display
  381.     Native PX databases. Use the other help engine supplied.
  382.  
  383. HE will not be able to open a Native Mem database :
  384.  1. Use the protected mode HEX help engine. (Available for registered users).
  385.  
  386. We have encountered some users that ran into problems, because they did 
  387. not use the dos SHARE program. We advise that you will always load the 
  388. SHARE program in your AUTOEXEC.BAT file.
  389.  
  390. Related Topics :
  391. Overview
  392. Help Engine
  393. Help Compiler
  394.  
  395. The HELPC help compiler is a dos command line program that receives a 
  396. help definition file (.HDF) and produce a help database. 
  397.  
  398.   The helpC command line is :
  399.  
  400.  HELPC source.fil [/NT:topic-table-name]
  401.                   [/NL:link-table-name] 
  402.                   [/ND:data-file-name] 
  403.                   [/NK:keywords-table-name] 
  404.                   [/D:conditional-define]
  405.                   [/ED=P|C|+]
  406.                   [/EL=x]
  407.                   [/R-]  [/ST-] [/CS+] [/EP+] [/WD-] [/RM-]
  408.                   [/W+]  [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+] [/XD+]
  409.                   [/PX+] [/MT+] [/OS2] [/TXT] [/RTF]
  410. The output of the compiler is a set data file called source.SET, that
  411. includes the names of the other help database components. 
  412.  
  413. Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler 
  414. will generate a .HPJ and .RTF files that can be used with the Microsoft 
  415. HC (v3.00b) or HC31 help compiler, and output a .HLP windows help file!. 
  416.  
  417. By default the help compiler produces a help cross reference report on the 
  418. topics/links used in the database, if the /R- switch is set, no cross-ref
  419. report will be generated, and no database integrity indicators will be
  420. given.
  421.  
  422.  
  423. IMPORTANT - Scan the output cross reference report for links defined, that
  424. are not defined as topics!
  425.  
  426. Notice - An additional switch is available that instructs the help compiler
  427. to indicate it's parse and code generation progress. Use the /EP+ switch to
  428. see that the helpC compiler is active. Please understand that the compile
  429. process can take a long time, on complex help databases. This switch does
  430. nothing more that ensure to you that the help compiler is alive. 
  431.  
  432. The /ST switch defines if the topic name defined in the .TOPIC command
  433. can include embeded spaces. By default this switch is set to /ST- (No
  434. embedded spaces).
  435.  
  436. The /CS switch turns Topics and Links case sensativity to ON. Use this
  437. switch with care - Only if you must have a lower/mixed case index in THELP
  438. or POPHELP use this switch. Notice that help databases that compile fine
  439. with case sensativity set to off, might fail to do so in case sensativity
  440. on. By deafult this switch is set to off (-).
  441.  
  442. The /XD switch generates code to the MDVXHELP help compiler, available
  443. free in the file DVXHLP10.ZIP on the Internet. When this switch is given,
  444. a set of cover and section files is generated, as well as a response
  445. file that should be used to compile the help database.
  446.  
  447. The /OS2 switch generates IPF source code. You must compile the generated code 
  448. with IPFC, from within an OS/2 session (window or full screen).
  449.  
  450. The /WD switch controls Warning Display. By default Warning Display is On, if
  451. you do not want to see the Warnings issued by the compiler when a topic name 
  452. or link are found to be incompatible with the target source, and helpC 
  453. translate them to be syntax compatible with the target.
  454.  
  455. Use the /RTF switch to create a word-processor ready RTF file, import this
  456. file (and update the fields e.g.- F9 in WinWord) to create a professional
  457. formatted documentation from the same source code!.
  458.  
  459. Use the /TXT switch to create a text file document from your .HDF source.
  460. With this feature you can create on-line help and printed documentation
  461. from the same source!.
  462.  
  463. The /RM- switch uses disk cross-reference report tables. Usage of this 
  464. option will allow the creation of cross-reference report for huge databases.
  465. This options will slow the creation of reports, use it only for databases
  466. so big that the report can not be generated using memory tables.
  467.  
  468. The /ED= switch creates the external references (if ant are defined) in one
  469. of the following formats : /ED=P (Default) creates the external definitions
  470. in a pascal unit, /ED=C creates the external definitions in a C header 
  471. file, and /ED=+ creates a C++ header file.
  472.  
  473. The /EL= switch sets the Error Level used. This switch can be overriden
  474. by the .ERRORLEVEL statement. The acceptable error levels are :
  475.  
  476.       0    No Check  - (Default) - No action is taken.
  477.       1    Trap      - The link is replaced to a special topic named ERROR.
  478.       2    Strip     - The link is replaced by the Text part only.
  479.       3    Delete    - The text and link parts are deleted.
  480.       9    Abort     - helpC will abort with an error message, indicating the 
  481.                        line number.
  482. Please refer to the Exception Handling section below about helpC error
  483. processing.
  484.  
  485. Related Topics :
  486. Overview
  487. Command Line
  488. Help Engine
  489. Technical Documentation
  490.  
  491. The compiler switches are defined on the command line. These switches can
  492. be placed before and after the source file name. The compiler will look for
  493. a file named HELPC.CFG in the current directory, and process it before any
  494. command line switches are processed. 
  495.  
  496. Switches on the command line will over-ride switches set before them, on the
  497. command line or in one of the response options file.
  498.  
  499. Response option files can be specified by prefixing their name with a @ sign.
  500.  
  501.  
  502.  Examples :
  503.  
  504.  If our HELPC.CFG file, in the current directory is :
  505.  
  506. /W31
  507. /R-
  508.  
  509.  And we compile using HELPC HELPDEMO
  510.  
  511.  The helpdemo.hdf file will be compiled, with the target set to winhelp 3.1
  512.  and no cross-reference report.
  513.  
  514.  Compile using HELPC HELPDEMO /r+
  515.  
  516.  Will create winhelp 3.1 sources, but a report will be generated.
  517.  
  518.  Compile using HELPC /w- HELPDEMO
  519.  
  520.  Will generate native format help database, no report is generated.
  521.  
  522.  If we have a file called MYSWITCH.CFG with the following lines :
  523.  
  524. /TH+
  525. /ST-
  526. /CS+
  527.  
  528.  And we compile using HELPC @MYSWITCH.CFG HELPDEMO
  529.  
  530.  A THELP source, using Long Topic Names, with case sensitivity will be 
  531.  generated, no cross reference report is generated. (HELPC.CFG contains /r-)
  532.  
  533. Related Topics :
  534. Overview
  535. Help Compiler
  536.  
  537.  
  538.  
  539. The Help Engine database is a combination of text that is read by the user,
  540. and a Topic and Links database that allows the user to view the topics
  541. he is interested in, using hyper-text methods.
  542.  
  543. This document describes the HLPDK language syntax, HELPC compiler operation
  544. and the native databases structure.
  545.  
  546. Related Topics :
  547. Help Compiler
  548. Help Engine
  549. Help Definition Format
  550. Native Format Structure
  551.  
  552.  
  553.   Each help database is built of 5 components : 
  554.  
  555.  1. Help Data File    - this file contains the raw text data.
  556.  2. Topic Index       - a database table that contains the topic names, and
  557.                         the references to the topics in the Data File.
  558.  3. Links Index       - a database table that contains the list of links 
  559.                         defined for each topic, and positional data.
  560.  4. Keywords Index    - a database table that contains the list of keywords,
  561.                         and the topics that have these keywords.
  562.  5. Set Data File     - a database configuration file that contains the
  563.                         names of the 3 components defined above, and some 
  564.                         additional information.
  565.  
  566. Version 1.x is the bare-bones version that includes only the basic
  567. operations needed from a hyper-text database, this version is implemented
  568. using the Paradox Engine V3.0 to manage the Topic and Link index tables.
  569.  
  570. Version 2.x has a new field in the topic table - the title field, help
  571. databases that were compiled with V1.x will not be executed by version
  572. 2.x, they will have to be re-compiled!.
  573.  
  574. Version 3.x fields have different length - the databases have to be 
  575. re-compiled.
  576.  
  577. Version 5.0+ has a new entry in the help set file, database have to be
  578. re-compiled, or the value 128 should be added in the last line of the help
  579. set file, and the version number should be changed to 5.0.
  580.  
  581. Version 6.0+ has added the keyword support - a new database table is added,
  582. and a new set format is defined. Help databases will have to be re-compiled
  583. for Natice targets.
  584.  
  585. In Version 7.0 the title field has been expanded once more - to 70 
  586. characters. Help databases will have to be re-compiled.
  587.  
  588. In Version 8.0 the tType field was added to the Topics database. Old databases
  589. will have to be re-compiled.
  590.  
  591. The format of the help database is released to the public domain, if
  592. you implement a database viewer on this database structure, I would be
  593. happy to receive a copy ..
  594.  
  595. Related Topics :
  596. Help Compiler
  597. Help Engine
  598. Help Definition Format
  599. Topic Index Format
  600. Links Index Format
  601. Keywords Index Format
  602. Set File Format
  603.  
  604.  
  605.   The help definition file format is as follows :
  606.  
  607. | remarks ...
  608. | remarks ...
  609. | 
  610. | .ENTRY topic-name
  611. | [.TITLE optional title for topic]
  612. | [.TITLEATTR paragraph attributes]
  613. | [.KEYWORDS optional keywords for topic]
  614. | [.GROUPS group1 [group2 ..]]
  615. | topic text and link reference .. 
  616. | topic text and link reference .. 
  617. | topic text and link reference .. 
  618. | topic text and link reference .. 
  619. | .END-ENTRY 
  620. | 
  621. | remarks ...
  622. | 
  623. | 
  624. | .ENTRY topic2-name
  625. | [.KEYWORDS keyword1 keyword2 ..]
  626. | [.GROUPS group3 [group2 ..]]
  627. | [.PARAGRAPH [paragraph attributes]]
  628. | topic 2 text and link reference .. 
  629. | topic 2 text and link reference .. 
  630. | topic 2 text and link reference .. 
  631. | [.END-PARAGRAPH]
  632. | additional topic2 text ...
  633. | .END-ENTRY 
  634. |
  635. | .POPUP popup-name
  636. | [.TITLE optional title for popup]
  637. |   definition for some reference
  638. |   ...
  639. | .END-POPUP
  640.  
  641.   As can be seen - lines between the .ENTRY and .END-ENTRY keywords are
  642.  the lines processed by the help compiler, to create the help database, 
  643.  every other line is considered a remark, and is not parsed or evaluated by
  644.  the help compiler.
  645.  
  646.   The topic text and link reference lines are simple text lines, with
  647.  special link marks.
  648.  
  649.   A sample will provide the details :
  650.  
  651. This is a text help line that includes one ~link~link-topic-name~ in it.
  652.  
  653.   This line will be displayed in the help engine program as :
  654.  
  655. This is a text help line that includes one link in it.
  656.  
  657.   The word "link" will be in a different color then the rest of the line, 
  658.  to indicate that this is a link. If the user hi-lights the link, and
  659.  presses Enter (or points the mouse cursor and clicks), the help engine will
  660.  look for a topic called "link-topic-name", and display it.
  661.  
  662.   Browse the HELPDEMO.HDF file for a demo of a help database definition file.
  663.  
  664.  Notes :
  665.  
  666.  1. The keywords .TOPIC and .END-TOPIC can be used instead of .ENTRY and
  667.   .  .END-ENTRY respectively.
  668.  
  669.     An equivalent pair of keywords are .TOP and .ENDTOP .
  670.  
  671.     You can use .EXT-TOPIC instead of .TOPIC/.ENTRY etc.. - topics created
  672.     with that statement are the same as regular topics, only - an external
  673.     reference is created for them to be linked to a pascal/C/C++ program.
  674.  
  675.  2. Keywords are NOT case sensitive. (.topic = .TOPIC = .eNTry)
  676.  
  677.  3. The .TITLE keyword is optional. If no title is defined, the topic name
  678.     is used as a title. The .TITLEATTR keyword is used to describe the
  679.     title text attributes. The syntax is the same as the .PARAGRAPH text
  680.     attributes. Please refer to the Text Attributes section below for further
  681.     discussion of the optional paragraph attributes.
  682.  
  683.  4. If you want the ~ sign to appear in your help database, use ~~ in your
  684.     help source file. (e.g. "This is a ~~" will be "This is a ~" in the final
  685.     help database.).
  686.  
  687.  5. The Optional .PARAGRAPH and .END-PARAGRAPH commands in the help topic text,
  688.     specify the start and the end of a paragraph. This feature is currently 
  689.     supported only for winhelp, RTF and IPF sources. This feature is important if you 
  690.     want to create long paragraphs that will wrap correctly when a user resizes
  691.     the help window. Please refer to the Text Attributes section below for further
  692.     discussion of the optional paragraph attributes.
  693.  
  694.  6. When a .PARAGRAPH is issued, a .END-PARAGRAPH MUST be specified at the
  695.     end of the paragraph. These commands must appear as the first words in
  696.     a line. The text after the .PARAGRAPH command is NOT part of the text 
  697.     of the help topic.
  698.  
  699.  
  700.  7. The optional .KEYWORDS command can appear after the .TITLE command
  701.     (If there is one), or the .TOPIC header (otherwise), Use this command
  702.     to help the user search for sets of topics that are connected to a 
  703.     specific keyword. The syntax of this command is :
  704.     .KEYWORDS keyword-1 keyword-2 ... 
  705.  
  706.  8. .POPUP and .END-POPUP (or .ENDPOP) are used to define popup topics that 
  707.     are displayed on the same screen as the original topic that includes the
  708.     link to them. Popup entries allow the user to consult a glossary, and 
  709.     not lose the topic he was reading. Popups are supported in the winhelp,
  710.     OS/2 IPF, Native PX and Native Mem formats. In the other formats Popups are 
  711.     used as standard topics.
  712.  
  713.  9. In the Text target .POPUP entries will be automatically included in a 
  714.     Glossary file that you can add as an appendix to your documentation.
  715.  
  716. 10. The .GROUPS statement associate a topic with several groups, you can 
  717.     create topics with menus to groups of other topics using the statement
  718.     ".INSERT GROUP group-name" in your topic text. Please refer to the 
  719.     Groups section of this document for additional discussion of this
  720.     function.
  721.  
  722. Additional commands include :
  723.  
  724. | .TEXTCOLOR, .LINKCOLOR and .LINKHIGH - VGA colors of text and links in normal 
  725. and high (selected) states in the native help format.
  726.  
  727. The syntax of these commands is :
  728.  
  729. | .TEXTCOLOR w 
  730.  
  731. or
  732.  
  733. | .LINKCOLOR x
  734.  
  735. or
  736.  
  737. | .LINKHIGH y
  738.  
  739. Where w, x and y are the color of the text/link, which is a combination of the 
  740. color of the foreground with the color of the background multiplied by 16.
  741.  
  742. The colors that can be used for both fore and background are :
  743.  
  744.   Black     = 0
  745.   Blue      = 1
  746.   Green     = 2
  747.   Cyan      = 3
  748.   Red       = 4
  749.   Magenta   = 5
  750.   Brown     = 6
  751.   LightGray = 7
  752.  
  753. The colors that can be used only for the foreground are :
  754.  
  755.   DarkGray     = 8
  756.   LightBlue    = 9
  757.   LightGreen   = 10
  758.   LightCyan    = 11
  759.   LightRed     = 12
  760.   LightMagenta = 13
  761.   Yellow       = 14
  762.   White        = 15
  763.  
  764. For example : to set the normal color of a link to light green on blue, use
  765.  
  766. | .LINKCOLOR 26
  767.  
  768. where 26 = 10 + 16 * 1. (10 = light green, 1 = blue).
  769.  
  770. Creating Multiple Source Projects :
  771.  
  772. Use the .INCLUDE commands in the source of your .HDF file, to include an
  773. additional source file. .INCLUDE is not supported in the middle of a topic.
  774.  
  775. For Example :
  776.  
  777.  .. some stuff 
  778.  
  779. | .include 2ndfile.hdf
  780.  
  781.  .. additional stuff
  782.  
  783. will process 2NDFILE.HDF in the middle of our source file.
  784.  
  785. Please notice - .INCLUDE commands can be nested in your source file,
  786. it is however not recommended to nest them too deep, helpC does not
  787. close the input file when a .INCLUDEd file is processed, in order to
  788. minimize help generation time - there is however, a limit on the number
  789. of open files that can be used by a program - this is a limit set by dos.
  790.  
  791. Use the .INSERT CODE statement to insert target code that will not be 
  792. translated by helpC. helpC will send un-translated code to the output target
  793. until a .END-CODE statement is found.
  794.  
  795. For example - creating a small table in winhelp format :
  796. | .. normal code
  797. | .ifdef windows
  798. | .insert code
  799. | \pard{\tab column1\tab column2\tab column3}\par
  800. | \pard{\par col1data\tab col2data ..}\par
  801. | .end-code
  802. | .endif
  803.  
  804. GUI Font based targets :
  805.  
  806. The .FIXEDFONT command is used to define a non proportional font as the 
  807. default font of the help database. Currently the only targets affected
  808. by this command are windows winHelp v3.x. If you find that your help 
  809. databases are not aligned after they are converted to winHelp format, use 
  810. this command and re-compile. This command has no effect on targets that are 
  811. different from the targets mentioned before.
  812.  
  813. The .PCFONT command is used to define a font that has the standard pc 
  814. character set (Terminal - in windows). If you convert a text based 
  815. database that uses the PC's special characters, use this command to
  816. set the default font. This command has no effect on targets that are 
  817. different from the targets mentioned before.
  818.  
  819. Text targets :
  820.  
  821. The .PAGELENGTH and .PAGEWIDTH statements set the printed page length in
  822. rows, and width in columns. The syntax is .PAGELENGTH xx or .PAGEWIDTH yy .
  823.  
  824. Use the .SETFONT command to change or add fonts to the font palette, The 
  825. syntax is : .SETFONT font-number 'Font-Name-In-The-Target-Language'. If
  826. for example we would like to change font number 3 in the windows target
  827. to be a font X of family Y we would write : 
  828. | .SETFONT 3 'Y X'
  829.  
  830. Use the .TITLEDEFAULTS statement to set the default text attributes of the
  831. topics titles in the help database. These defaults can be over-ridden with
  832. the .TITLEATTR statement in the topic definition. Please refer to the Text
  833. Attributes section below for discussion of paragraph text attributes.
  834.  
  835. Use the .ATTRDEFAULTS statement to set the default text attributes of 
  836. paragraph text in the database. Please refer to the Text Attributes section 
  837. below.
  838.  
  839. Use the .ERRORLEVEL command to set the error level. The syntax is .ERRORLEVEL x
  840. where x is one of the following :
  841.  
  842.       0    No Check  - (Default) - No action is taken.
  843.       1    Trap      - The link is replaced to a special topic named ERROR.
  844.       2    Strip     - The link is replaced by the Text part only.
  845.       3    Delete    - The text and link parts are deleted.
  846.       9    Abort     - helpC will abort with an error message, indicating the 
  847.                        line number.
  848. Please refer to the Exception Handling section below about helpC error
  849. processing.
  850.  
  851. Use the .ALIAS command to substitute a popup/topic name with another name. The
  852. syntax is .ALIAS newname origname. Whenever a newname link is found, the alias
  853. of origname is used. This can be very useful when you want to give multiple
  854. names to a topic, or when HLPDK source is the target of an incremental 
  855. compiler.
  856.  
  857. Related Topics :
  858. Technical Documentation
  859. Conditional Defines
  860. Groups
  861. Text Attributes
  862.  
  863.  
  864. The helpC compiler supports conditional define directives that allow you to
  865. tailor your source according to define symbols that are known to the compiler.
  866.  
  867. You can use the .ifdef, .ifndef, .else and .endif directives to test the
  868. target of your compile and do different things according to this target.
  869.  
  870. If for example you have a Windows bitmap you want to include in your generated
  871. RTF file, when you compile to winhelp format, but, you would like to use a
  872. statement in other targets that do not support graphics, you could do the 
  873. following :
  874.  
  875. | .ifdef windows
  876. |   some text {\bmc mybmp.bmp} some more text
  877. | .else 
  878. |   some text AND STATEMENT HERE some more text
  879. | .endif
  880.  
  881. When the compiler will generate the code, the RTF command \bmc will be 
  882. inserted in the output of the compiler for windows targets (/W30, /W31), 
  883. and a simple text statement will be inserted otherwise.
  884.  
  885. The conditional directives supported are :
  886.  
  887. | .ifdef  SYMBOL - Compile code only if SYMBOL is defined.
  888. | .ifndef SYMBOL - Compile code only if SYMBOL is NOT defined.
  889. | .endif         - Any .ifdef/.ifndef should be terminated by a .endif .
  890. | .else          - Reverse the previous .ifdef/.ifndef
  891.  
  892. The following SYMBOLS are automatically defined by the compiler :
  893.  
  894. Symbol          When Defined
  895. ------          ------------
  896. DEF             /PX+
  897. W31             /W31
  898. W30             /W30
  899. THS             /TH+
  900. QHS             /QH+
  901. TVH             /TV+
  902. PHS             /PH+
  903. DVX             /XD+
  904. MEM             /MT+
  905. OS2             /OS2
  906. TXT             /TXT
  907. WINDOWS         /W30, /W31
  908. THELP           /TH+
  909. QUICKHELP       /QH+
  910. TVHC            /TV+
  911. NATIVEPARADOX   /PX+
  912. POPHELP         /PH+
  913. DESQVIEW/X      /XD+
  914. NATIVEMEMORY    /MT+
  915. VERx.y          When Compiling with helpC Vx.y 
  916. NATIVE          /PX+, /MT+
  917. DOCUMENT        /TXT, /RTF
  918.  
  919. You can define your own conditional defines on the command line using the /D:
  920. switch of helpC.
  921.  
  922. e.g.
  923.  
  924. Source :
  925.  
  926. | ... some text ..
  927. | .ifdef mydef
  928. |   Special Text for mydef situation
  929. | .endif
  930. | ... more text
  931.  
  932. and you compile using HELPC /D:MYDEF the special text will be included.
  933.  
  934. Related Topics :
  935. Technical Documentation
  936. Help Definition
  937.  
  938.  
  939. Topic's text can receive visual attributes such as a font, size, bold, 
  940. italic etc.. by using the paragraph attributes on the .PARAGRAPH (.par)
  941. line. Text attributes are currently supported in the winhelp and rtf targets.
  942.  
  943. The attributes that can be applied to text are :
  944.  
  945. Font            - The font the text will be displayed in.
  946. Bold            - The text is displayed in bold characters.
  947. Italic          - The text is displayed in italic characters.
  948. Underline       - The text is displayed in underline characters.
  949. Size            - The size of the font.
  950. Box             - The paragraph can be contained in a box.
  951. Align           - The paragraph can be alligned.
  952. Color           - The text foreground color.
  953.  
  954. The syntax is :
  955.  
  956. | .PARAGRAPH [attr1 attr1-parameters [attr2 attr2-parameters [..] ]]
  957.  
  958. The allowed parameters to attributes are :
  959.  
  960. 1. FONT font-number-in-font-palette : The font number in the font palette, there
  961. is a standard font palette for winhelp and rtf targets that include the 
  962. following fonts :
  963.  
  964.  0 : Times Roman        (roman Tms Rmn)
  965.  1 : Symbol             (decor Symbol)
  966.  2 : Helvetica          (swiss Helv)
  967.  3 : LinePrinter        (modern LinePrinter)
  968.  4 : Terminal           (roman Terminal)
  969.  5 : Times New Roman    (roman Times New Roman)
  970.  6 : Arial              (swiss Arial)
  971.  7 : CG Times (WN)      (roman CG Times (WN))
  972.  8 : Courier            (modern Courier)
  973.  9 : Modern             (modern Modern)
  974. 10 : Script             (script Script)
  975. 11 : Univers (WN)       (swiss Univers (WN))
  976. 12 : Wingdings          (nil Wingdings)
  977. 13 : MS Sans Serif      (swiss MS Sans Serif)
  978.  
  979. 2. BOLD ON|OFF - Set bold mode to on/off.
  980.  
  981. 3. ITALIC ON|OFF - Set italic mode to on/off.
  982.  
  983. 4. UNDERLINE ON|OFF - Set underline mode on/off.
  984.  
  985. 5. SIZE font-size - Set the size of the font.
  986.  
  987. 6. BOX NONE|NORMAL|THICK|SHADOW|DOUBLE - Print paragraph in a box which has one
  988. of the described borders : NONE is no border at all.
  989.  
  990. 7. ALIGN LEFT|RIGHT|CENTER|JUSTIFY - Print the text in the paragraph aligned
  991. to one of the sides, the center or justified in the paragraph.
  992.  
  993. 8. COLOR color-number-in-color-palette - The numbers are the same numbers used
  994. for dos native systems and described in the help definition format section
  995. above, regarding the .LINKCOLOR, .TEXTCOLOR and .LINKHIGH statements.
  996.  
  997. Example :
  998.  
  999. | .PAR BOX SHADOW FONT 13 BOLD 
  1000. |    ... some text here ..
  1001. | .ENDPAR
  1002.  
  1003. Will display the paragraph in a shadow bordered box, using font 13 in the 
  1004. palette (MS Sans Serif assuming that the original palette is used) with bold
  1005. characters.
  1006.  
  1007. Related Topics :
  1008. Technical Documentation
  1009. Help Definition
  1010.  
  1011.  
  1012. Topics can be associated to groups using the .GROUPS statement in the topic
  1013. heading. Menus to these groups can later be created by using the 
  1014. command .INSERT GROUP group-name in the topic text.
  1015.  
  1016. An example will clarify the use of this function :
  1017.  
  1018. Let us assume that we have a car's collectors database, where the description
  1019. of each car is a topic. We would like to present a hierarchy to the user that
  1020. looks like that : 
  1021.  
  1022. Overview Screen
  1023.    |
  1024.    +--------- Cars by Country
  1025.    |               |
  1026.    |               +------------ U.S.A ... List of cars manufactured in U.S.A
  1027.    |               +------------ U.K.
  1028.    |               +------------ Italy
  1029.    |
  1030.    +--------- Cars by Maker
  1031.    |               |
  1032.    |               +------------ Alfa-Romeo ... List of Alfa-Romeo models
  1033.    |               +------------ GM
  1034.    |               +------------ Mazda
  1035.    |
  1036.    +--------- Cars by type
  1037.                    |
  1038.                    +------------ 4x4 & Jeeps
  1039.                    +------------ Sport Cars
  1040.                    +------------ Family Sedans
  1041.                         
  1042. We will create group references in the topics using the .GROUPS statement,
  1043. The Alfa Romeo Spider 2000 topic will look like :
  1044.  
  1045. | .topic alfa_romeo_spider_2000
  1046. | .title Alfa Romeo Spider 2000
  1047. | .keywords alfa spider convertible sport classic
  1048. | .groups italian alfa sport
  1049. | 
  1050. | The Alfa Romeo ... 
  1051. | 
  1052. | 
  1053. | .end-topic
  1054.  
  1055. The Italian Cars Directory topic will be :
  1056.  
  1057. | .topic italy_directory
  1058. | .title Italian Cars Directory
  1059. | .keywords directory
  1060. | 
  1061. | Cars Manufactured in Italy :
  1062. | 
  1063. | .insert group italian
  1064. | 
  1065. | .end-topic
  1066.  
  1067. If our database includes 3 cars that have a reference to the Italian group
  1068. this will be the equivalent of writing :
  1069.  
  1070. | .topic italy_directory
  1071. | .title Italian Cars Directory
  1072. | .keywords directory
  1073. | 
  1074. | Cars Manufactured in Italy :
  1075. | 
  1076. | ~Alfa Romeo Spider 2000~alfa_romeo_spider_2000~
  1077. | ~Ferrari 308 GTS~Ferrari_308_gts~
  1078. | ~Fiat Uno 70S~fiat_uno_70s~
  1079. | 
  1080. | .end-topic
  1081.  
  1082. Related Topics :
  1083. Technical Documentation
  1084. .HDF Syntax
  1085. Conditional Defines
  1086.  
  1087. helpC provides mechanism to handle link exceptions. An exception is a link
  1088. to an identifier that is not defined as a topic or popup. In order to help
  1089. you find these errors helpC contains the cross reference report that can
  1090. be produced using the /R+ switch. You can browse the HELPC.LST file generated
  1091. by helpC if a cross reference report is generated, and search for the string
  1092. ERROR that describes undefined links.
  1093.  
  1094. helpC provides additional exception handling facilities. When an error is found
  1095. during compile helpC can perform on of the following actions :
  1096.  
  1097. 0: No Check - Default - helpC does not do anything. The link is passed as is to
  1098.               the target. The target help engine/compiler will handle the 
  1099.               exception as it is implemented.
  1100.  
  1101. 1: Trap     - helpC will replace the link key with the key ERROR. It is the 
  1102.               responsibility of the help database author to provide such a
  1103.               topic/popup.
  1104.  
  1105. 2: Strip    - helpC will pass the text of the link to the target with no link
  1106.               support. The text will appear as normal text.
  1107.  
  1108. 3: Delete   - Both the text and the link will be deleted and will not appear in
  1109.               the target.
  1110.  
  1111. 9: Abort    - helpC will abort, with an error message, and the line the link 
  1112.               is defined. This mode is recommended when you are debugging 
  1113.               your help database.
  1114.  
  1115. You can set the error level using the following techniques :
  1116.  
  1117. - Use the /EL=x switch on the helpC command line.
  1118.  
  1119. - Use the .ERRORLEVEL x .HDF statement.
  1120.  
  1121. Important Points :
  1122.  
  1123. 1. When errorLevel = 0 (default) no topic database is created during pass 1,
  1124. if you set .errorlevel somewhere in your source, after some topics/popups
  1125. have been defined, these topics will not be in the symbol table created by
  1126. helpC and will be considered an exception!.
  1127.  
  1128. Related Topics :
  1129. Technical Documentation
  1130. .HDF Syntax
  1131. Help Compiler
  1132.  
  1133.  
  1134.   The topic index table format is as follows :
  1135.  
  1136.   TOPIC     - 40 characters string key - this is the topic "name".
  1137.   FILENAME  - 38 characters string field - includes the name of the
  1138.               help raw data file. (Notice - V1.0 ignores the value of this 
  1139.               field, it is here for future expansion).
  1140.   START     - longint (long) field that contains the offset from the data file
  1141.               start, to the start of the topics text data, in bytes.
  1142.   LEN       - longint (long) field that contains the length (in bytes) of the 
  1143.               text data of the topic.
  1144.   TITLE     - 70 characters string key - the title of the topic.
  1145.   TTYPE     - 1 character - topic type. Currently supported types are :
  1146.               'T' = Topic.
  1147.               'P' = Popup.
  1148.  
  1149. Related Topics :
  1150. Technical Documentation
  1151. Links Index Format
  1152. Keywords Index Format
  1153. Set File Format
  1154.  
  1155.   The links index table format is as follows :
  1156.  
  1157.   TOPIC     - 40 characters string key - the name of the topic that 
  1158.               has the link.
  1159.   SEQ       - integer (int) key - contains the sequential number of 
  1160.               the link in the topic. (This way you can assign the links
  1161.               order in the topic).
  1162.   LINK      - 40 characters string key - the name of the link topic to
  1163.               display if the link is chosen.
  1164.   LINE      - integer (int) field - the line (from the start of the topic) 
  1165.               this link is displayed on.
  1166.   COL       - integer (int) field - the column this link is displayed on.
  1167.   TXT       - 70 characters string field - the text to display on the line.
  1168.  
  1169. Related Topics :
  1170. Technical Documentation
  1171. Topic Index Format
  1172. Keywords Index Format
  1173. Set File Format
  1174.  
  1175.   The set file is a text file that contains one entry in each line, using
  1176.  the following format :
  1177.  
  1178. help-database-engine
  1179. version-of-generating-compiler
  1180. topic-index-table name
  1181. links-index-table name
  1182. keywords-index-table name
  1183. help-raw-data-file name
  1184. number-of-topics
  1185. length-of-file
  1186. link-normal-color
  1187. link-high-color
  1188. text-normal-color
  1189.  
  1190. The help-database-engine values available today are DEF=Paradox and 
  1191. MEM=memory Tables.
  1192.  
  1193. Related Topics:
  1194. Technical Documentation
  1195. Topic Index Format
  1196. Links Index Format
  1197. Keywords Index Format
  1198.  
  1199.   The keywords index table format is as follows :
  1200.  
  1201.   KEYWORD   - 40 characters string key - the keyword.
  1202.   TOPIC     - 40 characters string key - the topic name that this keyword is 
  1203.               assigned to.
  1204.  
  1205.   Notice - the database will include a row for each keyword, that has the 
  1206.   TOPIC field blank. This is used to display the first list of keywords, that
  1207.   if chosen, will display the 2nd list of topics that have the chosen keyword
  1208.   in their .KEYWORDS definition.
  1209.  
  1210. Related Topics:
  1211. Technical Documentation
  1212. Topic Index Format
  1213. Links Index Format
  1214. Set File Format
  1215.  
  1216. The following products/packages provide additional HLPDK functionality :
  1217.  
  1218. 1. Name         : IL2HDK - Interrupt List (Ralf Brown) 2 HLPDK convert program. 
  1219.    Version      : 2.2
  1220.    Availability : IL2HDK22.ZIP.
  1221.    Status       : Free. 
  1222.    Author       : Ron Loewy.
  1223.  
  1224. 2. Name         : HPCHDK - HelpPC 2 HLPDK convert program.
  1225.    Version      : 1.0
  1226.    Availability : HPCHDK10.ZIP.
  1227.    Status       : Free.
  1228.    Author       : Yaniv Golan (s2942275@tech02.technion.ac.il)
  1229.  
  1230. 3. Name         : SCANHELP - Turbo Pascal Scanner to help.
  1231.    Version      : 3.01
  1232.    Availability : ? (Contact Author)
  1233.    Status       : Shareware.
  1234.    Author       : Duncan J. Murdoch (dmurdoch@mast.QueensU.CA)
  1235.  
  1236. 4. Name         : NG2HDK - Norton Guides 2 HLPDK convert program.
  1237.    Version      : 1.0
  1238.    Availability : NG2HDK10.ZIP
  1239.    Status       : Free.
  1240.    Author       : Ron Loewy.
  1241.  
  1242. 5. Name         : NEWSDB - News Clips Hypertext system.
  1243.    Version      : Beta.
  1244.    Availability : Not in GA yet. (I hope it will be around in Oct.).
  1245.    Status       : To Be Determined.
  1246.    Author       : Ron Loewy.
  1247.  
  1248. 6. Name         : POPHDK - POPHELP 2 HLPDK convert program.
  1249.    Version      : 1.0
  1250.    Availability : POPHDK10.ZIP.
  1251.    Status       : Free.
  1252.    Author       : Yaniv Golan (s2942275@tech02.technion.ac.il)
  1253.  
  1254. 7. Name         : JARG2HDK - Jargon File to HLPDK convert program.
  1255.    Version      : 1.0
  1256.    Availability : ? (Contact Author)
  1257.    Status       : ?
  1258.    Author       : Slren Pingel Dalsgaard (pingel@daimi.aau.dk)
  1259.  
  1260.  
  1261.