home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / progmisc / hlpdk60.zip / HELPC.DOC < prev    next >
Text File  |  1993-06-21  |  18KB  |  441 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 - Jun. 12, 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.  
  25.   Each help database is built of 5 components : 
  26.  
  27.  1. Help Data File    - this file contains the raw text data.
  28.  2. Topic Index       - a database table that contains the topic names, and
  29.                         the references to the topics in the Data File.
  30.  3. Links Index       - a database table that contains the list of links 
  31.                         defined for each topic, and positional data.
  32.  4. Keywords Index    - a database table that contains the list of keywords,
  33.                         and the topics that have these keywords.
  34.  5. Set Data File     - a database configuration file that contains the
  35.                         names of the 3 components defined above, and some 
  36.                         additional information.
  37.  
  38.   Version 1.x is the bare-bones version that includes only the basic
  39.  operations needed from a hyper-text database, this version is implemented
  40.  using the Paradox Engine V3.0 to manage the Topic and Link index tables.
  41.  
  42.   Version 2.x has a new field in the topic table - the title field, help
  43.  databases that were compiled with V1.x will not be executed by version
  44.  2.x, they will have to be re-compiled!.
  45.  
  46.   Version 3.x fields have different length - the databases have to be 
  47.  re-compiled.
  48.  
  49.   Version 5.0+ has a new entry in the help set file, database have to be
  50.  re-compiled, ot the value 128 should be added in the last line of the help
  51.  set file, and the version number should be changed to 5.0.
  52.  
  53.   Version 6.0+ has added the keyword support - a new database table is added,
  54.  and a new set format is defined. Help databases will have to be re-compiled
  55.  for Natice targets.
  56.  
  57.   The format of the help database is released to the public domain, if
  58.  you implement a database viewer on this database structure, I would be
  59.  happy to receive a copy ..
  60.  
  61. *******************************************************************************
  62. *                               Compiler Usage                                *
  63. *******************************************************************************
  64.  
  65.   The HELPC help compiler is a dos command line program that receives a 
  66.  help definition file (.HDF) and produce a help database. 
  67.  
  68.   The helpC command line is :
  69.  
  70.  HELPC source.fil [/Htopic-table-name] [/Llink-table-name] [/Ddata-file-name] 
  71.                   [/Kkeywords-table-name] [/R-]  [/ST-] [/CS+] [/EP+]
  72.                   [/W+]  [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+] [/XD+]
  73.                   [/PX+] [/MT+] [/OS2]
  74.  
  75.   The output of the compiler is a set data file called source.SET, that
  76.  includes the names of the other help database components. 
  77.  
  78.   Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler 
  79.  will generate a .HPJ and .RTF files that can be used with the Microsoft 
  80.  HC (v3.00b) or HC31 help compiler, and output a .HLP windows help file!. 
  81.  
  82.   By default the help compiler produces a help cross reference report on the 
  83.  topics/links used in the database, if the /R- switch is set, no cross-ref
  84.  report will be generated, and no database integrity indicators will be
  85.  given.
  86.  
  87.  
  88.   IMPORTANT - Scan the output cross reference report for links defined, that
  89.  are not defined as topics!
  90.  
  91.   Notice - An additional switch is available that instructs the help compiler
  92.  to indicate it's parse and code generation progress. Use the /EP+ switch to
  93.  see that the helpC compiler is active. Please understand that the compile
  94.  process can take a long time, on complex help databases. This switch does
  95.  nothing more that ensure to you that the help compiler is alive. 
  96.  
  97.   The /ST switch defines if the topic name defined in the .TOPIC command
  98.  can include embeded spaces. By default this switch is set to /ST- (No
  99.  embedded spaces).
  100.  
  101.   The /CS switch turns Topics and Links case sensativity to ON. Use this
  102.  switch with care - Only if you must have a lower/mixed case index in THELP
  103.  or POPHELP use this switch. Notice that help databases that compile fine
  104.  with case sensativity set to off, might fail to do so in case sensativity
  105.  on. By deafult this switch is set to off (-).
  106.  
  107.   The /XD switch generates code to the MDVXHELP help compiler, available
  108.  free in the file DVXHLP10.ZIP on the internet. When this switch is given,
  109.  a set of cover and section files is generated, as well as a response
  110.  file that should be used to compile the help database.
  111.  
  112.   The /OS2 switch generates IPF source code. You must compile the generated code 
  113.  with IPFC, from within an OS/2 session (window or full screen).
  114.  
  115. *******************************************************************************
  116. *                                Command Line                                 *
  117. *******************************************************************************
  118.  
  119.   The compiler switches are defined on the command line. These switches can
  120.  be placed before and after the source file name. The compiler will look for
  121.  a file named HELPC.CFG in the current directory, and process it before any
  122.  command line switches are processed. 
  123.  
  124.   Switches on the command line will over-ride switches set before them, on the
  125.  command line or in one of the response options file.
  126.  
  127.   Response option files can be specified by prefixing their name with a @ sign.
  128.  
  129.  Examples :
  130.  
  131.  If our HELPC.CFG file, in the current directory is :
  132.  
  133. /W31
  134. /R-
  135.  
  136.  And we compile using HELPC HELPDEMO
  137.  
  138.  The helpdemo.hdf file will be compiled, with the target set to winhelp 3.1
  139.  and no cross-reference report.
  140.  
  141.  Compile using HELPC HELPDEMO /r+
  142.  
  143.  Will create winhelp 3.1 sources, but a report will be generated.
  144.  
  145.  Compile using HELPC /w- HELPDEMO
  146.  
  147.  Will generate native format help database, no report is generated.
  148.  
  149.  If we have a file called MYSWITCH.CFG with the following lines :
  150.  
  151. /TH+
  152. /ST-
  153. /CS+
  154.  
  155.  And we compile using HELPC @MYSWITCH.CFG HELPDEMO
  156.  
  157.  A THELP source, using Long Topic Names, with case sensativity will be 
  158.  generated, no cross reference report is generated. (HELPC.CFG contains /r-)
  159.  
  160. *******************************************************************************
  161. *                           Help Definition Format                            *
  162. *******************************************************************************
  163.  
  164.   The help definition file format is as follows :
  165.  
  166. remarks ...
  167. remarks ...
  168.  
  169. .ENTRY topic-name
  170. [.TITLE optional title for topic]
  171. [.KEYWORDS optional keywords for topic]
  172. topic text and link reference .. 
  173. topic text and link reference .. 
  174. topic text and link reference .. 
  175. topic text and link reference .. 
  176. .END-ENTRY 
  177.  
  178. remarks ...
  179.  
  180.  
  181. .ENTRY topic2-name
  182. [.KEYWORDS keyword1 keyword2 ..]
  183. [.PARAGRAPH]
  184. topic 2 text and link reference .. 
  185. topic 2 text and link reference .. 
  186. topic 2 text and link reference .. 
  187. [.END-PARAGRAPH]
  188. additional topic2 text ...
  189. .END-ENTRY 
  190.  
  191.  
  192.   As can be seen - lines between the .ENTRY and .END-ENTRY keywords are
  193.  the lines processed by the help compiler, to create the help database, 
  194.  every other line is considered a remark, and is not parsed or evaluated by
  195.  the help compiler.
  196.  
  197.   The topic text and link reference lines are simple text lines, with
  198.  special link marks.
  199.  
  200.   A sample will provide the details :
  201.  
  202. This is a text help line that includes one ~link~link-topic-name~ in it.
  203.  
  204.   This line will be displayed in the help engine program as :
  205.  
  206. This is a text help line that includes one link in it.
  207.  
  208.   The word "link" will be in a different color then the rest of the line, 
  209.  to indicate that this is a link. If the user hi-lights the link, and
  210.  presses Enter (or points the mouse cursor and clicks), the help engine will
  211.  look for a topic called "link-topic-name", and display it.
  212.  
  213.   Browse the HELPDEMO.HDF file for a demo of a help database definition file.
  214.  
  215.  Notes :
  216.  
  217.  1. The keywords .TOPIC and .END-TOPIC can be used instead of .ENTRY and
  218.     .END-ENTRY respectivly.
  219.  
  220.     An equivelent pair of keywords are .TOP and .ENDTOP .
  221.  
  222.  2. Keywords are NOT case sensitive. (.topic = .TOPIC = .eNTry)
  223.  
  224.  3. The .TITLE keyword is optional. If no title is defined, the topic name
  225.     is used as a title. (just like in v1.x). 
  226.  
  227.  4. If you want the ~ sign to appear in your help database, use ~~ in your
  228.     help source file. (e.g. "This is a ~~" will be "This is a ~" in the final
  229.     help database.).
  230.  
  231.  5. The Optional .PARAGRAPH and .END-PARAGRAPH commands in the help topic text,
  232.     specify the start and the end of a paragraph. This feature is currently 
  233.     supported only for winhelp and IPF sources. This feature is important if you 
  234.     want to create long paragraphs that will wrap correctly when a user resizes
  235.     the help window. It is advized ALWAYS to use this feature for paragraphs,
  236.     future versions of the Help Development Kit will allow greater formatting
  237.     control over paragraphs using this mechanism.
  238.  
  239.     The .PAR and .ENDPAR keywords can be used instead of the .PARAGRAPH and
  240.     .END-PARAGRAPH keywords.
  241.  
  242.  6. When a .PARAGRAPH is issued, a .END-PARAGRAPH MUST be specified at the
  243.     end of the paragraph. These commands must appear as the first words in
  244.     a line. The text after the .PARAGRAPH command is NOT part of the text 
  245.     of the help topic.
  246.  
  247.  7. The optional .KEYWORDS command can appear after the .TITLE command
  248.     (If there is one), or the .TOPIC header (otherwise), Use this command
  249.     to help the user search for sets of topics that are connected to a 
  250.     specific keyword. The syntax of this comand is :
  251.     .KEYWORDS keyword-1 keyword-2 ... 
  252.  
  253. Additional commands include :
  254.  
  255. .TEXTCOLOR, .LINKCOLOR and .LINKHIGH - VGA colors of text and links in normal 
  256. and high (selected) states in the native help format.
  257.  
  258. The syntax of these commands is :
  259.  
  260. .TEXTCOLOR w 
  261.  
  262. or 
  263.  
  264. .LINKCOLOR x
  265.  
  266. or
  267.  
  268. .LINKHIGH y
  269.  
  270. Where w, x and y are the color of the text/link, which is a combination of the 
  271. color of the foreground with the color of the background multiplied by 16.
  272.  
  273. The colors that can be used for both fore and background are :
  274.  
  275.   Black     = 0
  276.   Blue      = 1
  277.   Green     = 2
  278.   Cyan      = 3
  279.   Red       = 4
  280.   Magenta   = 5
  281.   Brown     = 6
  282.   LightGray = 7
  283.  
  284. The colors that can be used only for the foreground are :
  285.  
  286.   DarkGray     = 8
  287.   LightBlue    = 9
  288.   LightGreen   = 10
  289.   LightCyan    = 11
  290.   LightRed     = 12
  291.   LightMagenta = 13
  292.   Yellow       = 14
  293.   White        = 15
  294.  
  295. For example : to set the normal color of a link to light green on blue, use
  296.  
  297. .LINKCOLOR 26
  298.  
  299. where 26 = 10 + 16 * 1. (10 = light green, 1 = blue).
  300.  
  301. Creating Multiple Source Projects :
  302.  
  303. Use the .INCLUDE commands in the source of your .HDF file, to include an
  304. additional source file.
  305.  
  306. For Example :
  307.  
  308.  .. some stuff 
  309.  
  310. .include 2ndfile.hdf
  311.  
  312.  .. additional stuff
  313.  
  314. will process 2NDFILE.HDF in the middle of our source file.
  315.  
  316. Please notice - .INCLUDE commands can be nested in your source file,
  317. it is however not recommended to nest them too deep, helpC does not
  318. close the input file when a .INCLUDEd file is processed, in order to
  319. minimize help generation time - there is however, a limit on the number
  320. of open files that can be used by a program - this is a limit set by dos.
  321.  
  322. GUI Font based targets :
  323.  
  324. The .FIXEDFONT command is used to define a non proportional font as the 
  325. default font of the help database. Currently the only targets affected
  326. by this command are windows winHelp v3.x. If you find that your help 
  327. databases are not aligned after they are converted to winHelp format, use 
  328. this command and re-compile. This command has no effect on targets that are 
  329. different from the targets mentioned before.
  330.  
  331. The .PCFONT command is used to define a font that has the standard pc 
  332. character set (Terminal - in windows). If you convert a text based 
  333. database that uses the PC's special characters, use this command to
  334. set the default font. This command has no effect on targets that are 
  335. different from the targets mentioned before.
  336.  
  337.  
  338. *******************************************************************************
  339. *                             Topic Index Format                              *
  340. *******************************************************************************
  341.  
  342.   The topic index table format is as follows :
  343.  
  344.   TOPIC     - 40 charcters string key - this is the topic "name".
  345.   FILENAME  - 38 characters string field - includes the name of the
  346.               help raw data file. (Notice - V1.0 ignores the value of this 
  347.               field, it is here for future expansion).
  348.   START     - longint (long) field that contains the offset from the data file
  349.               start, to the start of the topics text data, in bytes.
  350.   LEN       - integer (int) field that contains the length (in bytes) of the 
  351.               text data of the topic.
  352.   TITLE     - 50 characters string key - the title of the topic.
  353.  
  354. *******************************************************************************
  355. *                             Links Index Format                              *
  356. *******************************************************************************
  357.  
  358.   The links index table format is as follows :
  359.  
  360.   TOPIC     - 40 characters string key - the name of the topic that 
  361.               has the link.
  362.   SEQ       - integer (int) key - contains the sequential number of 
  363.               the link in the topic. (This way you can assign the links
  364.               order in the topic).
  365.   LINK      - 40 characters string key - the name of the link topic to
  366.               display if the link is chosen.
  367.   LINE      - integer (int) field - the line (from the start of the topic) 
  368.               this link is displayed on.
  369.   COL       - integer (int) field - the column this link is displayed on.
  370.   TXT       - 60 characters string field - the text to display on the line.
  371.  
  372. *******************************************************************************
  373. *                            Keywords.Index.Table                             *
  374. *******************************************************************************
  375.  
  376.   The keywords index table format is as follows :
  377.  
  378.   KEYWORD   - 40 characters string key - the keyword.
  379.   TOPIC     - 40 characters string key - the topic name that this keyword is 
  380.               assigned to.
  381.  
  382.   Notice - the database will include a row for each keyword, that has the 
  383.   TOPIC field blank. This is used to display the first list of keywords, that
  384.   if chosen, will display the 2nd list of topics that have the chosen keyword
  385.   in their .KEYWORDS definition.
  386.  
  387. *******************************************************************************
  388. *                               Set-File-Format                               *
  389. *******************************************************************************
  390.  
  391.   The set file is a text file that contains one entry in each line, using
  392.  the following format :
  393.  
  394. help-database-engine
  395. version-of-generating-compiler
  396. topic-index-table name
  397. links-index-table name
  398. keyword-index-table-name
  399. help-raw-data-file name
  400. number-of-topics
  401. length-of-file
  402. link-normal-color
  403. link-high-color
  404. text-normal-color
  405.  
  406. The help-database-engine values available today are DEF=Paradox and 
  407. MEM=memory Tables.
  408.  
  409. *******************************************************************************
  410. *                               Implementation                                *
  411. *******************************************************************************
  412.  
  413.   Notice - The Paradox tables (Topic, Links) include one additional field
  414.  (wtGeneration) for future expansion purpose only.
  415.  
  416. *******************************************************************************
  417. *                                Distribution                                 *
  418. *******************************************************************************
  419.  
  420.   To distribute a database of your creation, compile the help definition
  421.  file, and include the HELPENG.EXE file with the .DB, .PX files, and the
  422.  .HDT file created by the compiler. 
  423.  
  424.   If you use the Native Mem Format, compile using the /MT+ switch, and
  425.  distribute HE.EXE with the .SET, .HDT and .HDX files created.
  426.  
  427.   If you generated the Windows (/W30, /W31) help file, you can complile the 
  428.  .HPJ and .RTF generated file, and distribute the resulting .HLP .
  429.  
  430.   If you generate QH, THELP, POPHELP or TVHC use these packages compilers to
  431.  compile you sources into native binary codes. (helpMake, HL, makeHelp and TVHC)
  432.  
  433.   To Generate Help databases for DESQview/X, use the MDVXHELP compiler
  434.  that can be found on the internet in the file DVXHLP10.ZIP.
  435.  
  436.   Distribute the .INF files that IPFC creates from the .IPF sources generated,
  437.  if you compile to OS/2.
  438.  
  439.   For examples on these compiler's command lines please refer to the quick
  440.  start section of HLPDK.DOC, or to your compiler's documentation.
  441.