home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 12 / CD_ASCQ_12_0294.iso / maj / 4405 / helpc.doc < prev    next >
Text File  |  1993-11-03  |  53KB  |  1,257 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                               P.O.Box 5517                               ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. *******************************************************************************
  12. *      helpC Help Engine Technical specification and compiler user guide      *
  13. *           LAST UPDATE - Nov. 02, 1993. (c) 1992,93 - Loewy Ron.             *
  14. *******************************************************************************
  15.  
  16. *******************************************************************************
  17. *                              General Overview                               *
  18. *******************************************************************************
  19.  
  20. The Help Engine database is a combination of text that is read by the user,
  21. and a Topic and Links database that allows the user to view the topics
  22. he is interested in, using hyper-text methods.
  23.  
  24. This document describes the HLPDK language syntax, helpC compiler operation
  25. and the native databases structure.
  26.  
  27. *******************************************************************************
  28. *                               Compiler Usage                                *
  29. *******************************************************************************
  30.  
  31. The helpC help compiler is a DOS command line program that receives a 
  32. help definition file (.HDF) and produce a help database. 
  33.  
  34. The helpC command line is :
  35.  
  36.   HELPC source.hdf [/NT:topic-table-name] 
  37.                    [/NL:link-table-name] 
  38.                    [/ND:data-file-name] 
  39.                    [/NK:keywords-table-name] 
  40.                    [/D:conditional-define]
  41.                    [/ED=P|C|+]
  42.                    [/EL=x]
  43.                    [/FC+]
  44.                    [/EA+]
  45.                    [/R+] [/ST-] [/CS+] [/EP+] [/WD-][/RM-]
  46.                    [/W+] [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+] [/XD+]
  47.                    [/PX+] [/MT+] [/OS2] [/TXT] [/RTF] [/PP+] [/MMV]
  48.  
  49. When the target of the compiler is one of the native help engines
  50. the output of the compiler is a set data file called source.SET, that
  51. includes the names of the other help database components. 
  52.  
  53. Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler 
  54. will generate a .HPJ and .RTF files that can be used with the Microsoft 
  55. HC (v3.00b) or HC31 help compiler, and output a .HLP windows help file!. 
  56.  
  57. By default the help compiler does not produces a help cross reference 
  58. report on the topics/links used in the database, if the /R+ switch is set, 
  59. a cross-reference report will be generated, and database integrity indicators 
  60. will be given. Notice, however, that with the /R+ switch HELPC is much
  61. slower than with /R-.
  62.  
  63. IMPORTANT - Scan the output cross reference report for links defined, that
  64. are not defined as topics!
  65.  
  66. Notice - An additional switch is available that instructs the help compiler
  67. to indicate it's parse and code generation progress. Use the /EP+ switch to
  68. see that the helpC compiler is active. Please understand that the compile
  69. process can take a long time, on complex help databases. This switch does
  70. nothing more that ensure to you that the help compiler is alive. 
  71.  
  72. The /ST switch defines if the topic name defined in the .TOPIC command
  73. can include embedded spaces. By default this switch is set to /ST- (No
  74. embedded spaces).
  75.  
  76. The /CS switch turns Topics and Links case sensitivity to ON. Use this
  77. switch with care - Only if you must have a lower/mixed case index in THELP
  78. or PopHelp use this switch. Notice that help databases that compile fine
  79. with case sensitivity set to off, might fail to do so in case sensitivity
  80. on. By default this switch is set to off (-).
  81.  
  82. The /XD switch generates code to the MDVXHELP help compiler, available
  83. free in the file DVXHLP10.ZIP on the Internet. When this switch is given,
  84. a set of cover and section files is generated, as well as a response
  85. file that should be used to compile the help database.
  86.  
  87. The /OS2 switch generates IPF source code. You must compile the generated code 
  88. with IPFC, from within an OS/2 session (window or full screen).
  89.  
  90. The /WD switch controls Warning Display. By default Warning Display is On, if
  91. you do not want to see the Warnings issued by the compiler when a topic name 
  92. or link are found to be incompatible with the target source, and helpC 
  93. translate them to be syntax compatible with the target.
  94.  
  95. Use the /TXT switch to create a text file document from your .HDF source.
  96. With this feature you can create on-line help and printed documentation
  97. from the same source!.
  98.  
  99. Use the /RTF switch to create a word-processor ready RTF file, import this
  100. file (and update the fields e.g.- F9 in WinWord) to create a professional
  101. formatted documentation from the same source code!.
  102.  
  103. The /RM- switch uses disk cross-reference report tables. Usage of this 
  104. option will allow the creation of cross-reference report for huge databases.
  105. This options will slow the creation of reports, use it only for databases
  106. so big that the report can not be generated using memory tables.
  107.  
  108. The /ED= switch creates the external references (if any are defined) in one
  109. of the following formats : /ED=P (Default) creates the external definitions
  110. in a PASCAL unit, /ED=C creates the external definitions in a C header 
  111. file, and /ED=+ creates a C++ header file.
  112.  
  113. The /EL= switch sets the Error Level used. This switch can be overridden
  114. by the .ERRORLEVEL statement. The acceptable error levels are :
  115.  
  116.   0    No Check  - (Default) - No action is taken.
  117.   1    Trap      - The link is replaced to a special topic named ERROR.
  118.   2    Strip     - The link is replaced by the Text part only.
  119.   3    Delete    - The text and link parts are deleted.
  120.   9    Abort     - helpC will abort with an error message, indicating the 
  121.                    line number.
  122. Please refer to the Exception Handling section below about helpC error
  123. processing.
  124.  
  125. The /FC+ switch forces topic collection, even if the error level is 0, that
  126. does not require collection.
  127.  
  128. Use the /PP+ switch to create an export file, to be used in multiple database
  129. target files projects.
  130.  
  131. The /EA+ switch is used to export all topics in a database, during a 
  132. PreProcess target generation, compared to exporting only topics that
  133. have the .EXPORT attributes.
  134.  
  135. The /MMV switch is used to generate Microsoft Multimedia Viewer 2.0 code,
  136. You must use the WMVC.EXE program that came with your copy of the Multimedia
  137. Publishing ToolKit (MM PTK) to compile this code.
  138.  
  139. *******************************************************************************
  140. *                                Command Line                                 *
  141. *******************************************************************************
  142.  
  143. The compiler switches are defined on the command line. These switches can
  144. be placed before and after the source file name. The compiler will look for
  145. a file named HELPC.CFG in the current directory, and process it before any
  146. command line switches are processed. 
  147.  
  148. Switches on the command line will over-ride switches set before them, on the
  149. command line or in one of the lines of the response options file(s).
  150.  
  151. Response option files can be specified by prefixing their name with a @ sign.
  152.  
  153. Examples :
  154.  
  155. If our HELPC.CFG file, in the current directory is :
  156.  
  157. /W31
  158. /R-
  159.  
  160. And we compile using HELPC HELPDEMO
  161.  
  162. The helpdemo.hdf file will be compiled, with the target set to winHelp 3.1
  163. and no cross-reference report.
  164.  
  165. Compile using HELPC HELPDEMO /r+
  166.  
  167. Will create winHelp 3.1 sources, but a report will be generated.
  168.  
  169. Compile using HELPC /w- HELPDEMO
  170.  
  171. Will generate native format help database, no report is generated.
  172.  
  173. If we have a file called MYSWITCH.CFG with the following lines :
  174.  
  175. /TH+
  176. /ST-
  177. /CS+
  178.  
  179. And we compile using HELPC @MYSWITCH.CFG HELPDEMO
  180.  
  181. A THELP source, using Long Topic Names, with case sensitivity will be 
  182. generated, no cross reference report is generated. (HELPC.CFG contains /r-)
  183.  
  184. *******************************************************************************
  185. *                           Help Definition Format                            *
  186. *******************************************************************************
  187.  
  188. The help definition file format is as follows :
  189.  
  190.   remarks ...
  191.   remarks ...
  192.  
  193.   .ENTRY topic-name
  194.   [.TITLE optional title for topic]
  195.   [.TITLEATTR paragraph attributes]
  196.   [.KEYWORDS optional keywords for topic]
  197.   [.GROUPS group1 [group2 ..]]
  198.   [.LIST optional browse list for topic]
  199.   [.EXPORT]
  200.   topic text and link reference .. 
  201.   topic text and link reference .. 
  202.   topic text and link reference .. 
  203.   topic text and link reference .. 
  204.   .END-ENTRY 
  205.  
  206.   remarks ...
  207.  
  208.  
  209.   .ENTRY topic2-name
  210.   [.KEYWORDS keyword1 keyword2 ..]
  211.   [.GROUPS group3 [group2 ..]]
  212.   [.PARAGRAPH [paragraph attributes]]
  213.   topic 2 text and link reference .. 
  214.   topic 2 text and link reference .. 
  215.   topic 2 text and link reference .. 
  216.   [.END-PARAGRAPH]
  217.   additional topic2 text ...
  218.   .END-ENTRY 
  219.   
  220.   .POPUP PopUp-name
  221.   [.TITLE optional title for PopUp]
  222.     definition for some reference
  223.     ...
  224.   .END-POPUP
  225.  
  226.  
  227. As can be seen - lines between the .ENTRY and .END-ENTRY keywords are
  228. the lines processed by the help compiler, to create the help database, 
  229. every other line is considered a remark, and is not parsed or evaluated by
  230. the help compiler.
  231.  
  232. The topic text and link reference lines are simple text lines, with
  233. special link marks.
  234.  
  235. A sample will provide the details :
  236.  
  237.   This is a text help line that includes one ~link~link-topic-name~ in it.
  238.  
  239. This line will be displayed in the help engine program as :
  240.  
  241.   This is a text help line that includes one link in it.
  242.  
  243. The word "link" will be in a different color then the rest of the line, 
  244. to indicate that this is a link. If the user hi-lights the link, and
  245. presses Enter (or points the mouse cursor and clicks), the help engine will
  246. look for a topic called "link-topic-name", and display it.
  247.  
  248. Browse the HELPDEMO.HDF file for a demo of a help database definition file.
  249.  
  250. Notes :
  251.  
  252.  1. The keywords .TOPIC and .END-TOPIC can be used instead of .ENTRY and
  253.     .END-ENTRY respectively. 
  254.  
  255.     An equivalent pair of keywords are .TOP and .ENDTOP .
  256.  
  257.     You can use .EXT-TOPIC instead of .TOPIC/.ENTRY etc.. - topics created
  258.     with that statement are the same as regular topics, only - an external
  259.     reference is created for them to be linked to a PASCAL/C/C++ program.
  260.  
  261.  2. Keywords are NOT case sensitive (.topic = .TOPIC = .eNTry)
  262.  
  263.  3. The .TITLE keyword is optional. If no title is defined, the topic name
  264.     is used as a title. The .TITLEATTR keyword is used to describe the
  265.     title text attributes. The syntax is the same as the .PARAGRAPH text
  266.     attributes. Please refer to the Text Attributes section below for further
  267.     discussion of the optional paragraph attributes.
  268.  
  269.  4. If you want the ~ sign to appear in your help database, use ~~ in your
  270.     help source file (e.g. "This is a ~~" will be "This is a ~" in the final
  271.     help database.).
  272.  
  273.  5. The Optional .PARAGRAPH and .END-PARAGRAPH commands in the help topic text,
  274.     specify the start and the end of a paragraph. This feature is currently 
  275.     supported only for MMViewer, winHelp, RTF and IPF sources. This feature is 
  276.     important if you want to create long paragraphs that will wrap correctly 
  277.     when a user re-sizes the help window. Please refer to the Text Attributes 
  278.     section below for further discussion of the optional paragraph attributes.
  279.  
  280.     The .PAR and .ENDPAR keywords can be used instead of the .PARAGRAPH and
  281.     .END-PARAGRAPH keywords.
  282.  
  283.  6. When a .PARAGRAPH is issued, a .END-PARAGRAPH MUST be specified at the
  284.     end of the paragraph. These commands must appear as the first words in
  285.     a line. The text after the .PARAGRAPH command is NOT part of the text 
  286.     of the help topic.
  287.  
  288.  7. The optional .KEYWORDS command can appear after the .TITLE command
  289.     (If there is one), or the .TOPIC header (otherwise), Use this command
  290.     to help the user search for sets of topics that are connected to a 
  291.     specific keyword. The syntax of this command is :
  292.  
  293.       .KEYWORDS keyword-1 keyword-2 ... 
  294.     
  295.     Multiple .KEYWORDS lines are allowed, if there are a lot of KEYWORDS,
  296.     that will not fit on a single line, multiple .KEYWORDS lines can be
  297.     used. (NewsDB - The usenet hypertext generator uses that feature).
  298.  
  299.  8. .POPUP and .END-POPUP (or .ENDPOP) are used to define PopUp topics that 
  300.     are displayed on the same screen as the original topic that includes the
  301.     link to them. PopUp entries allow the user to consult a glossary, and 
  302.     not lose the topic he was reading. Popups are supported in the winHelp,
  303.     OS2 IPF, Native PX/Mem and MMViewer formats. In the other formats Popups are 
  304.     used as standard topics.
  305.  
  306.  9. In the Text/RTF targets .POPUP entries will be automatically included in a 
  307.     Glossary file that you can add as an appendix to your documentation.
  308.  
  309. 10. The .GROUPS statement associate a topic with several groups, you can 
  310.     create topics with menus to groups of other topics using the statement
  311.     ".INSERT GROUP group-name" in your topic text. Please refer to the 
  312.     Groups section of this document for additional discussion of this
  313.     function.
  314.     Multiple .GROUPS lines are allowed, if there are a lot of GROUPS,
  315.     that will not fit on a single line, multiple .GROUPS lines can be
  316.     used.
  317.  
  318. 11. The .LIST attribute associates a topic to a browse sequence, in this
  319.     name. The topic will be after the previous topic that belongs to this
  320.     list, and before the next topic that belongs to this list. The list
  321.     browse sequences are currently supported in the winHelp and MMViewer
  322.     targets only.
  323.  
  324. 12. Graphic support is available by using a Graphic Link. A Graphic Link
  325.     has the following format :
  326.     
  327.       ~Text to display if not a graphic target~graphic-name~
  328.     
  329.     Where graphic-name is the name of a graphic object defined with the
  330.     .GRAPHIC statement. Please refer to the Graphics Section below for more
  331.     information.
  332.  
  333. 13. If the .EXPORT attribute is specified, HELPC will automatically create
  334.     a reference to the topic in an export file. This function can be useful
  335.     when you create a multiple file target database. This command can be very
  336.     useful when you have to create a complex multi file database, and use a
  337.     "make" utility to maintain the project. For more information about this
  338.     attribute, please refer to the Complex Projects section below.
  339.  
  340. 14. Sound support is available by using a Sound link. This link will play a 
  341.     sound file, when the user clicks the link. The link has the following
  342.     format :  
  343.       
  344.       ~Text-That-Will-Appear~soundLinkName~
  345.     
  346.     Where Text-That-Will-Appear will be displayed on the screen, and when the
  347.     text will be clicked, the sound object defined as soundLinkName will be
  348.     played. Please refer to the Sound section below.
  349.  
  350. 15. Applications can be launched from the help database by clicking a link, that
  351.     was defined as an application. The syntax is : ~Text~application-link~
  352.     where Text is the text that will appear to the user, and application-link
  353.     is the identifier of the application that will be executed, as defined in
  354.     the .APPLICATION statement. Please refer to the Application Launch section
  355.     below for more information.
  356.  
  357. 16. User defined links can be created and used in the topic text, please refer
  358.     to the Links section below for discussion of this feature.
  359.  
  360.  
  361. Additional commands include :
  362.  
  363. .TEXTCOLOR, .LINKCOLOR and .LINKHIGH - VGA colors of text and links in normal 
  364. and high (selected) states in the native help formats.
  365.  
  366. The syntax of these commands is :
  367.  
  368.   .TEXTCOLOR w 
  369.  
  370. or 
  371.  
  372.   .LINKCOLOR x
  373.  
  374. or
  375.  
  376.   .LINKHIGH y
  377.  
  378. Where w, x and y are the color of the text/link, which is a combination of the 
  379. color of the foreground with the color of the background multiplied by 16.
  380.  
  381. The colors that can be used for both fore and background are :
  382.  
  383.   Black     = 0
  384.   Blue      = 1
  385.   Green     = 2
  386.   Cyan      = 3
  387.   Red       = 4
  388.   Magenta   = 5
  389.   Brown     = 6
  390.   LightGray = 7
  391.  
  392. The colors that can be used only for the foreground are :
  393.  
  394.   DarkGray     = 8
  395.   LightBlue    = 9
  396.   LightGreen   = 10
  397.   LightCyan    = 11
  398.   LightRed     = 12
  399.   LightMagenta = 13
  400.   Yellow       = 14
  401.   White        = 15
  402.  
  403. For example : to set the normal color of a link to light green on blue, use
  404.  
  405.   .LINKCOLOR 26
  406.  
  407. where 26 = 10 + 16 * 1. (10 = light green, 1 = blue).
  408.  
  409. Creating Multiple Source Projects :
  410.  
  411. Use the .INCLUDE commands in the source of your .HDF file, to include an
  412. additional source file. .INCLUDE is not supported in the middle of a topic.
  413.  
  414. For Example :
  415.  
  416.   .. some stuff 
  417.   .include 2ndfile.hdf
  418.   .. additional stuff
  419.  
  420. will process 2NDFILE.HDF in the middle of our source file.
  421.  
  422. Please notice - .INCLUDE commands can be nested in your source file,
  423. it is however not recommended to nest them too deep, helpC does not
  424. close the input file when a .INCLUDEd file is processed, in order to
  425. minimize help generation time - there is however, a limit on the number
  426. of open files that can be used by a program - this is a limit set by DOS.
  427.  
  428. Code Insertion :
  429.  
  430. Use the .INSERT CODE statement to insert target code that will not be 
  431. translated by helpC. helpC will send un-translated code to the output target
  432. until a .END-CODE statement is found.
  433.  
  434. For example - creating a small table in winHelp format :
  435.   
  436.   .. normal code
  437.   .ifdef windows
  438.   .insert code
  439.   \pard{\tab column1\tab column2\tab column3}\par
  440.   \pard{\par blabla\tab blabli ..}\par
  441.   .end-code
  442.   .endif
  443.  
  444. GUI Font based targets :
  445.  
  446. The .FIXEDFONT command is used to define a non proportional font as the 
  447. default font of the help database. Currently the only targets affected
  448. by this command are MMViewer, winHelp and RTF. If you find that your help 
  449. databases are not aligned after they are converted to winHelp format, use 
  450. this command and re-compile. This command has no effect on targets that are 
  451. different from the targets mentioned above.
  452.  
  453. The .PCFONT command is used to define a font that has the standard PC 
  454. character set (Terminal - in windows). If you convert a text based 
  455. database that uses the PC's special characters, use this command to
  456. set the default font. This command has no effect on targets that are 
  457. different from the targets mentioned above.
  458.  
  459. Text targets :
  460.  
  461. The .PAGELENGTH and .PAGEWIDTH statements set the printed page length in
  462. rows, and width in columns. The syntax is .PAGELENGTH xx or .PAGEWIDTH yy .
  463.  
  464. Font Pallete :
  465.  
  466. Use the .SETFONT command to change or add fonts to the font palette, The 
  467. syntax is : .SETFONT font-number 'Font-Name-In-The-Target-Language'. If
  468. for example we would like to change font number 3 in the windows target
  469. to be a font X of family Y we would write : 
  470.  
  471.   .SETFONT 3 'Y X'
  472.  
  473. A good way to find in RTF how to describe the font you are interested in,
  474. is to open a new document in your word processor, write a line in the
  475. font you are interested, save the document as a RTF document, and see the
  476. way the word processor described the font in the RTF font table.
  477.  
  478. Text Attributes :
  479.  
  480. Use the .TITLEDEFAULTS statement to set the default text attributes of the
  481. topics titles in the help database. These defaults can be over-ridden with
  482. the .TITLEATTR statement in the topic definition. Please refer to the Text
  483. Attributes section below for discussion of paragraph text attributes.
  484.  
  485. Use the .ATTRDEFAULTS statement to set the default text attributes of 
  486. paragraph text in the database. Please refer to the Text Attributes section 
  487. below.
  488.  
  489. Error Handling :
  490.  
  491. Use the .ERRORLEVEL command to set the error level. The syntax is .ERRORLEVEL x
  492. where x is one of the following :
  493.  
  494.   0    No Check  - (Default) - No action is taken.
  495.   1    Trap      - The link is replaced to a special topic named ERROR.
  496.   2    Strip     - The link is replaced by the Text part only.
  497.   3    Delete    - The text and link parts are deleted.
  498.   9    Abort     - helpC will abort with an error message, indicating the 
  499.                    line number.
  500. Please refer to the Exception Handling section below about helpC error
  501. processing.
  502.  
  503. Alias Topics :
  504.  
  505. Use the .ALIAS command to substitute a PopUp/Topic name with another name. The
  506. syntax is .ALIAS newname origname. Whenever a newname link is found, the alias
  507. of origname is used. This can be very useful when you want to give multiple
  508. names to a topic, or when HLPDK source is the target of an incremental 
  509. compiler.
  510.  
  511. Graphic Support :
  512.  
  513. Use the .GRAPHIC statement to define a graphic object, that can be referenced
  514. elsewhere in your document. 
  515. The syntax is :
  516.  
  517.   .GRAPHIC graphic-name path-to-graphic-file
  518.  
  519. Please refer to the Graphics section below, for further information.
  520.  
  521. External Links :
  522.  
  523. Use the .EXTLINK command to define links in external database file. With this 
  524. command you can create multiple file target database projects. Please refer to
  525. the Links section below for more information about this feature.
  526.  
  527. Sound Support :
  528.  
  529. Use the .SOUND command statement to define a sound object, that can be used as
  530. a Sound link elsewhere in your document. The syntax is :
  531.  
  532.   .SOUND sound-name sound-file-name
  533.  
  534. Please refer to the Sound section below for more information about this feature.
  535.  
  536. Application Launch :
  537.  
  538. The .APPLICATION statement is used to define an application object that can be
  539. launched by an application-launch-link. The syntax is :
  540.  
  541.   .APPLICATION application-identifier application-definition
  542.  
  543. Where application-identifier is the identifier that will be used in 
  544. application-launch-links, and application-definition is the path to the
  545. application. If the application needs to get parameters, the path and the
  546. parameters are specified in quotes. Please refer to the Application Launch
  547. section below for additional information.
  548.  
  549. External Routines Support :
  550.  
  551. The .ROUTINE statement can be used to define external routines that can be 
  552. called from the help database. The syntax is :
  553.  
  554.   .ROUTINE routine-name module-name parameter-definition
  555.  
  556. Where routine-name is the name of the procedure/function to be called, 
  557. module-name is the name of the library/DLL that the routine resides in (No need
  558. to add the .DLL extension), and parameter-definition is the definition of the
  559. parameters that the routine receives.
  560. The parameter definitions is a string with one character describing each
  561. parameters type. The following definitions are used :
  562.  
  563. char    C definition               Pascal definition
  564.  
  565.   u       unsigned short (WORD)      Word
  566.   U    unsigned long  (DWORD)     Longint
  567.   i    short int                  byte
  568.   I    int                        integer
  569.   s    near char * (PSTR)         PChar
  570.   S    far char * (LPSTR)         PChar
  571.   v    void 
  572.  
  573. Embedding Files :
  574.  
  575. Use the .EMBEDD statement to add files to your help database. The files defined
  576. as embedded will appear in the [baggage] section of your winHelp/MMViewer 
  577. project definition and will be stored with the rest of the database.
  578.  
  579. The syntax is :
  580.  
  581.   .EMBEDD file-id path-to-file
  582.  
  583. Where file-id is the name the file will be referenced by, and path-to-file is
  584. the path to the file on the author's machine.
  585.  
  586.  
  587. *******************************************************************************
  588. *                                    Links                                    *
  589. *******************************************************************************
  590.  
  591. Links are the special "commands" embedded in a topic text, that provide
  592. special functionality in the target database.
  593.  
  594. All links are described in the topic text as a combination of text that will
  595. appear, and a link identifier.
  596.  
  597. The syntax, in a topic text for a link is :
  598.  
  599.   .. Some Standard Text .. ~Link Text~Link Id~ .. some more text ..
  600.  
  601. Link Id is a unique identifier that describe this link.
  602.  
  603. The most common link, is a topic link, this link allows the user to click on
  604. the Link Text, that is usually in a different color than the rest of the text,
  605. and by clicking on this texts, the topic in the help engine window is replaced,
  606. with the topic that has the same identifier as the Link Id specified in the
  607. identifier.
  608. (A Topic is defined by a .topic statement somewhere else in the source file).
  609.  
  610. Another type of link, is the PopUp link. When the Link Id is the Id of a PopUp,
  611. clicking on the link will display the PopUp text in a window, and retain the 
  612. original topic in the help engine window (A PopUp is defined by a .POPUP 
  613. statement somewhere else in the source file).
  614.  
  615. Links can be used, to embed non-textual information in the topic text. A 
  616. common non-textual is a graphic link, when the Link Id is the Id of a graphic
  617. object (defined by a .graphic statement somewhere else in our source), the
  618. place of the link will be replaced by a graphic picture, in targets that 
  619. support graphics (such as winHelp and OS/2 IPF), and remain the Link Text
  620. in targets that do not support graphics.
  621.  
  622. Another non-textual link is a sound link. A sound link plays a sound file 
  623. when a sound object (defined with the .SOUND statement) is clicked by the user. 
  624.  
  625. Applications can be launched from a link, when the link key is the identifier of
  626. an application defined with the .APPLICATION statement.
  627.  
  628. Other links can be created using "User Defined Link Templates", with this 
  629. feature a link template can be created to support additional code translations.
  630. Please refer to the Extending HDF section below for additional information
  631. on User defined links.
  632.  
  633. When helpC recognizes a link, the following sequence of link recognition 
  634. occurs :
  635.  
  636.   1. Try to match link with a graphic object.
  637.   2. If failed - try to match link with a sound object.
  638.   3. If failed - try to match link with an application object.
  639.   4. If failed - try to match link with a user defined link.
  640.   5. If failed - try to match link with a PopUp.
  641.   6. If failed - try to match link with a topic.
  642.   7. If failed - try to match link with an external topic. (.EXTLINK)
  643.   8. If failed - operate according to the current error-level.
  644.  
  645.  
  646. *******************************************************************************
  647. *                             Conditional Defines                             *
  648. *******************************************************************************
  649.  
  650. The helpC compiler supports conditional define directives that allow you to
  651. tailor your source according to define symbols that are known to the compiler.
  652.  
  653. You can use the .ifdef, .ifndef, .else and .endif directives to test the
  654. target of your compile and do different things according to this target.
  655.  
  656. If for example you have a Windows bitmap you want to include in your generated
  657. RTF file, when you compile to winHelp format, but, you would like to use a
  658. statement in other targets that do not support graphics, you could do the 
  659. following :
  660.  
  661.   .ifdef windows
  662.     some text {\bmc mybmp.bmp\} some more text
  663.   .else 
  664.     some text AND STATEMENT HERE some more text
  665.   .endif
  666.  
  667. When the compiler will generate the code, the RTF command \bmc will be 
  668. inserted in the output of the compiler for windows targets (/W30, /W31), 
  669. and a simple text statement will be inserted otherwise.
  670.  
  671. The conditional directives supported are :
  672.  
  673.   .ifdef  SYMBOL - Compile code only if SYMBOL is defined.
  674.   .ifndef SYMBOL - Compile code only if SYMBOL is NOT defined.
  675.   .endif         - Any .ifdef/.ifndef should be terminated by a .endif .
  676.   .else          - Reverse the previous .ifdef/.ifndef
  677.  
  678. The following SYMBOLS are automatically defined by the compiler :
  679.  
  680.   Symbol          When Defined
  681.   ------          ------------
  682.   DEF             /PX+
  683.   W31             /W31
  684.   W30             /W30
  685.   THS             /TH+
  686.   QHS             /QH+
  687.   TVH             /TV+
  688.   PHS             /PH+
  689.   DVX             /XD+
  690.   MEM             /MT+
  691.   OS2             /OS2
  692.   TXT             /TXT
  693.   WINDOWS         /W30, /W31
  694.   THELP           /TH+
  695.   QUICKHELP       /QH+
  696.   TVHC            /TV+
  697.   NATIVEPARADOX   /PX+
  698.   POPHELP         /PH+
  699.   DESQVIEW/X      /XD+
  700.   NATIVEMEMORY    /MT+
  701.   VERx.y          When Compiling with helpC Vx.y 
  702.   NATIVE          /PX+, /MT+
  703.   DOCUMENT        /TXT, /RTF
  704.   RTFBASED        /W+, /RTF, /W30, /W31, /MMV
  705.   PRP             /PP+
  706.   PREPROCESS      /PP+
  707.   MMV             /MMV
  708.   MMVIEWER        /MMV
  709.   VIEWER          /MMV
  710.  
  711. You can define your own conditional defines on the command line using the /D:
  712. switch of helpC.
  713.  
  714. e.g.
  715.  
  716. Source :
  717.  
  718.   ... some text ..
  719.   .ifdef mydef
  720.     Special Text for mydef situation
  721.   .endif
  722.   ... more text
  723.  
  724. and you compile using HELPC /D:MYDEF the special text will be included.
  725.  
  726. *******************************************************************************
  727. *                                   Groups                                    *
  728. *******************************************************************************
  729.  
  730. Topics can be associated to groups using the .GROUPS statement in the topic
  731. heading. Menus to these groups can later be created by using the command 
  732. .INSERT GROUP group-name in the topic text.
  733.  
  734. An example will clarify the use of this function :
  735.  
  736. Let us assume that we have a car's collectors database, where the description
  737. of each car is a topic. We would like to present a hierarchy to the user that
  738. looks like that : 
  739.  
  740. Overview Screen
  741.    |
  742.    +--------- Cars by Country
  743.    |               |
  744.    |               +------------ U.S.A ... List of cars manufactured in U.S.A
  745.    |               +------------ U.K.
  746.    |               +------------ Italy
  747.    |
  748.    +--------- Cars by Maker
  749.    |               |
  750.    |               +------------ Alfa-Romeo ... List of Alfa-Romeo models
  751.    |               +------------ GM
  752.    |               +------------ Mazda
  753.    |
  754.    +--------- Cars by type
  755.                    |
  756.                    +------------ 4x4 & Jeeps
  757.                    +------------ Sport Cars
  758.                    +------------ Family Sedans
  759.                         
  760. We will create group references in the topics using the .GROUPS statement,
  761. The Alfa Romeo Spider 2000 topic will look like :
  762.  
  763.   .topic alfa_romeo_spider_2000
  764.   .title Alfa Romeo Spider 2000
  765.   .keywords alfa spider convertible sport classic
  766.   .groups Italian alfa sport
  767.  
  768.   The Alfa Romeo ... 
  769.  
  770.  
  771.   .end-topic
  772.  
  773. The Italian Cars Directory topic will be :
  774.  
  775.   .topic Italy_directory
  776.   .title Italian Cars Directory
  777.   .keywords directory
  778.  
  779.   Cars Manufactured in Italy :
  780.  
  781.   .insert group Italian
  782.  
  783.   .end-topic
  784.  
  785. If our database includes three cars that have a reference to the Italian group
  786. this will be the equivalent of writing :
  787.  
  788.   .topic Italy_directory
  789.   .title Italian Cars Directory
  790.   .keywords directory
  791.  
  792.   Cars Manufactured in Italy :
  793.  
  794.   ~Alfa Romeo Spider 2000~alfa_romeo_spider_2000~
  795.   ~Ferrari 308 GTS~Ferrari_308_gts~
  796.   ~Fiat Uno 70S~fiat_uno_70s~
  797.  
  798.   .end-topic
  799.  
  800. *******************************************************************************
  801. *                               Text Attributes                               *
  802. *******************************************************************************
  803.  
  804. Topic's text can receive visual attributes such as a font, size, bold, 
  805. italic etc.. by using the paragraph attributes on the .PARAGRAPH (.par)
  806. line. Text attributes are currently supported in the MMViewer, winHelp and RTF 
  807. targets.
  808.  
  809. The attributes that can be applied to text are :
  810.  
  811.   Font            - The font the text will be displayed in.
  812.   Bold            - The text is displayed in bold characters.
  813.   Italic          - The text is displayed in italic characters.
  814.   Underline       - The text is displayed in underline characters.
  815.   Size            - The size of the font.
  816.   Box             - The paragraph can be contained in a box.
  817.   Align           - The paragraph can be aligned.
  818.   Color           - The text foreground color.
  819.  
  820. The syntax is :
  821.  
  822.   .PARAGRAPH [attr1 attr1-parameters [attr2 attr2-parameters [..] ]]
  823.  
  824. The allowed parameters to attributes are :
  825.  
  826.  1. FONT font-number-in-font-palette : The font number in the font palette, 
  827.     there is a standard font palette for MMViewer, winHelp and RTF targets that 
  828.     include the following fonts :
  829.  
  830.       0 : Times Roman        (roman Tms Rmn)
  831.       1 : Symbol             (decor Symbol)
  832.        2 : Helvetica          (swiss Helv)
  833.       3 : LinePrinter        (modern LinePrinter)
  834.       4 : Terminal           (roman Terminal)
  835.       5 : Times New Roman    (roman Times New Roman)
  836.       6 : Arial              (swiss Arial)
  837.       7 : CG Times (WN)      (roman CG Times (WN))
  838.       8 : Courier            (modern Courier)
  839.       9 : Modern             (modern Modern)
  840.      10 : Script             (script Script)
  841.      11 : Univers (WN)       (swiss Univers (WN))
  842.      12 : Wingdings          (nil Wingdings)
  843.      13 : MS Sans Serif      (swiss MS Sans Serif)
  844.  
  845.  2. BOLD ON|OFF - Set bold mode to on/off.
  846.  
  847.  3. ITALIC ON|OFF - Set italic mode to on/off.
  848.  
  849.  4. UNDERLINE ON|OFF - Set underline mode on/off.
  850.  
  851.  5. SIZE font-size - Set the size of the font.
  852.  
  853.  6. BOX NONE|NORMAL|THICK|SHADOW|DOUBLE - Print paragraph in a box which has one
  854.     of the described borders : NONE is no border at all.
  855.  
  856.  7. ALIGN LEFT|RIGHT|CENTER|JUSTIFY - Print the text in the paragraph aligned
  857.     to one of the sides, the center or justified in the paragraph.
  858.  
  859.  8. COLOR color-number-in-color-palette - The numbers are the same numbers used
  860.     for DOS native systems and described in the help definition format section
  861.     above, regarding the .LINKCOLOR, .TEXTCOLOR and .LINKHIGH statements.
  862.  
  863. Example :
  864.  
  865.   .PAR BOX SHADOW FONT 13 BOLD ON
  866.      ... some text here ..
  867.   .ENDPAR
  868.  
  869. Will display the paragraph in a shadow bordered box, using font 13 in the 
  870. palette (MS Sans Serif assuming that the original palette is used) with bold
  871. characters.
  872.  
  873. *******************************************************************************
  874. *                             Exception Handling                              *
  875. *******************************************************************************
  876.  
  877. helpC provides mechanism to handle link exceptions. An exception is a link
  878. to an identifier that is not defined as a Topic or PopUp. In order to help
  879. you find these errors helpC contains the cross reference report that can
  880. be produced using the /R+ switch. You can browse the HELPC.LST file generated
  881. by helpC if a cross reference report is generated, and search for the string
  882. ERROR that describes undefined links.
  883.  
  884. helpC provides additional exception handling facilities. When an error is found
  885. during compile helpC can perform on of the following actions :
  886.  
  887.   0: No Check - Default - helpC does not do anything. The link is passed as is 
  888.               to the target. The target help engine/compiler will handle the 
  889.               exception as it is implemented.
  890.  
  891.   1: Trap     - helpC will replace the link key with the key ERROR. It is the 
  892.               responsibility of the help database author to provide such a
  893.               Topic/PopUp.
  894.  
  895.   2: Strip    - helpC will pass the text of the link to the target with no link
  896.               support. The text will appear as normal text.
  897.  
  898.   3: Delete   - Both the text and the link will be deleted and will not appear 
  899.               in the target.
  900.  
  901.   9: Abort    - helpC will abort, with an error message, indicating the line the 
  902.               link is defined. This mode is recommended when you are debugging 
  903.               your help database.
  904.  
  905. You can set the error level using the following techniques :
  906.  
  907.   - Use the /EL=x switch on the helpC command line.
  908.  
  909.   - Use the .ERRORLEVEL x .HDF statement.
  910.  
  911. Important Points :
  912.  
  913.  1. When ERRORLEVEL = 0 (default) no topic database is created during pass 1,
  914.     if you set .ERRORLEVEL somewhere in your source, after some Topics/PopUps
  915.     have been defined, these topics will not be in the symbol table created by
  916.     helpC and will be considered an exception !
  917.  
  918.  2. You can use the /FC+ switch to "Force Collection" of Topics data, even when
  919.     the ERRORLEVEL is 0.
  920.  
  921. *******************************************************************************
  922. *                                  Graphics                                   *
  923. *******************************************************************************
  924.  
  925. Native Graphic support is provided by graphic "links", and graphic object
  926. definitions.
  927.  
  928. In order to incorporate graphics into your database, use the .GRAPHIC
  929. command to define a graphic object. This command associates a graphic file
  930. with a unique identifier.
  931.  
  932. Whenever you want to use the graphic image in one of your topics, you have to
  933. define a link with the following syntax :
  934.  
  935.   ~Link Text in non-graphic targets~graphic-identifier~
  936.  
  937. If the target of the compiler has no helpC native graphic support, the 
  938. "Link Text in non-graphic targets" sentence will be used, if the target 
  939. is supported, the graphic-identifier will be displayed.
  940.  
  941. In this version of HLPDK native graphics support is provided for winHelp,
  942. Microsoft Multimedia Viewer (MMViewer) and OS/2 IPF Bitmaps.
  943.  
  944. Notice that the graphic-identifier must be unique, and must not be identical
  945. to a topic/PopUp/sound name. Please refer to the Links section for
  946. link recognition sequence information.
  947.  
  948. Link Modifiers are attributes that are defined after the link name, separated
  949. with the ";" character.
  950.  
  951. The following modifiers are defined for Graphic support :
  952.  
  953.   Left   : Align the graphic object to the left of the window.
  954.   Right  : Align the graphic object to the right of the window.
  955.   Center : Align the graphic object to the center of the window.
  956.  
  957. Please refer to one of the standard documentation examples that are supplied
  958. with the HLPDK package, for demos of graphic use.
  959.  
  960. *******************************************************************************
  961. *                                    Sound                                    *
  962. *******************************************************************************
  963.  
  964. Sound support is provided by sound "links", and sound object definition.
  965.  
  966. In order to incorporate sound into your database, use the .SOUND command
  967. to define a sound object. This command associates a sound file (WAV in windows)
  968. with a unique identifier.
  969.  
  970. Whenever you want to use the sound object in one of your topics, you have to
  971. define a link with the following syntax :
  972.  
  973.   ~Text To Be Clicked On~sound-identifier~
  974.  
  975. Currently, Sound support is available only in the MMViewer and winHelp targets.
  976. The name of the sound object in this version should be a WAV file, that 
  977. is in the \WINDOWS directory. The WINDOWS MMSYSTEM multi-media support looks
  978. for the sound file in this directory!.
  979.  
  980. *******************************************************************************
  981. *                             Application Launch                              *
  982. *******************************************************************************
  983.  
  984. Applications can be launched from the help database using application launch 
  985. links, and application definitions.
  986.  
  987. An application has to be defined using the .APPLICATION statement that uses the
  988. following syntax :
  989.  
  990.   .APPLICATION application-id 'application-activation-code'
  991.  
  992. Where application-id is the identifier to the application that will be used 
  993. in application launch links, and the application-activation-code is the 
  994. [optional] path to the application and the application executable. If 
  995. parameters should be specified, the application-activation-code should be
  996. surrounded by quotes, with a space separating the path to the application from
  997. the parameters.
  998.  
  999. When you want to include an application launch in the topic text, the 
  1000. application-id should be used as the key of a link.
  1001. e.g. ~Press Here To Run XXX.EXE~application-id~
  1002.  
  1003. *******************************************************************************
  1004. *                              Complex Projects                               *
  1005. *******************************************************************************
  1006.  
  1007. helpC supports multiple file target databases, with the use of the following
  1008. HDF statements : .EXTLINK, and .EXPORT .
  1009.  
  1010. When a link that exists in an external database is needed, the .EXTLINK 
  1011. statement is used to define the properties and attributes of that link.
  1012.  
  1013. The most important property - is the database name, that defines which 
  1014. database should be called. Other attributes include the title, keywords,
  1015. numeric references and groups this external topic should be associated with.
  1016.  
  1017. If we have a "simple" complex project, with only 2 databases, and links 
  1018. between them, we might not find it difficult to define the "public" links
  1019. of database 1 in database 2, and vice versa, but - if the project involves
  1020. more databases, we might find it hard to create these public references to
  1021. all external database, in each database. We can, however, define .EXTLINK
  1022. statements of the public links of each database, in a separate file, and
  1023. use the .INCLUDE statement to include them, in the other statements.
  1024.  
  1025. helpC can be used, with the /PP+ switch, to create these "reference" export
  1026. files, with the name of database.EXP when we use the following command :
  1027. HELPC /PP+ database-name
  1028. If we want a .EXTLINK statement to be created for a topic, we have to
  1029. add the .EXPORT attribute to the topic definition. An alternative is to use
  1030. the /EA+ switch of the helpC compiler, that exports all topics in the database,
  1031. in a PreProcess target compile (/PP+).
  1032.  
  1033. The .EXTLINK statement has the following syntax :
  1034.  
  1035.   .EXTLINK database 'topic-identifier'
  1036.   [.TITLE topic-title]
  1037.   [.REFERENCE topic-numeric-reference]
  1038.   [.KEYWORDS keyword [keyword ..] ]
  1039.   [.GROUPS group [group ..] ]
  1040.   .END-EXTLINK
  1041.  
  1042. Where database is the name of the external database that the link is in,
  1043. topic-identifier is the id of the link in the external database, title, 
  1044. keywords and groups have the same meaning as in the .TOPIC definition, and
  1045. the topic-numeric-reference is a numeric reference associated with the 
  1046. topic, in the external database, if this is needed.
  1047.  
  1048. *******************************************************************************
  1049. *                                Extending HDF                                *
  1050. *******************************************************************************
  1051.  
  1052. The HDF syntax can be extended by creating "User Defined Link Templates", 
  1053. with these templates special links can be created, that can be used to support
  1054. additional link types.
  1055.  
  1056. In order to create a user link template, use the following statement :
  1057.  
  1058.   .USERLINK userlink-id template
  1059.  
  1060. Where userlink-id is the name of the template, and template defines the way
  1061. the link will be translated.
  1062.  
  1063. The template can include the following substitution characters :
  1064.  
  1065.   %%            - Replace with a %
  1066.   %t            - Replace with the text of the link
  1067.   %k            - Replace with the key of the link
  1068.   %1, %2, .. %5 - Replace with parameter #x
  1069.   %o            - Replace with target (output) database name.
  1070.   %c            - Replace with context-id (topic name) of current topic.
  1071.   %g1, %g2, ..  - Replace with the graphic object whose id is in parameter x.
  1072.   %s1, %s2, ..  - Replace with the sound object whose id is in parameter x.
  1073.   %a1, %a2, ..  - Replace with the application object, whose id is in parm x.
  1074.   %e1, %e2, ..  - Replace with the embedded object, whose name is in parm x. 
  1075.                   Notice, that only the file name and extention are returned,
  1076.                   while in the %gx, %sx and %ax, the entire path is returned.
  1077.  
  1078. User links can be used in the topic text with the following syntax :
  1079.  
  1080.   .. some text ~link-text~userlink-id(param1 param2 ..)~ .. more text
  1081.  
  1082. Use this command to extend the HDF syntax. You can even create special 
  1083. libraries to support video/animation etc.. from the help databases, with these
  1084. extensions.
  1085.  
  1086. e.g. - To create a link to a topic, with a graphic bitmap, we could define
  1087. the following User Link : (Example for winHelp/MMViewer)
  1088.  
  1089.   .userlink graphicJump '{\uldb \{bmc %g1\} %t}{\v %2}'
  1090.  
  1091. And assuming we defined a graphic object as 
  1092.  
  1093.   .graphic mypicture ronp.bmp
  1094.  
  1095. We could create a graphic links such as :
  1096.  
  1097.   Click ~Ron Loewy~graphicJump(mypicture ronTopic)~ to know about the author.
  1098.  
  1099. In the target RTF this will be translated to :
  1100.  
  1101.   Click {\uldb \{bmc ronp.bmp\} Ron Loewy}{\v ronTopic} to know about the author.
  1102.  
  1103.  
  1104. *******************************************************************************
  1105. *                         Native Databases Structure                          *
  1106. *******************************************************************************
  1107.  
  1108. Each help database is built of 5 components : 
  1109.  
  1110.  1. Help Data File    - this file contains the raw text data.
  1111.  2. Topic Index       - a database table that contains the topic names, and
  1112.                         the references to the topics in the Data File.
  1113.  3. Links Index       - a database table that contains the list of links 
  1114.                         defined for each topic, and positional data.
  1115.  4. Keywords Index    - a database table that contains the list of keywords,
  1116.                         and the topics that have these keywords.
  1117.  5. Set Data File     - a database configuration file that contains the
  1118.                         names of the 3 components defined above, and some 
  1119.                         additional information.
  1120.  
  1121. Version 1.x is the bare-bones version that includes only the basic
  1122. operations needed from a hyper-text database, this version is implemented
  1123. using the Paradox Engine V3.0 to manage the Topic and Link index tables.
  1124.  
  1125. Version 2.x has a new field in the topic table - the title field, help
  1126. databases that were compiled with V1.x will not be executed by version
  1127. 2.x, they will have to be re-compiled!.
  1128.  
  1129. Version 3.x fields have different length - the databases have to be 
  1130. re-compiled.
  1131.  
  1132. Version 5.0+ has a new entry in the help set file, database have to be
  1133. re-compiled, or the value 128 should be added in the last line of the help
  1134. set file, and the version number should be changed to 5.0.
  1135.  
  1136. Version 6.0+ has added the keyword support - a new database table is added,
  1137. and a new set format is defined. Help databases will have to be re-compiled
  1138. for Native targets.
  1139.  
  1140. In Version 7.0 the title field has been expanded once more - to 70 
  1141. characters. Help databases will have to be re-compiled.
  1142.  
  1143. In Version 8.0 the TTYPE field was added to the Topics database. Old databases
  1144. will have to be re-compiled.
  1145.  
  1146. The format of the help database is released to the public domain, if
  1147. you implement a database viewer on this database structure, I would be
  1148. happy to receive a copy ...
  1149.  
  1150.  
  1151. *******************************************************************************
  1152. *                             Topic Index Format                              *
  1153. *******************************************************************************
  1154.  
  1155. The topic index table format is as follows :
  1156.  
  1157.   TOPIC     - 40 characters string key - this is the topic "name".
  1158.   FILENAME  - 38 characters string field - includes the name of the
  1159.               help raw data file. (Notice - V1.0 ignores the value of this 
  1160.               field, it is here for future expansion).
  1161.   START     - longint (long) field that contains the offset from the data file
  1162.               start, to the start of the topics text data, in bytes.
  1163.   LEN       - longint (long) field that contains the length (in bytes) of the 
  1164.               text data of the topic.
  1165.   TITLE     - 70 characters string key - the title of the topic.
  1166.   TTYPE     - 1 character - topic type. Currently supported types are :
  1167.               'T' = Topic.
  1168.               'P' = PopUp.
  1169.  
  1170. *******************************************************************************
  1171. *                             Links Index Format                              *
  1172. *******************************************************************************
  1173.  
  1174. The links index table format is as follows :
  1175.  
  1176.   TOPIC     - 40 characters string key - the name of the topic that 
  1177.               has the link.
  1178.   SEQ       - integer (int) key - contains the sequential number of 
  1179.               the link in the topic. (This way you can assign the links
  1180.               order in the topic).
  1181.   LINK      - 40 characters string key - the name of the link topic to
  1182.               display if the link is chosen.
  1183.   LINE      - integer (int) field - the line (from the start of the topic) 
  1184.               this link is displayed on.
  1185.   COL       - integer (int) field - the column this link is displayed on.
  1186.   TXT       - 70 characters string field - the text to display on the line.
  1187.  
  1188. *******************************************************************************
  1189. *                            Keywords Index Table                             *
  1190. *******************************************************************************
  1191.  
  1192. The keywords index table format is as follows :
  1193.  
  1194.   KEYWORD   - 40 characters string key - the keyword.
  1195.   TOPIC     - 40 characters string key - the topic name that this keyword is 
  1196.               assigned to.
  1197.  
  1198. Notice: The database will include a row for each keyword, that has the 
  1199.         TOPIC field blank. This is used to display the first list of keywords, 
  1200.         that if chosen, will display the 2nd list of topics that have the chosen 
  1201.         keyword    in their .KEYWORDS definition.
  1202.  
  1203. *******************************************************************************
  1204. *                               Set File Format                               *
  1205. *******************************************************************************
  1206.  
  1207. The set file is a text file that contains one entry in each line, using
  1208. the following format :
  1209.  
  1210.   help-database-engine
  1211.   version-of-generating-compiler
  1212.   topic-index-table name
  1213.   links-index-table name
  1214.   keyword-index-table-name
  1215.   help-raw-data-file name
  1216.   number-of-topics
  1217.   length-of-file
  1218.   link-normal-color
  1219.   link-high-color
  1220.   text-normal-color
  1221.  
  1222. The help-database-engine values available today are DEF=Paradox and 
  1223. MEM=memory Tables.
  1224.  
  1225. *******************************************************************************
  1226. *                               Implementation                                *
  1227. *******************************************************************************
  1228.  
  1229. Notice: The Paradox tables (Topic, Links) include one additional field
  1230.          (wtGeneration) for future expansion purpose only.
  1231.  
  1232. *******************************************************************************
  1233. *                                Distribution                                 *
  1234. *******************************************************************************
  1235.  
  1236. To distribute a database of your creation, compile the help definition
  1237. file, and include the HELPENG.EXE file with the .DB, .PX files, and the
  1238. .HDT file created by the compiler. 
  1239.  
  1240. If you use the Native Mem Format, compile using the /MT+ switch, and
  1241. distribute HE.EXE with the .SET, .HDT and .HDX files created.
  1242.  
  1243. If you generated the Windows (/W30, /W31) help file, you can compile the 
  1244. .HPJ and .RTF generated file, and distribute the resulting .HLP .
  1245.  
  1246. If you generate QH, THELP, PopHelp or TVHC use these packages compilers to
  1247. compile you sources into native binary codes. (helpMake, HL, makeHelp and TVHC)
  1248.  
  1249. To Generate Help databases for DESQview/X, use the MDVXHELP compiler
  1250. that can be found on the Internet in the file DVXHLP10.ZIP.
  1251.  
  1252. Distribute the .INF files that IPFC creates from the .IPF sources generated,
  1253. if you compile to OS/2.
  1254.  
  1255. For examples on these compiler's command lines please refer to the quick
  1256. start section of HLPDK.DOC, or to your compiler's documentation.
  1257.