home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / CLIPPER / MISC / HLPDK50.ZIP / HLPDK.HDF < prev    next >
Encoding:
Text File  |  1993-05-28  |  30.1 KB  |  883 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. ;                                 .fixedFont                                  *
  11. ; use a fixed font for Windows target ..                                      *
  12. ;******************************************************************************
  13. .fixedFont
  14.  
  15. ;******************************************************************************
  16. ;                                  overview                                   *
  17. ; notice - a .top = .topic = .entry                                           *
  18. ;******************************************************************************
  19. .top overview
  20. .title HLPDK System Overview
  21.  
  22.  ****************************************************************************
  23.  *                                                                          *
  24.  *                                 ISoft D&M                                *
  25.  *                                 POB. 5517                                *
  26.  *                           Coralville IA 52241                            *
  27.  *                                   U.S.A                                  *
  28.  *                                                                          *
  29.  **************************************************************************** 
  30.  
  31. .par
  32. The Help Engine Development Kit is a system that allows you to create 
  33. hyper-text database help systems with topics and hot links, using a simple
  34. text editor and the help compiler. 
  35. .endpar
  36.  
  37. .par
  38. The help databases can be distributed (free of charge) with the HELPENG or
  39. HE help engine display programs. 
  40. .endpar
  41.  
  42. .par
  43. The help database format is release to the public domain, if you own the 
  44. Paradox Engine you can use the help databases with your own programs. 
  45. .endpar
  46.  
  47. .par
  48. Borland Pascal Users can purchase the Help Engine Source Code even
  49. for Applications that do not use the paradox engine, using the Native Mem
  50. format.
  51. .endpar
  52.  
  53. .par
  54. The helpC compiler that is part of this development kit includes the
  55. ability to create Windows Help source files from the same source the 
  56. dos help sources are created!. Write your help once, and create help
  57. databases for Dos, Windows and DESQview/X !
  58. .endpar
  59.  
  60.         Supported Formats :
  61.  
  62.         Native(PX), Native (Mem), Win30, Win31, QuickHelp, 
  63.         THELP, TVHC, POPHELP, DESQview/X
  64.  
  65. .par
  66. Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  67. Turbo Pascal programs, and use the help engine window in your pascal
  68. programs.
  69. .endpar
  70.  
  71. Related Topics :
  72. ~Registration~register~
  73. ~Contact~contact~
  74. ~File List~fileList~
  75. ~Credits~credits~
  76. ~Help Engine~helpeng~
  77. ~Help Compiler~helpC~
  78. ~Quick Start~quickStart~
  79.  
  80. .endtop
  81.  
  82. ;******************************************************************************
  83. ;                                  register                                   *
  84. ;******************************************************************************
  85. .entry register
  86. .title Registration
  87.  
  88. .par
  89. The Help Engine Development Kit (HLPDK) is a shareware product, 
  90. if you find this product valuable, please register it. 
  91. This section describes the reasons you should register.
  92. .endpar
  93.  
  94. .par
  95. By registering you will receive a complete discussion
  96. of the help engine features, and many examples of usage. You will receive a 
  97. diskette with the latest HLPDK version, and DPMI (dos protected mode)
  98. versions of the help compiler and engines!.(The memory version of the
  99. help engine can display huge databases only in the protected mode
  100. version).
  101. .endpar
  102.  
  103. .par
  104. Your registration will help us to create the next versions of HLPDK, that
  105. will include more options, and features, some of them might even be your
  106. enhancement requests!.
  107. .endpar
  108.  
  109. .par
  110. A point to consider - If you want to create Windows Help source files,
  111. you will have to purchase a word processor that can output RTF files,
  112. the WORD for Windows 2.0 package, for example, is listed at around $500!.
  113. .endpar
  114.  
  115. Related Topics :
  116. ~Contact~contact~
  117. ~Overview~overview~
  118. .end-entry
  119.  
  120. ;******************************************************************************
  121. ;                                   Contact                                   *
  122. ;******************************************************************************
  123. .entry Contact
  124.  
  125.   Please contact :
  126.  
  127.   ISoft D&M,  
  128.   P.O.B 5517
  129.   Coralville IA 52241,
  130.   U.S.A
  131.  
  132.   To contact the author directly : 
  133.  
  134.   Contact :     Loewy Ron,
  135.                 9 Haneveem st.
  136.                 Herzeliya, 46465
  137.                 ISRAEL.
  138.  
  139.   e-mail address : CompuServe - 100274,162
  140.  
  141. Related Topics :
  142. ~Regsiteration~register~
  143. ~Overview~overview~
  144. .end-entry
  145.  
  146. ;******************************************************************************
  147. ;                                  fileList                                   *
  148. ;******************************************************************************
  149. .entry fileList
  150. .title HPLDK Distribution File List
  151.  
  152. This package contains the following files :
  153.  
  154.  HELPENG.EXE    - Help Engine.
  155.  HELPC.EXE      - Help Compiler.
  156.  HE.EXE         - Mem Help Engine.
  157.  HLPDK.DOC      - This file.
  158.  HELPC.DOC      - Help Compiler documentation
  159.  HELPDEMO.HDF   - Demo Help Project.
  160.  2NDDEMO.HDF    - Demo Help Project - file 2.
  161.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  162.  HLPDK.REG      - Registration file.
  163.  HLPDK.HDF      - Help Development Kit hypertext help database source.
  164.  HLPDK.HDT      - Help Development Kit help database file.
  165.  HLPDK.SET      - Help Development Kit help database file.
  166.  HLPDKTOP.*     - Help Development Kit help database files.
  167.  HLPDKLNK.*     - Help Development Kit help database files.
  168.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  169.  
  170. Related Topics :
  171. ~Overview~overview~
  172. ~Quick Start~quickStart~
  173. .end-entry
  174.  
  175. ;******************************************************************************
  176. ;                                   Credits                                   *
  177. ;******************************************************************************
  178. .entry Credits
  179.  
  180. .par
  181. HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  182. Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. 
  183. (Trademarks of Borland International).
  184. .endpar
  185.  
  186. .par
  187. Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  188. of Microsoft Corp.
  189. .endpar
  190.  
  191. .par
  192. The HELPENG program was written using the WINTEXT UI library, 
  193. (c) 1991,93 Loewy Ron.
  194. .endpar
  195.  
  196. THELP, HL and TVHC are Trademarks or copyrights Borland International.
  197.  
  198. POPHELP is a copyright of TurboPower Software.
  199.  
  200. TVHC support, and other ideas were suggested by MunLeong Chan.
  201.  
  202. .par
  203. Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen
  204. CASE code generators.
  205. .endpar
  206.  
  207. .par
  208. Parts of the Help Compiler were generated using Ron Loewy's dbGen database 
  209. code generator.
  210. .endpar
  211.  
  212. Yaniv Golan helped me with beta-testing, debugging and suggestions.
  213.  
  214. .par
  215. John Murphy notified me of the paragraph formtting difficulties that
  216. lead to the .PARAGRAPH .END-PARAGRAPH formatting capabilities.
  217. .endpar
  218.  
  219. DESQview/X is a trademark of Quarterdeck Office Systems.
  220.  
  221. .par
  222. MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his
  223. excelent documentation of DESQview/X help format to generate code
  224. to this environment.
  225. .endpar
  226.  
  227. .par
  228. The HC31 problem with characters with ordinal values biggen than 127
  229. was solved thanks to Mr. Lars Fosdal of Norway.
  230. .endpar
  231.  
  232. Related Topics :
  233. ~Overview~overview~
  234. .end-entry
  235.  
  236. ;******************************************************************************
  237. ;                                 quickStart                                  *
  238. ;******************************************************************************
  239. .entry quickStart
  240. .title Quick Start
  241.  
  242. From the command line enter HELPC HELPDEMO to compile the demo help database.
  243.  
  244. .par
  245. After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  246. demo help database.
  247. .endpar
  248.  
  249. If you want to compile for windows :
  250.  
  251. from the command line enter HELPC HELPDEMO /W31
  252. and after that HC31 HELPDEMO
  253. (HC31 is the Microsoft Help Compiler)
  254. .par
  255. from windows, open the HELPDEMO.HLP file from the windows help engine.
  256. (Notice - if you do not have the HC help compiler from windows, we have
  257. included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  258. able to feel the quality of the output that can be generated, and decide
  259. if you want to purchase the HC31 program (Included with the SDK, BC++, 
  260. TPW, BP and probably some other packages), or download it from one of the
  261. sites Microsoft had uploaded it to).
  262. .endpar
  263.  
  264. .par
  265. If you use windows 3.0, or want your help file to be compatible with
  266. winHelp 3.0 use :
  267. .endpar
  268.         HELPC /W30 HELPDEMO
  269.         HC HELPDEMO
  270.  
  271. To compile for THELP use : 
  272.         HELPC /TH+ HELPDEMO
  273.         HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
  274.  
  275. To compile for QuickHelp : 
  276.         HELPC /QH+ HELPDEMO
  277.         HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
  278.  
  279. To compile for TVHC :
  280.         HELPC /TV+ HELPDEMO
  281.         TVHC HELPDEMO.TXT
  282.  
  283. To compile for POPHELP :
  284.         HELPC /PH+ HELPDEMO
  285.         MAKEHELP /Q HELPDEMO
  286.  
  287. To compile for DESQview/X :
  288.         HELPC /XD+ HELPDEMO
  289.         MDVXHELP HELPDEMO.HLP @HELPDEMO.LST
  290.         COPY HELPDEMO.HLP d:\DVX\HELP
  291.  
  292. To compile for Native Mem Format :
  293.        HELPC /MT+ HELPDEMO
  294. (Use HE HELPDEMO to view that database).
  295.  
  296. Related Topics :
  297. ~Overview~overview~
  298. ~File List~filelist~
  299. .end-entry
  300.  
  301. ;******************************************************************************
  302. ;                                   helpeng                                   *
  303. ;******************************************************************************
  304. .entry helpeng
  305. .title The Help Engine
  306.  
  307. .par
  308. To start the help engine program enter HELPENG on the command line, and 
  309. choose the help database you want to view from the list box. Use the Tab key
  310. to cycle between hot-link words, and press Enter to go to that link.
  311. .endpar
  312.  
  313. .par
  314. If you know the name of the SET file of the database you want to activate, you
  315. can enter it on the command line, and the help engine will display it.
  316. .endpar
  317.  
  318. .par
  319. If you have a mouse, you can use it to point at the hi-lighted links, and 
  320. activate them by pressing the left mouse button.
  321. .endpar
  322.  
  323. .par
  324. Press the ALT-T key combination to choose from a list of TOPICS in the 
  325. database, Press ALT-B to go back to the previous displayed TOPIC, Press
  326. ALT-X to exit the help engine.
  327. .endpar
  328.  
  329. The exit command can be given by pressing the right mouse button.
  330.  
  331. .par
  332. Use F10 to open the menubar, and use the arrow keys to navigate the 
  333. options. When you find the option you are interested in, Use the Enter
  334. key to execute it, or the Esc key to cancel. The menubar can be navigated
  335. using the mouse as well.
  336. .endpar
  337.  
  338. .par
  339. To create a new help database please refer to the ~HELPC~helpc~ documentation
  340. file.
  341. .endpar
  342.  
  343. .par
  344. If you want to use the Native Mem Format Databases, Please use the supplied
  345. HE.EXE program. 
  346. .endpar
  347.  
  348. Related Topics :
  349.  
  350. ~Trouble Shooting~Trouble~
  351. ~Overview~overview~
  352. .end-entry
  353.  
  354. ;******************************************************************************
  355. ;                                   Trouble                                   *
  356. ;******************************************************************************
  357. .entry Trouble
  358. .title Trouble Shooting
  359.  
  360. .par
  361. If you receive some kind of an error message while using the help development
  362. kit please refer to this section.
  363. .endpar
  364.  
  365. tableOps: xxxx error message :
  366. .par
  367. This message is generated by the Paradox Engine if an internal error occurs,
  368. if you receive a message that is not understood (e.g. Table is busy), 
  369. please try one of the following :
  370. .endpar
  371.  1. Try running the Help Compiler or the Help Engine with another input and 
  372.     notice if the problem exists, if it does, turn to the next entry,
  373.     otherwise try to see what the difference between the inputs is.
  374.  2. Check your free memory, try to move some TSR's from memory, or use the
  375.     protected mode compiler/engine available with the registered version.
  376.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE
  377.     with programs that use the Paradox Engine. If you receive a table busy
  378.     error, try to see if you have another program that uses the same table 
  379.     in another session (Windows/DESQview etc..).
  380.  4. PANIC - Please contact the distibuter/author for additional help.
  381.  
  382. Microsoft's HC31 help compiler will generate a error in RTF file error :
  383.  
  384.  1. Re-compile using HELPC 4.0+. This should solve the problem, if the problem
  385.     still exists - please try steps 2 and 3, and notify the author. 
  386.  2. Use a binary disk editor to look at the character at the position x - 1
  387.     in the RTF file (where x is the error position reported by HC31).
  388.  3. Try to replace that charqacter from a special PC oem character to a 
  389.     "standard" ascii character (such as *). If the problem still occurs,
  390.     please contact ISoft D&M/The author, otherwise - you probably came 
  391.     accross a character that HC31 can not handle. In that case - try using
  392.     HC300b (the one that generates winHelp 3.0 format), or delete these 
  393.     characters from your source HDF file.
  394.  
  395. Borland's HL help linker will generate a FE02: Out Of Memory error :
  396.  1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the
  397.     screen's definitions.
  398.  
  399. Borland's HL help linker will complain about undefined context numbers :
  400.  1. You probably have a contents.h file in the current directory, that hl
  401.     tries to use to bind the help topics to Borland's IDE on-line help,
  402.     try renaming this file, and re-compile with HL.
  403.  
  404. HelpC will not create the database when compiling to Native Mem (/MT+) :
  405.  1. Try compiling with report generation on (/R+) to Native Paradox
  406.     (/PX+) format. If there are errors, consult the HELPC.LST file, fix 
  407.     them, and re-try.
  408.  2. If the database is BIG, you might not have enough memory - Remember that
  409.     Native Mem tables are generated in memory. You will have to use the
  410.     HelpCX protected mode compiler (Available with the registered version).
  411.  
  412. .par
  413. HelpEng/HE will complain on an old-database when tring to open a help
  414. database with it :
  415. .endpar
  416.  1. Re-Compile the database using helpC.
  417.  
  418. .par
  419. HelpEng/HE will complain on un-supported database format, when trying to
  420. open a database :
  421. .endpar
  422.  1. HelpEng can not display Native Mem databases, and HE can not display
  423.     Native PX databases. Use the other help engine supplied.
  424.  
  425. HE will not be able to open a Native Mem database :
  426.  1. Use the protected mode HEX help engine. (Available for registered users).
  427.  
  428. .par
  429. We have encountered some users that ran into problems, because they did 
  430. not use the dos SHARE program. We advise that you will always load the 
  431. SHARE program in your AUTOEXEC.BAT file.
  432. .endpar
  433.  
  434. Related Topics :
  435. ~Overview~overview~
  436. ~Help Engine~helpeng~
  437. ~Help Compiler~helpC~
  438. .end-entry
  439.  
  440. ;******************************************************************************
  441. ;                                    helpC                                    *
  442. ;******************************************************************************
  443. .entry helpC
  444. .title Help Compiler
  445. .par
  446. The HELPC help compiler is a dos command line program that receives a 
  447. help definition file (.HDF) and produce a help database. 
  448. .endpar
  449.  
  450.   The helpC command line is :
  451.  
  452.  HELPC source.fil [/Htopic-table-name] [/Llink-table-name] [/Ddata-file-name] 
  453.                   [/R-]  [/ST-] [/CS+] [/EP+]
  454.                   [/W+]  [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+] [/XD+]
  455.                   [/PX+] [/MT+]
  456. .par
  457. The output of the compiler is a set data file called source.SET, that
  458. includes the names of the other help database components. 
  459. .endpar
  460.  
  461. .par
  462. Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler 
  463. will generate a .HPJ and .RTF files that can be used with the Microsoft 
  464. HC (v3.00b) or HC31 help compiler, and output a .HLP windows help file!. 
  465. .endpar
  466.  
  467. .par
  468. By default the help compiler produces a help cross reference report on the 
  469. topics/links used in the database, if the /R- switch is set, no cross-ref
  470. report will be generated, and no database integrity indicators will be
  471. given.
  472. .endpar
  473.  
  474.  
  475. .par
  476. IMPORTANT - Scan the output cross reference report for links defined, that
  477. are not defined as topics!
  478. .endpar
  479.  
  480. .par
  481. Notice - An additional switch is available that instructs the help compiler
  482. to indicate it's parse and code generation progress. Use the /EP+ switch to
  483. see that the helpC compiler is active. Please understand that the compile
  484. process can take a long time, on complex help databases. This switch does
  485. nothing more that ensure to you that the help compiler is alive. 
  486. .endpar
  487.  
  488. .par
  489. The /ST switch defines if the topic name defined in the .TOPIC command
  490. can include embeded spaces. By default this switch is set to /ST- (No
  491. embedded spaces).
  492. .endpar
  493.  
  494. .par
  495. The /CS switch turns Topics and Links case sensativity to ON. Use this
  496. switch with care - Only if you must have a lower/mixed case index in THELP
  497. or POPHELP use this switch. Notice that help databases that compile fine
  498. with case sensativity set to off, might fail to do so in case sensativity
  499. on. By deafult this switch is set to off (-).
  500. .endpar
  501.  
  502. .par
  503. The /XD switch generates code to the MDVXHELP help compiler, available
  504. free in the file DVXHLP10.ZIP on the internet. When this switch is given,
  505. a set of cover and section files is generated, as well as a response
  506. file that should be used to compile the help database.
  507. .endpar
  508.  
  509. Related Topics :
  510. ~Overview~overview~
  511. ~Command Line~commandline~
  512. ~Help Engine~helpeng~
  513. ~Technical Documentation~techdoc~
  514. .end-entry
  515.  
  516. ;******************************************************************************
  517. ;                                 commandline                                 *
  518. ;******************************************************************************
  519. .topic commandline
  520. .title Command Line
  521.  
  522. .par
  523. The compiler switches are defined on the command line. These switches can
  524. be placed before and after the source file name. The compiler will look for
  525. a file named HELPC.CFG in the current directory, and process it before any
  526. command line switches are processed. 
  527. .endpar
  528.  
  529. .par
  530. Switches on the command line will over-ride switches set before them, on the
  531. command line or in one of the response options file.
  532. .endpar
  533.  
  534. Response option files can be specified by prefixing their name with a @ sign.
  535.  
  536.  
  537.  Examples :
  538.  
  539.  If our HELPC.CFG file, in the current directory is :
  540.  
  541. /W31
  542. /R-
  543.  
  544.  And we compile using HELPC HELPDEMO
  545.  
  546.  The helpdemo.hdf file will be compiled, with the target set to winhelp 3.1
  547.  and no cross-reference report.
  548.  
  549.  Compile using HELPC HELPDEMO /r+
  550.  
  551.  Will create winhelp 3.1 sources, but a report will be generated.
  552.  
  553.  Compile using HELPC /w- HELPDEMO
  554.  
  555.  Will generate native format help database, no report is generated.
  556.  
  557.  If we have a file called MYSWITCH.CFG with the following lines :
  558.  
  559. /TH+
  560. /ST-
  561. /CS+
  562.  
  563.  And we compile using HELPC @MYSWITCH.CFG HELPDEMO
  564.  
  565.  A THELP source, using Long Topic Names, with case sensativity will be 
  566.  generated, no cross reference report is generated. (HELPC.CFG contains /r-)
  567.  
  568.  
  569. .end-topic
  570.  
  571. ;******************************************************************************
  572. ;                                   techDoc                                   *
  573. ;******************************************************************************
  574. .entry techDoc
  575. .title Technical Documentation
  576.  
  577. .par
  578. The Help Engine database is a combination of text that is read by the user,
  579. and a Topic and Links database that allows the user to view the topics
  580. he is interested in, using hyper-text methods.
  581. .endpar
  582.  
  583.  
  584.   Each help database is built of 4 file components : 
  585.  
  586.  1. Help Data File    - this file contains the raw text data.
  587.  2. Topic Index File  - a database table that contains the topic names, and
  588.                         the references to the topics in the Data File.
  589.  3. Links Index File  - a database table that contains the list of links 
  590.                         defined for each topic, and positional data.
  591.  4. Set Data File     - a database configuration file that contains the
  592.                         names of the 3 components defined above, and some 
  593.                         additional information.
  594.  
  595. .par
  596. Version 1.x is the bare-bones version that includes only the basic
  597. operations needed from a hyper-text database, this version is implemented
  598. using the Paradox Engine V3.0 to manage the Topic and Link index tables.
  599. .endpar
  600.  
  601. .par
  602. Version 2.x has a new field in the topic table - the title field, help
  603. databases that were compiled with V1.x will not be executed by version
  604. 2.x, they will have to be re-compiled!.
  605. .endpar
  606.  
  607. .par
  608. Version 3.x fields have different length - the databases have to be 
  609. re-compiled.
  610. .endpar
  611.  
  612. .par
  613. Version 5.0+ has a new entry in the help set file, database have to be
  614. re-compiled, ot the value 128 should be added in the last line of the help
  615. set file, and the version number should be changed to 5.0.
  616. .endpar
  617.  
  618. .par
  619. The format of the help database is released to the public domain, if
  620. you implement a database viewer on this database structure, I would be
  621. happy to receive a copy ..
  622. .endpar
  623.  
  624. Related Topics :
  625. ~Help Compiler~helpC~
  626. ~Help Engine~HelpEng~
  627. ~Help Definition Format~hdf~
  628. ~Topic Index Format~tif~
  629. ~Links Index Format~lif~
  630. ~Set File Format~sff~
  631.  
  632. .end-entry
  633.  
  634. ;******************************************************************************
  635. ;                                     hdf                                     *
  636. ;******************************************************************************
  637. .entry hdf
  638. .title Help Definition Format
  639.  
  640.   The help definition file format is as follows :
  641.  
  642. | remarks ...
  643. | remarks ...
  644. | 
  645. | .ENTRY topic-name
  646. | [.TITLE optional title for topic]
  647. | topic text and link reference .. 
  648. | topic text and link reference .. 
  649. | topic text and link reference .. 
  650. | topic text and link reference .. 
  651. | .END-ENTRY 
  652. | 
  653. | remarks ...
  654. | 
  655. | 
  656. | .ENTRY topic2-name
  657. | [.PARAGRAPH]
  658. | topic 2 text and link reference .. 
  659. | topic 2 text and link reference .. 
  660. | topic 2 text and link reference .. 
  661. | [.END-PARAGRAPH]
  662. | additional topic2 text ...
  663. | .END-ENTRY 
  664.  
  665.  
  666.   As can be seen - lines between the .ENTRY and .END-ENTRY keywords are
  667.  the lines processed by the help compiler, to create the help database, 
  668.  every other line is considered a remark, and is not parsed or evaluated by
  669.  the help compiler.
  670.  
  671.   The topic text and link reference lines are simple text lines, with
  672.  special link marks.
  673.  
  674.   A sample will provide the details :
  675.  
  676. This is a text help line that includes one ~~link~~link-topic-name~~ in it.
  677.  
  678.   This line will be displayed in the help engine program as :
  679.  
  680. This is a text help line that includes one link in it.
  681.  
  682.   The word "link" will be in a different color then the rest of the line, 
  683.  to indicate that this is a link. If the user hi-lights the link, and
  684.  presses Enter (or points the mouse cursor and clicks), the help engine will
  685.  look for a topic called "link-topic-name", and display it.
  686.  
  687.   Browse the HELPDEMO.HDF file for a demo of a help database definition file.
  688.  
  689.  Notes :
  690.  
  691.  1. The keywords .TOPIC and .END-TOPIC can be used instead of .ENTRY and
  692.   .  .END-ENTRY respectivly.
  693.  
  694.  2. Keywords are NOT case sensitive. (.topic = .TOPIC = .eNTry)
  695.  
  696.  3. The .TITLE keyword is optional. If no title is defined, the topic name
  697.     is used as a title. (just like in v1.x). 
  698.  
  699.  4. If you want the ~~ sign to appear in your help database, use ~~~~ in your
  700.     help source file. (e.g. "This is a ~~~~" will be "This is a ~~" in the final
  701.     help database.).
  702.  
  703.  5. The Optional .PARAGRAPH and .END-PARAGRAPH commands in the help topic text,
  704.     specify the start and the end of a paragraph. This feature is currently 
  705.     supported only for winhelp sources. This feature is important if you 
  706.     want to create long paragraphs that will wrap correctly when a user resizes
  707.     the help window. It is advized ALWAYS to use this feature for paragraphs,
  708.     future versions of the Help Development Kit will allow greater formatting
  709.     control over paragraphs using this mechanism.
  710.  
  711.  6. When a .PARAGRAPH is issued, a .END-PARAGRAPH MUST be specified at the
  712.     end of the paragraph. These commands must appear as the first words in
  713.     a line. The text after the .PARAGRAPH command is NOT part of the text 
  714.     of the help topic.
  715.  
  716. Additional commands include :
  717.  
  718. | .TEXTCOLOR, .LINKCOLOR and .LINKHIGH - VGA colors of text and links in normal 
  719. and high (selected) states in the native help format.
  720.  
  721. The syntax of these commands is :
  722.  
  723. | .TEXTCOLOR w 
  724.  
  725. or
  726.  
  727. | .LINKCOLOR x
  728.  
  729. or
  730.  
  731. | .LINKHIGH y
  732.  
  733. Where w, x and y are the color of the text/link, which is a combination of the 
  734. color of the foreground with the color of the background multiplied by 16.
  735.  
  736. The colors that can be used for both fore and background are :
  737.  
  738.   Black     = 0
  739.   Blue      = 1
  740.   Green     = 2
  741.   Cyan      = 3
  742.   Red       = 4
  743.   Magenta   = 5
  744.   Brown     = 6
  745.   LightGray = 7
  746.  
  747. The colors that can be used only for the foreground are :
  748.  
  749.   DarkGray     = 8
  750.   LightBlue    = 9
  751.   LightGreen   = 10
  752.   LightCyan    = 11
  753.   LightRed     = 12
  754.   LightMagenta = 13
  755.   Yellow       = 14
  756.   White        = 15
  757.  
  758. For example : to set the normal color of a link to light green on blue, use
  759.  
  760. | .LINKCOLOR 26
  761.  
  762. where 26 = 10 + 16 * 1. (10 = light green, 1 = blue).
  763.  
  764. Creating Multiple Source Projects :
  765.  
  766. Use the .INCLUDE commands in the source of your .HDF file, to include an
  767. additional source file.
  768.  
  769. For Example :
  770.  
  771.  .. some stuff 
  772.  
  773. | .include 2ndfile.hdf
  774.  
  775.  .. additional stuff
  776.  
  777. will process 2NDFILE.HDF in the middle of our source file.
  778.  
  779. Please notice - .INCLUDE commands can be nested in your source file,
  780. it is however not recommended to nest them too deep, helpC does not
  781. close the input file when a .INCLUDEd file is processed, in order to
  782. minimize help generation time - there is however, a limit on the number
  783. of open files that can be used by a program - this is a limit set by dos.
  784.  
  785. GUI Font based targets :
  786.  
  787. The .FIXEDFONT command is used to define a non proportional font as the 
  788. default font of the help database. Currently the only targets affected
  789. by this command are windows winHelp v3.x. If you find that your help 
  790. databases are not aligned after they are converted to winHelp format, use 
  791. this command and re-compile. This command has no effect on targets that are 
  792. different from the targets mentioned before.
  793.  
  794. The .PCFONT command is used to define a font that has the standard pc 
  795. character set (Terminal - in windows). If you convert a text based 
  796. database that uses the PC's special characters, use this command to
  797. set the default font. This command has no effect on targets that are 
  798. different from the targets mentioned before.
  799.  
  800. Related Topics :
  801. ~Technical Documentation~TechDoc~
  802.  
  803. .end-entry
  804.  
  805. ;******************************************************************************
  806. ;                                     tif                                     *
  807. ;******************************************************************************
  808. .entry tif
  809. .title Topic Index Format
  810.  
  811.   The topic index table format is as follows :
  812.  
  813.   TOPIC     - 40 charcters string key - this is the topic "name".
  814.   FILENAME  - 38 characters string field - includes the name of the
  815.               help raw data file. (Notice - V1.0 ignores the value of this 
  816.               field, it is here for future expansion).
  817.   START     - longint (long) field that contains the offset from the data file
  818.               start, to the start of the topics text data, in bytes.
  819.   LEN       - integer (int) field that contains the length (in bytes) of the 
  820.               text data of the topic.
  821.   TITLE     - 50 characters string key - the title of the topic.
  822.  
  823. Related Topics :
  824. ~Technical Documentation~TechDoc~
  825. ~Links Index Format~lif~
  826. .end-entry
  827.  
  828. ;******************************************************************************
  829. ;                                     lif                                     *
  830. ;******************************************************************************
  831. .entry lif
  832. .title Links Index Format
  833.  
  834.   The links index table format is as follows :
  835.  
  836.   TOPIC     - 40 characters string key - the name of the topic that 
  837.               has the link.
  838.   SEQ       - integer (int) key - contains the sequential number of 
  839.               the link in the topic. (This way you can assign the links
  840.               order in the topic).
  841.   LINK      - 40 characters string key - the name of the link topic to
  842.               display if the link is chosen.
  843.   LINE      - integer (int) field - the line (from the start of the topic) 
  844.               this link is displayed on.
  845.   COL       - integer (int) field - the column this link is displayed on.
  846.   TXT       - 60 characters string field - the text to display on the line.
  847.  
  848. Related Topics :
  849. ~Technical Documentation~TechDoc~
  850. ~Topic Index Format~tif~
  851. .end-entry
  852.  
  853. ;******************************************************************************
  854. ;                                     sff                                     *
  855. ;******************************************************************************
  856. .entry sff
  857. .title Set File Format
  858.  
  859.   The set file is a text file that contains one entry in each line, using
  860.  the following format :
  861.  
  862. topic-index-table name
  863. links-index-table name
  864. help-raw-data-file name
  865. number-of-topics
  866. length-of-file
  867. version-of-generating-compiler
  868. link-normal-color
  869. link-high-color
  870. text-normal-color
  871. help-database-engine
  872.  
  873. .par
  874. The help-database-engine values available today are DEF=Paradox and 
  875. MEM=memory Tables.
  876. .endpar
  877.  
  878. ~Technical Documentation~TechDoc~
  879. ~Topic Index Format~tif~
  880. ~Links Index Format~lif~
  881. .end-entry
  882.  
  883.