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