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