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