home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-385-Vol-1of3.iso / h / hlpdk11.zip / HELPC.DOC next >
Text File  |  1992-11-26  |  9KB  |  184 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 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. 26, 1992. (c) 1992 - 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.  
  25.   Each help database is built of 4 file components : 
  26.  
  27.  1. Help Data File    - this file contains the raw text data.
  28.  2. Topic Index File  - a database table that contains the topic names, and
  29.                         the references to the topics in the Data File.
  30.  3. Links Index File  - a database table that contains the list of links 
  31.                         defined for each topic, and positional data.
  32.  4. Set Data File     - a database configuration file that contains the
  33.                         names of the 3 components defined above, ans some 
  34.                         additional information.
  35.  
  36.   Version 1.0 is the bare-bones version that includes only the basic
  37.  operations needed from a hyper-text database, this version is implemented
  38.  using the Paradox Engine V2.0 to hold the Topic and Link index tables.
  39.  
  40.   The format of the help database is released to the public domain, if
  41.  you implement a database viewer on this database structure, I would be
  42.  happy to receive a copy ..
  43.  
  44. *******************************************************************************
  45. *                               Compiler Usage                                *
  46. *******************************************************************************
  47.  
  48.   The HELPC help compiler is a dos command line program that receives a 
  49.  help definition file (.HDF) and produce a help database. 
  50.  
  51.   The helpC command line is :
  52.  
  53.  HELPC source.fil [/Htopic-table-name] [/Llink-table-name] [/Ddata-file-name] 
  54.                   [/R-] [/W+]
  55.  
  56.   The output of the compiler is a set data file called source.SET, that
  57.  includes the names of the other help database components. 
  58.  
  59.   Please Notice - if the /W+ switch is defined, the compiler will generate 
  60.  a .HPJ and .RTF files that can be fed to the Microsoft HC (v3.00b) help
  61.  compiler, and output a .HLP windows help file!. (The HC31 compiler will
  62.  issue a warning on the generated code, but will compile it, and it works!)
  63.  
  64.   By default the help compiler produces a help cross reference report on the 
  65.  topics/links used in the database, if the /R- switch is set, no cross-ref
  66.  report will be generated, and no database integrity indicators will be
  67.  given.
  68.  
  69.  
  70.   IMPORTANT - Scan the output cross reference report for links defined, that
  71.  are not defined as topics!
  72.  
  73. *******************************************************************************
  74. *                           Help Definition Format                            *
  75. *******************************************************************************
  76.  
  77.   The help definition file format is as follows :
  78.  
  79. remarks ...
  80. remarks ...
  81.  
  82. .ENTRY topic-name
  83. topic text and link reference .. 
  84. topic text and link reference .. 
  85. topic text and link reference .. 
  86. topic text and link reference .. 
  87. .END-ENTRY 
  88.  
  89. remarks ...
  90.  
  91.  
  92. .ENTRY topic2-name
  93. topic2 text ...
  94. .end-entry 
  95.  
  96.  
  97.   As can be seen - lines between the .ENTRY and .END-ENTRY keywords are
  98.  the lines processed by the help compiler, to create the help database, 
  99.  every other line is considered a remark, and is not parsed or evaluated by
  100.  the help compiler.
  101.  
  102.   The topic text and link reference lines are simple text lines, with
  103.  special link marks.
  104.  
  105.   A sample will provide the details :
  106.  
  107. This is a text help line that includes one ~link~link-topic-name~ in it.
  108.  
  109.   This line will be displayed in the help engine program as :
  110.  
  111. This is a text help line that includes one link in it.
  112.  
  113.   The word "link" will be in a different color then the rest of the line, 
  114.  to indicate that this is a link. If the user hi-lights the link, and
  115.  presses Enter (or points the mouse cursor and clicks), the help engine will
  116.  look for a topic called "link-topic-name", and display it.
  117.  
  118.   Browse the HELPDEMO.HDF file for a demo of a help database definition file.
  119.  
  120. *******************************************************************************
  121. *                             Topic Index Format                              *
  122. *******************************************************************************
  123.  
  124.   The topic index table format is as follows :
  125.  
  126.   TOPIC     - 15 charcters string key - this is the topic "name".
  127.   FILENAME  - 38 characters string field - includes the name of the
  128.               help raw data file. (Notice - V1.0 ignores the value of this 
  129.               field, it is here for future expansion).
  130.   START     - longint (long) field that contains the offset from the data file
  131.               start, to the start of the topics text data, in bytes.
  132.   LEN       - integer (int) field that contains the length (in bytes) of the 
  133.               text data of the topic.
  134.  
  135. *******************************************************************************
  136. *                             Links Index Format                              *
  137. *******************************************************************************
  138.  
  139.   The links index table format is as follows :
  140.  
  141.   TOPIC     - 15 characters string key - the name of the topic that 
  142.               has the link.
  143.   SEQ       - integer (int) key - contains the sequential number of 
  144.               the link in the topic. (This way you can assign the links
  145.               order in the topic).
  146.   LINK      - 15 characters string key - the name of the link topic to
  147.               display if the link is chosen.
  148.   LINE      - integer (int) field - the line (from the start of the topic) 
  149.               this link is displayed on.
  150.   COL       - integer (int) field - the column this link is displayed on.
  151.   TXT       - 30 characters string field - the text to display on the line.
  152.  
  153. *******************************************************************************
  154. *                               Set-File-Format                               *
  155. *******************************************************************************
  156.  
  157.   The set file is a text file that contains one entry in each line, using
  158.  the following format :
  159.  
  160. topic-index-table name
  161. links-index-table name
  162. help-raw-data-file name
  163. number-of-topics
  164. length-of-file
  165.  
  166. *******************************************************************************
  167. *                               Implementation                                *
  168. *******************************************************************************
  169.  
  170.   Notice - The Paradox tables (Topic, Links) include one additional field
  171.  (wtGeneration) for future expansion purpose only.
  172.  
  173. *******************************************************************************
  174. *                                Distribution                                 *
  175. *******************************************************************************
  176.  
  177.   To distribute a database of your creation, compile the help definition
  178.  file, and include the HELPENG.EXE file with the .DB, .PX files, and the
  179.  .HDT file created by the compiler. Do not forget to include the 
  180.  Paradox Engine overlay file - PXENGINE.OVL .
  181.  
  182.   If you generated the Windows (/W+) help file, you can complile the 
  183.  .HPJ and .RTF generated file, and distribute the resulting .HLP .
  184.