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