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