home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / progmisc / hlpdk30.zip / HLPDK.HDF < prev    next >
Text File  |  1993-04-10  |  23KB  |  597 lines
  1. ;******************************************************************************
  2. ;                                 .linkColor                                  *
  3. ; set link color to lightGreen on blue (lightGreen (10) + 16 * blue (1) )     *
  4. ; and link high color to lightGreen on light gray (10 + 16 * 7)               *
  5. ;******************************************************************************
  6. .linkColor 26
  7. .linkhigh 122
  8.  
  9. ;******************************************************************************
  10. ;                                 .fixedFont                                  *
  11. ; use a fixed font for Windows target ..                                      *
  12. ;******************************************************************************
  13. .fixedFont
  14.  
  15. ;******************************************************************************
  16. ;                                  overview                                   *
  17. ;******************************************************************************
  18. .entry overview
  19. .title HLPDK System Overview
  20.  
  21.  ****************************************************************************
  22.  *                                                                          *
  23.  *                                 ISoft D&M                                *
  24.  *                                 POB. 5517                                *
  25.  *                           Coralville IA 52241                            *
  26.  *                                   U.S.A                                  *
  27.  *                                                                          *
  28.  **************************************************************************** 
  29.  
  30.   The Help Engine Development Kit is a system that allows you to create 
  31.  hyper-text database help systems with topics and hot links, using a simple
  32.  text editor and the help compiler. 
  33.  
  34.   The help databases can be distributed (free of charge) with the HELPENG
  35.  help engine display program. 
  36.  
  37.   If you own the Paradox Engine you can use the help databases with your
  38.  own programs. 
  39.  
  40.   The helpC compiler that is part of this development kit includes the
  41.  ability to create Windows Help source files from the same source the 
  42.  dos help sources are created!. Write your help once, and create help
  43.  databases for Dos and Windows!
  44.  
  45.         Supported Formats :
  46.  
  47.         Native, Win30, Win31, QuickHelp, THELP, TVHC, POPHELP
  48.  
  49.   Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  50.  Turbo Pascal programs, and use the help engine window in your pascal
  51.  programs.
  52.  
  53. Related Topics :
  54. ~Registration~register~
  55. ~Contact~contact~
  56. ~File List~fileList~
  57. ~Credits~credits~
  58. ~Help Engine~helpeng~
  59. ~Help Compiler~helpC~
  60. ~Quick Start~quickStart~
  61.  
  62. .end-entry
  63.  
  64. ;******************************************************************************
  65. ;                                  register                                   *
  66. ;******************************************************************************
  67. .entry register
  68. .title Registration
  69.  
  70.   The Help Engine Development Kit (HLPDK) is a shareware product, 
  71.  if you find this product valuable, please register it. 
  72.  This section describes the reasons you should register.
  73.  
  74.   By registering you will receive a complete discussion
  75.  of the help engine features, and many examples of usage. You will receive a 
  76.  diskette with the latest HLPDK version, and DPMI (dos protected mode)
  77.  versions of the help compiler and engine!.
  78.  
  79.   Your registration will help us to create the next versions of HLPDK, that
  80.  will include more options, and features, some of them might even be your
  81.  enhancement requests!.
  82.  
  83.   A point to consider - If you want to create Windows Help source files,
  84.  you will have to purchase a word processor that can output RTF files,
  85.  the WORD for Windows 2.0 package, for example, is listed at around $500!.
  86.  
  87. Related Topics :
  88. ~Contact~contact~
  89. ~Overview~overview~
  90. .end-entry
  91.  
  92. ;******************************************************************************
  93. ;                                   Contact                                   *
  94. ;******************************************************************************
  95. .entry Contact
  96.  
  97.   Please contact :
  98.  
  99.   ISoft D&M,  
  100.   P.O.B 5517
  101.   Coralville IA 52241,
  102.   U.S.A
  103.  
  104.   To contact the author directly : 
  105.  
  106.   Contact :     Loewy Ron,
  107.                 9 Haneveem st.
  108.                 Herzeliya, 46465
  109.                 ISRAEL.
  110.  
  111.   e-mail address : CompuServe - 100274,162
  112.  
  113. Related Topics :
  114. ~Regsiteration~register~
  115. ~Overview~overview~
  116. .end-entry
  117.  
  118. ;******************************************************************************
  119. ;                                  fileList                                   *
  120. ;******************************************************************************
  121. .entry fileList
  122. .title HPLDK Distribution File List
  123.  
  124.  This package contains the following files :
  125.  
  126.  HELPENG.EXE    - Help Engine.
  127.  HELPC.EXE      - Help Compiler.
  128.  HLPDK.DOC      - This file.
  129.  HELPC.DOC      - Help Compiler documentation
  130.  HELPDEMO.HDF   - Demo Help Project.
  131.  2NDDEMO.HDF    - Demo Help Project - file 2.
  132.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  133.  HLPDK.REG      - Registration file.
  134.  HLPDK.HDF      - Help Development Kit hypertext help database source.
  135.  HLPDK.HDT      - Help Development Kit help database file.
  136.  HLPDK.SET      - Help Development Kit help database file.
  137.  HLPDKTOP.*     - Help Development Kit help database files.
  138.  HLPDKLNK.*     - Help Development Kit help database files.
  139.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  140.  
  141. Related Topics :
  142. ~Overview~overview~
  143. ~Quick Start~quickStart~
  144. .end-entry
  145.  
  146. ;******************************************************************************
  147. ;                                   Credits                                   *
  148. ;******************************************************************************
  149. .entry Credits
  150.  
  151.   HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  152.   Paradox Engine 2.0, and Paradox Engine 3.0. 
  153.   (Trademarks of Borland International).
  154.  
  155.   Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  156.   of Microsoft Corp.
  157.  
  158.   The HELPENG program was written using the WINTEXT UI library, 
  159.   (c) 1991,93 Loewy Ron.
  160.  
  161.   THELP, HL and TVHC are Trademarks or copyrights Borland International.
  162.  
  163.   POPHELP is a copyright of TurboPower Software.
  164.  
  165.   TVHC support, and other ideas were suggested by MunLeong Chan.
  166.  
  167.   Parts of the Help Engine were generated using Ron Loewy's WTGEN CASE code
  168.   generator.
  169.  
  170.   Yaniv Golan helped me with beta-testing and debugging.
  171.  
  172. Related Topics :
  173. ~Overview~overview~
  174. .end-entry
  175.  
  176. ;******************************************************************************
  177. ;                                 quickStart                                  *
  178. ;******************************************************************************
  179. .entry quickStart
  180. .title Quick Start
  181.  
  182.   From the command line enter HELPC HELPDEMO to compile the demo help database.
  183.  
  184.   After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  185.  demo help database.
  186.  
  187.  If you want to compile for windows :
  188.  
  189.  from the command line enter HELPC HELPDEMO /W31
  190.  and after that HC31 HELPDEMO
  191.  (HC31 is the Microsoft Help Compiler)
  192.  from windows, open the HELPDEMO.HLP file from the windows help engine.
  193.  (Notice - if you do not have the HC help compiler from windows, we have
  194.   included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  195.   able to feel the quality of the output that can be generated, and decide
  196.   if you want to purchase the HC31 program. (Included with the SDK, BC++, 
  197.   TPW, BP and probably some other packages)).
  198.  
  199.  If you use windows 3.0, or want your help file to be compatible with
  200.  winHelp 3.0 use :
  201.         HELPC /W30 HELPDEMO
  202.         HC HELPDEMO
  203.  
  204.  To compile for THELP use : 
  205.         HELPC /TH+ HELPDEMO
  206.         HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
  207.  
  208.  To compile for QuickHelp : 
  209.         HELPC /QH+ HELPDEMO
  210.         HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
  211.  
  212.  To compile for TVHC :
  213.         HELPC /TV+ HELPDEMO
  214.         TVHC HELPDEMO.TXT
  215.  
  216.  To compile for POPHELP :
  217.         HELPC /PH+ HELPDEMO
  218.         MAKEHELP HELPDEMO
  219.  
  220. Related Topics :
  221. ~Overview~overview~
  222. ~File List~filelist~
  223. .end-entry
  224.  
  225. ;******************************************************************************
  226. ;                                   helpeng                                   *
  227. ;******************************************************************************
  228. .entry helpeng
  229. .title The Help Engine
  230.  
  231.   To start the help engine program enter HELPENG on the command line, and 
  232.  choose the help database you want to view from the list box. Use the Tab key
  233.  to cycle between hot-link words, and press Enter to go to that link.
  234.  
  235.   If you know the name of the SET file of the database you want to activate, you
  236.  can enter it on the command line, and the help engine will display it.
  237.  
  238.   To create a new help database please refer to the ~HELPC~helpc~ documentation
  239.  file.
  240.  
  241. Related Topics :
  242.  
  243. ~Trouble Shooting~Trouble~
  244. ~Overview~overview~
  245. .end-entry
  246.  
  247. ;******************************************************************************
  248. ;                                   Trouble                                   *
  249. ;******************************************************************************
  250. .entry Trouble
  251. .title Trouble Shooting
  252.  
  253.   If you receive some kind of an error message while using the help development
  254.  kit please refer to this section.
  255.  
  256.  tableOps: xxxx error message :
  257.  This message is generated by the Paradox Engine if an internal error occurs,
  258.  if you receive a message that is not understood (e.g. Table is busy), 
  259.  please try one of the following :
  260.  1. Try running the Help Compiler or the Help Engine with another input and 
  261.     notice if the problem exists, if it does, turn to the next entry,
  262.     otherwise try to see what the difference between the inputs is.
  263.  2. Check your free memory, try to move some TSR's from memory, or use the
  264.     protected mode compiler/engine available with the registered version.
  265.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE
  266.     with programs that use the Paradox Engine. If you receive a table busy
  267.     error, try to see if you have another program that uses the same table 
  268.     in another session (Windows/DESQview etc..).
  269.  4. PANIC - Please contact the distibuter/author for additional help.
  270.  
  271.  Microsoft's HC31 help compiler will generate a error in RTF file error :
  272.  1. Use a binary disk editor to look at the character at the position x - 1
  273.     in the RTF file (where x is the error position reported by HC31).
  274.  2. Try to replace that charqacter from a special PC oem character to a 
  275.     "standard" ascii character (such as *). If the problem still occurs,
  276.     please contact ISoft D&M/The author, otherwise - you probably came 
  277.     accross a character that HC31 can not handle. In that case - try using
  278.     HC300b (the one that generates winHelp 3.0 format), or delete these 
  279.     characters from your source HDF file.
  280.  
  281.  Borland's HL help linker will generate a FE02: Out Of Memory error :
  282.  1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the
  283.     screen's definitions.
  284.  
  285.   We have encountered some users that ran into problems, because they did 
  286.  not use the dos SHARE program. We advise that you will always load the 
  287.  SHARE program in your AUTOEXEC.BAT file.
  288.  
  289. Related Topics :
  290. ~Overview~overview~
  291. ~Help Engine~helpeng~
  292. ~Help Compiler~helpC~
  293. .end-entry
  294.  
  295. ;******************************************************************************
  296. ;                                    helpC                                    *
  297. ;******************************************************************************
  298. .entry helpC
  299. .title Help Compiler
  300.   The HELPC help compiler is a dos command line program that receives a 
  301.  help definition file (.HDF) and produce a help database. 
  302.  
  303.   The helpC command line is :
  304.  
  305.  HELPC source.fil [/Htopic-table-name] [/Llink-table-name] [/Ddata-file-name] 
  306.                   [/R-] [/W+] [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+]
  307.  
  308.   The output of the compiler is a set data file called source.SET, that
  309.  includes the names of the other help database components. 
  310.  
  311.   Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler 
  312.  will generate a .HPJ and .RTF files that can be used with the Microsoft 
  313.  HC (v3.00b) or HC31 help compiler, and output a .HLP windows help file!. 
  314.  
  315.   By default the help compiler produces a help cross reference report on the 
  316.  topics/links used in the database, if the /R- switch is set, no cross-ref
  317.  report will be generated, and no database integrity indicators will be
  318.  given.
  319.  
  320.  
  321.   IMPORTANT - Scan the output cross reference report for links defined, that
  322.  are not defined as topics!
  323.  
  324.   Notice - An additional switch is available that instructs the help compiler
  325.  to indicate it's parse and code generation progress. Use the /EP+ switch to
  326.  see that the helpC compiler is active. Please understand that the compile
  327.  process can take a long time, on complex help databases. This switch does
  328.  nothing more that ensure to you that the help compiler is alive. 
  329.  
  330. Related Topics :
  331. ~Overview~overview~
  332. ~Help Engine~helpeng~
  333. ~Technical Documentation~techdoc~
  334. .end-entry
  335.  
  336. ;******************************************************************************
  337. ;                                   techDoc                                   *
  338. ;******************************************************************************
  339. .entry techDoc
  340. .title Technical Documentation
  341.  
  342.   The Help Engine database is a combination of text that is read by the user,
  343.  and a Topic and Links database that allows the user to view the topics
  344.  he is interested in, using hyper-text methods.
  345.  
  346.  
  347.   Each help database is built of 4 file components : 
  348.  
  349.  1. Help Data File    - this file contains the raw text data.
  350.  2. Topic Index File  - a database table that contains the topic names, and
  351.                         the references to the topics in the Data File.
  352.  3. Links Index File  - a database table that contains the list of links 
  353.                         defined for each topic, and positional data.
  354.  4. Set Data File     - a database configuration file that contains the
  355.                         names of the 3 components defined above, and some 
  356.                         additional information.
  357.  
  358.   Version 1.x is the bare-bones version that includes only the basic
  359.  operations needed from a hyper-text database, this version is implemented
  360.  using the Paradox Engine V3.0 to manage the Topic and Link index tables.
  361.  
  362.   Version 2.x has a new field in the topic table - the title field, help
  363.  databases that were compiled with V1.x will not be executed by version
  364.  2.x, they will have to be re-compiled!.
  365.  
  366.   Version 3.x fields have different length - the databases have to be 
  367.  re-compiled.
  368.  
  369.   The format of the help database is released to the public domain, if
  370.  you implement a database viewer on this database structure, I would be
  371.  happy to receive a copy ..
  372.  
  373. Related Topics :
  374. ~Help Compiler~helpC~
  375. ~Help Engine~HelpEng~
  376. ~Help Definition Format~hdf~
  377. ~Topic Index Format~tif~
  378. ~Links Index Format~lif~
  379. ~Set File Format~sff~
  380.  
  381. .end-entry
  382.  
  383. ;******************************************************************************
  384. ;                                     hdf                                     *
  385. ;******************************************************************************
  386. .entry hdf
  387. .title Help Definition Format
  388.  
  389.   The help definition file format is as follows :
  390.  
  391. | remarks ...
  392. | remarks ...
  393. | 
  394. | .ENTRY topic-name
  395. | [.TITLE optional title for topic]
  396. | topic text and link reference .. 
  397. | topic text and link reference .. 
  398. | topic text and link reference .. 
  399. | topic text and link reference .. 
  400. | .END-ENTRY 
  401. | 
  402. | remarks ...
  403. | 
  404. | 
  405. | .ENTRY topic2-name
  406. | topic2 text ...
  407. | .END-ENTRY 
  408.  
  409.  
  410.   As can be seen - lines between the .ENTRY and .END-ENTRY keywords are
  411.  the lines processed by the help compiler, to create the help database, 
  412.  every other line is considered a remark, and is not parsed or evaluated by
  413.  the help compiler.
  414.  
  415.   The topic text and link reference lines are simple text lines, with
  416.  special link marks.
  417.  
  418.   A sample will provide the details :
  419.  
  420. This is a text help line that includes one ~~link~~link-topic-name~~ in it.
  421.  
  422.   This line will be displayed in the help engine program as :
  423.  
  424. This is a text help line that includes one link in it.
  425.  
  426.   The word "link" will be in a different color then the rest of the line, 
  427.  to indicate that this is a link. If the user hi-lights the link, and
  428.  presses Enter (or points the mouse cursor and clicks), the help engine will
  429.  look for a topic called "link-topic-name", and display it.
  430.  
  431.   Browse the HELPDEMO.HDF file for a demo of a help database definition file.
  432.  
  433.  Notes :
  434.  
  435.  1. The keywords .TOPIC and .END-TOPIC can be used instead of .ENTRY and
  436.   .  .END-ENTRY respectivly.
  437.  
  438.  2. Keywords are NOT case sensitive. (.topic = .TOPIC = .eNTry)
  439.  
  440.  3. The .TITLE keyword is optional. If no title is defined, the topic name
  441.     is used as a title. (just like in v1.x). 
  442.  
  443.  4. If you want the ~~ sign to appear in your help database, use ~~~~ in your
  444.     help source file. (e.g. "This is a ~~~~" will be "This is a ~~" in the final
  445.     help database.).
  446.  
  447. Additional commands include :
  448.  
  449. | .LINKCOLOR and .LINKHIGH - VGA colors of links in normal and high (selected)
  450. states in the native help format.
  451.  
  452. The syntax of these commands is :
  453.  
  454. | .LINKCOLOR x
  455.  
  456. or
  457.  
  458. | .LINKHIGH y
  459.  
  460. Where x and y are the color of the link, which is a combination of the color
  461. of the foreground with the color of the background multiplied by 16.
  462.  
  463. The colors that can be used for both fore and background are :
  464.  
  465.   Black     = 0
  466.   Blue      = 1
  467.   Green     = 2
  468.   Cyan      = 3
  469.   Red       = 4
  470.   Magenta   = 5
  471.   Brown     = 6
  472.   LightGray = 7
  473.  
  474. The colors that can be used only for the foreground are :
  475.  
  476.   DarkGray     = 8
  477.   LightBlue    = 9
  478.   LightGreen   = 10
  479.   LightCyan    = 11
  480.   LightRed     = 12
  481.   LightMagenta = 13
  482.   Yellow       = 14
  483.   White        = 15
  484.  
  485. For example : to set the normal color of a link to light green on blue, use
  486.  
  487. | .LINKCOLOR 26
  488.  
  489. where 26 = 10 + 16 * 1. (10 = light green, 1 = blue).
  490.  
  491. Creating Multiple Source Projects :
  492.  
  493. Use the .INCLUDE commands in the source of your .HDF file, to include an
  494. additional source file.
  495.  
  496. For Example :
  497.  
  498.  .. some stuff 
  499.  
  500. | .include 2ndfile.hdf
  501.  
  502.  .. additional stuff
  503.  
  504. will process 2NDFILE.HDF in the middle of our source file.
  505.  
  506. Please notice - .INCLUDE commands can be nested in your source file,
  507. it is however not recommended to nest them too deep, helpC does not
  508. close the input file when a .INCLUDEd file is processed, in order to
  509. minimize help generation time - there is however, a limit on the number
  510. of open files that can be used by a program - this is a limit set by dos.
  511.  
  512. GUI Font based targets :
  513.  
  514. The .FIXEDFONT command is used to define a non proportional font as the 
  515. default font of the help database. Currently the only targets affected
  516. by this command are windows winHelp v3.x. If you find that your help 
  517. databases are not aligned after they are converted to winHelp format, use 
  518. this command and re-compile. This command has no effect on targets that are 
  519. different from the targets mentioned before.
  520.  
  521. Related Topics :
  522. ~Technical Documentation~TechDoc~
  523.  
  524. .end-entry
  525.  
  526. ;******************************************************************************
  527. ;                                     tif                                     *
  528. ;******************************************************************************
  529. .entry tif
  530. .title Topic Index Format
  531.  
  532.   The topic index table format is as follows :
  533.  
  534.   TOPIC     - 40 charcters string key - this is the topic "name".
  535.   FILENAME  - 38 characters string field - includes the name of the
  536.               help raw data file. (Notice - V1.0 ignores the value of this 
  537.               field, it is here for future expansion).
  538.   START     - longint (long) field that contains the offset from the data file
  539.               start, to the start of the topics text data, in bytes.
  540.   LEN       - integer (int) field that contains the length (in bytes) of the 
  541.               text data of the topic.
  542.   TITLE     - 50 characters string key - the title of the topic.
  543.  
  544. Related Topics :
  545. ~Technical Documentation~TechDoc~
  546. ~Links Index Format~lif~
  547. .end-entry
  548.  
  549. ;******************************************************************************
  550. ;                                     lif                                     *
  551. ;******************************************************************************
  552. .entry lif
  553. .title Links Index Format
  554.  
  555.   The links index table format is as follows :
  556.  
  557.   TOPIC     - 40 characters string key - the name of the topic that 
  558.               has the link.
  559.   SEQ       - integer (int) key - contains the sequential number of 
  560.               the link in the topic. (This way you can assign the links
  561.               order in the topic).
  562.   LINK      - 40 characters string key - the name of the link topic to
  563.               display if the link is chosen.
  564.   LINE      - integer (int) field - the line (from the start of the topic) 
  565.               this link is displayed on.
  566.   COL       - integer (int) field - the column this link is displayed on.
  567.   TXT       - 60 characters string field - the text to display on the line.
  568.  
  569. Related Topics :
  570. ~Technical Documentation~TechDoc~
  571. ~Topic Index Format~tif~
  572. .end-entry
  573.  
  574. ;******************************************************************************
  575. ;                                     sff                                     *
  576. ;******************************************************************************
  577. .entry sff
  578. .title Set File Format
  579.  
  580.   The set file is a text file that contains one entry in each line, using
  581.  the following format :
  582.  
  583. topic-index-table name
  584. links-index-table name
  585. help-raw-data-file name
  586. number-of-topics
  587. length-of-file
  588. version-of-generating-compiler
  589. link-normal-color
  590. link-high-color
  591.  
  592. ~Technical Documentation~TechDoc~
  593. ~Topic Index Format~tif~
  594. ~Links Index Format~lif~
  595. .end-entry
  596.  
  597.