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