home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / progmisc / hlpdk60.zip / HLPDK.DOC < prev    next >
Text File  |  1993-06-21  |  36KB  |  763 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 5517                                ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. *******************************************************************************
  12. * HLPDK- Help Engine Dev. Kit : helpEng Doc V6.0                              *
  13. * LAST UPDATE - Jun. 21, 1993. (c) 1992,93 - Loewy Ron.                       *
  14. *******************************************************************************
  15.  
  16.  
  17.  
  18.         RL Help Engines.
  19.         
  20.         Help Compiler, Run-Time help engines and docs.
  21.  
  22.         Support for Dos, OS/2, DESQview/X & Windows.
  23.  
  24.         Supported Formats :
  25.  
  26.         Native(PX), Native(Mem), Win30, Win31, QuickHelp, 
  27.         THELP, TVHC, POPHELP, DESQview/X, OS/2
  28.  
  29.         "Write Once, Help Many!"
  30.  
  31.                    
  32. *******************************************************************************
  33. *                                  File-List                                  *
  34. *******************************************************************************
  35.  
  36.  This package contains the following files :
  37.  
  38.  HELPENG.EXE    - Help Engine.
  39.  HELPC.EXE      - Help Compiler.
  40.  HE.EXE         - Mem Help Engine.
  41.  HLPDK.DOC      - This file.
  42.  HELPC.DOC      - Help Compiler documentation
  43.  HELPDEMO.HDF   - Demo Help Project.
  44.  2NDDEMO.HDF    - Demo Help Project - file 2.
  45.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  46.  HLPDK.REG      - Registration file.
  47.  HLPDK.HDF      - Help Development Kit hypertext help database source.
  48.  HLPDK.HDT      - Help Development Kit help database file.
  49.  HLPDK.SET      - Help Development Kit help database file.
  50.  HLPDKTOP.*     - Help Development Kit help database files.
  51.  HLPDKLNK.*     - Help Development Kit help database files.
  52.  HLPDKKEY.*     - Help Development Kit help database files.
  53.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  54.  
  55. *******************************************************************************
  56. *                                Why Register                                 *
  57. *******************************************************************************
  58.  
  59.   The Help Engine Development Kit (HLPDK) is a shareware product, 
  60.  if you find this product valuable, please register it. 
  61.  This section describes the reasons you should register.
  62.  
  63.   By registering you will receive a complete discussion
  64.  of the help engine features, and many examples of usage. You will receive a 
  65.  diskette with the latest HLPDK version, and DPMI (dos protected mode)
  66.  versions of the help compiler and engines!. (The memory version of the
  67.  help engine can display huge databases only in the protected mode
  68.  version).
  69.  
  70.   Your registration will help us to create the next versions of HLPDK, that
  71.  will include more options, and features, some of them might even be your
  72.  enhancement requests!.
  73.  
  74.   A point to consider - If you want to create Windows Help source files,
  75.  you will have to purchase a word processor that can output RTF files,
  76.  the WORD for Windows 2.0 package, for example, is listed at around $500!.
  77.  
  78. *******************************************************************************
  79. *                                  What's New                                 *
  80. *******************************************************************************
  81.  
  82.   Version 6.0
  83.  
  84.         - The helpEng and HE help engines will not terminate abnormally when
  85.           the Print or Save Topic commands are given with an empty desktop,  
  86.           the help engine will issue a warning message and continue instead.
  87.  
  88.         - The Help Engines will restore the initial text cursor size upon 
  89.           termination. This was noticed by Prof. Timo Salmi of Vaasa, Finland.
  90.  
  91.         - Added the Navigate menu to the help engines. Use this menu's entries
  92.           to navigate the help database - choose from the overview screen, 
  93.           and index entries.
  94.  
  95.         - Added keyword support to help databases using the .KEYWORDS help
  96.           definition file syntax. Use this command to add multiple indexes,
  97.           or search by keywords to your help databases.
  98.           In this version of the helpC compiler, Native (/PX+, /MT+), winHelp 
  99.           (/W30, /W31) and THELP (/TH+) sources support the keyWords defined 
  100.           for topics. 
  101.           Please refer to the HELPC.DOC file for a formal discussion of this 
  102.           feature.
  103.  
  104.         - The set format file has been changed to support the keyword 
  105.           tables, old databases will have to be re-compiled for use with
  106.           the help engines.
  107.  
  108.         - Added the ALT-S (Search command) to the help windows in the HELPENG
  109.           program. Use this command to search on the keywords defined in the
  110.           help database.
  111.  
  112.         - Added OS/2 IPF source generation. Use the /os2 switch of the helpC
  113.           compiler to generate code to the OS/2 IPFC compiler. Paragraph 
  114.           support (.par .. .endpar/.paragraph .. .end-paragraph) is available
  115.           in this target as well.
  116.  
  117.         - The number of input lines displayed as processed by the helpC compiler 
  118.           include the actual number of input lines in the source HDF file, vs.
  119.           topic text lines only in the previous version.
  120.  
  121.         - helpC error reporting has been improved to include the line number
  122.           the error occured on.
  123.  
  124. *******************************************************************************
  125. *                                Introduction                                 *
  126. *******************************************************************************
  127.  
  128.   The Help Engine Development Kit is a system that allows you to create 
  129.  hyper-text database help systems with topics and hot links, using a simple
  130.  text editor and the help compiler. 
  131.  
  132.   The help databases can be distributed (free of charge) with the HELPENG or
  133.  HE help engine display programs. 
  134.  
  135.   The help database format is release to the public domain, if you own the 
  136.  Paradox Engine you can use the help databases with your own programs. 
  137.  
  138.   Borland Pascal Users can purchase the Help Engine Source Code even
  139.  for Applications that do not use the paradox engine, using the Native Mem
  140.  format.
  141.  
  142.   The helpC compiler that is part of this development kit includes the
  143.  ability to create Windows Help source files from the same source the 
  144.  dos help sources are created!. Write your help once, and create help
  145.  databases for Dos, Windows, OS/2 and DESQview/X !
  146.  
  147.   Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  148.  Turbo Pascal programs, and use the help engine window in your pascal
  149.  programs.
  150.  
  151. *******************************************************************************
  152. *                                    Setup                                    *
  153. *******************************************************************************
  154.  
  155.   Copy the files in this package to a directory of your choice.
  156.  
  157. *******************************************************************************
  158. *                                 Quick Start                                 *
  159. *******************************************************************************
  160.  
  161.   From the command line enter HELPC HELPDEMO to compile the demo help database.
  162.  
  163.   After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  164.  demo help database.
  165.  
  166.  If you want to compile for windows :
  167.  
  168.  from the command line enter HELPC HELPDEMO /W31
  169.  and after that HC31 HELPDEMO
  170.  (HC31 is the Microsoft Help Compiler)
  171.  from windows, open the HELPDEMO.HLP file from the windows help engine.
  172.  (Notice - if you do not have the HC help compiler from windows, we have
  173.   included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  174.   able to feel the quality of the output that can be generated, and decide
  175.   if you want to purchase the HC31 program (Included with the SDK, BC++, 
  176.   TPW, BP and probably some other packages), or download it from one of the 
  177.   sites Microsoft had uploaded it to).
  178.  
  179.  If you use windows 3.0, or want your help file to be compatible with
  180.  winHelp 3.0 use :
  181.         HELPC /W30 HELPDEMO
  182.         HC HELPDEMO
  183.  
  184.  To compile for THELP use : 
  185.         HELPC /TH+ HELPDEMO
  186.         HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
  187.  
  188.  To compile for QuickHelp : 
  189.         HELPC /QH+ HELPDEMO
  190.         HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
  191.  
  192.  To compile for TVHC :
  193.         HELPC /TV+ HELPDEMO
  194.         TVHC HELPDEMO.TXT
  195.  
  196.  To compile for POPHELP :
  197.         HELPC /PH+ HELPDEMO
  198.         MAKEHELP /Q HELPDEMO
  199.  
  200.  To compile for DESQview/X :
  201.         HELPC /XD+ HELPDEMO
  202.         MDVXHELP HELPDEMO.HLP @HELPDEMO.LST
  203.         COPY HELPDEMO.HLP d:\DVX\HELP
  204.  
  205.  To compile for Native Mem Format :
  206.         HELPC /MT+ HELPDEMO
  207.  (Use HE HELPDEMO to view that database).
  208.  
  209.  To compile for IPF (OS/2) format :
  210.         HELPC /OS2 HELPDEMO
  211.         Switch to an OS/2 session.
  212.         IPFC /INF HELPDEMO
  213.  (Use the VIEW Command to browse the database).
  214.  
  215. *******************************************************************************
  216. *                                  Operation                                  *
  217. *******************************************************************************
  218.  
  219.   To start the help engine program enter HELPENG on the command line, and 
  220.  choose the help database you want to view from the list box. Use the Tab key
  221.  to cycle between hot-link words, and press Enter to go to that link.
  222.  
  223.   If you know the name of the SET file of the database you want to activate, you
  224.  can enter it on the command line, and the help engine will display it.
  225.  
  226.   If you have a mouse, you can use it to point at the hi-lighted links, and 
  227.  activate them by pressing the left mouse button.
  228.  
  229.   Press the ALT-T key combination to choose from a list of TOPICS in the 
  230.  database, Press ALT-B to go back to the previous displayed TOPIC, Press
  231.  ALT-X to exit the help engine.
  232.  
  233.   The exit command can be given by pressing the right mouse button.
  234.  
  235.   Use F10 to open the menubar, and use the arrow keys to navigate the 
  236.  options. When you find the option you are interested in, Use the Enter
  237.  key to execute it, or the Esc key to cancel. The menubar can be navigated
  238.  using the mouse as well.
  239.  
  240.   To create a new help database please refer to the HELPC documentation
  241.  file.
  242.  
  243.   If you want to use the Native Mem Format Databases, Please use the supplied
  244.  HE.EXE program. 
  245.  
  246. *******************************************************************************
  247. *                                  Warranty                                   *
  248. *******************************************************************************
  249.  
  250.   There is no warranty what so ever, The package is supplied as is,
  251.  The distributor (ISoft D&M), or the author (Loewy Ron), are not, 
  252.  and will not be responsible for any damages, lost profits, 
  253.  or inconveniences caused by the use, or inability to use this package. 
  254.  The use of the program is at your own risk. 
  255.  By using (or attempting to use) the package you agree to this.
  256.  
  257. *******************************************************************************
  258. *                                   General                                   *
  259. *******************************************************************************
  260.  
  261.   HLPDK is distributed by ISoft D&M, P.O.B. 5517 CORALVILLE IA 52241, U.S.A.
  262.  
  263.   HLPDK is (c) copyrighted by Loewy Ron, 1992, 93.
  264.  
  265.   HLPDK is a shareware program, please register your copy. 
  266.   To register your copy of HLPDK please refer to the supplied
  267.   HLPDK.REG file. 
  268.  
  269.   Other programs distributed by ISoft D&M are described in the supplied  
  270.   PROGRAMS.TXT file.
  271.  
  272.  
  273. *******************************************************************************
  274. *                                   Contact                                   *
  275. *******************************************************************************
  276.  
  277.   Please contact :
  278.  
  279.   ISoft D&M,  
  280.   P.O.B 5517
  281.   Coralville IA 52241,
  282.   U.S.A
  283.  
  284.   To contact the author directly : 
  285.  
  286.   Contact :     Loewy Ron,
  287.                 9 Haneveem st.
  288.                 Herzeliya, 46465
  289.                 ISRAEL.
  290.  
  291.   e-mail address : CompuServe - 100274,162
  292.  
  293. *******************************************************************************
  294. *                              Trouble Shooting                               *
  295. *******************************************************************************
  296.  
  297.   If you receive some kind of an error message while using the help development
  298.  kit please refer to this section.
  299.  
  300.  tableOps: xxxx error message :
  301.  This message is generated by the Paradox Engine if an internal error occurs,
  302.  if you receive a message that is not understood (e.g. Table is busy), 
  303.  please try one of the following :
  304.  1. Try running the Help Compiler or the Help Engine with another input and 
  305.     notice if the problem exists, if it does, turn to the next entry,
  306.     otherwise try to see what the difference between the inputs is.
  307.  2. Check your free memory, try to move some TSR's from memory, or use the
  308.     protected mode compiler/engine available with the registered version.
  309.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE
  310.     with programs that use the Paradox Engine. If you receive a table busy
  311.     error, try to see if you have another program that uses the same table 
  312.     in another session (Windows/DESQview etc..).
  313.  4. PANIC - Please contact the distibuter/author for additional help.
  314.  
  315.  Microsoft's HC31 help compiler will generate a error in RTF file error :
  316.  1. Re-compile using HELPC 4.0+. This should solve the problem, if the problem
  317.     still exists - please try steps 2 and 3, and notify the author. 
  318.  2. Use a binary disk editor to look at the character at the position x - 1
  319.     in the RTF file (where x is the error position reported by HC31).
  320.  3. Try to replace that charqacter from a special PC oem character to a 
  321.     "standard" ascii character (such as *). If the problem still occurs,
  322.     please contact ISoft D&M/The author, otherwise - you probably came 
  323.     accross a character that HC31 can not handle. In that case - try using
  324.     HC300b (the one that generates winHelp 3.0 format), or delete these 
  325.     characters from your source HDF file.
  326.  
  327.  Borland's HL help linker will generate a FE02: Out Of Memory error :
  328.  1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the
  329.     screen's definitions.
  330.  
  331.  Borland's HL help linker will complain about undefined context numbers :
  332.  1. You probably have a contents.h file in the current directory, that hl
  333.     tries to use to bind the help topics to Borland's IDE on-line help,
  334.     try renaming this file, and re-compile with HL.
  335.  
  336.  HelpC will not create the database when compiling to Native Mem (/MT+) :
  337.  1. Try compiling with report generation on (/R+) to Native Paradox
  338.     (/PX+) format. If there are errors, consult the HELPC.LST file, fix 
  339.     them, and re-try.
  340.  2. If the database is BIG, you might not have enough memory - Remember that
  341.     Native Mem tables are generated in memory. You will have to use the
  342.     HelpCX protected mode compiler (Available with the registered version).
  343.  
  344.  HelpEng/HE will complain on an old-database when tring to open a help
  345.  database with it :
  346.  1. Re-Compile the database using helpC.
  347.  
  348.  HelpEng/HE will complain on un-supported database format, when trying to
  349.  open a database :
  350.  1. HelpEng can not display Native Mem databases, and HE can not display
  351.     Native PX databases. Use the other help engine supplied.
  352.  
  353.  HE will not be able to open a Native Mem database :
  354.  1. Use the protected mode HEX help engine. (Available for registered users).
  355.  
  356.  Where is HL - Borland's Help Linker :
  357.  1. HL is not included with Borland C++ or Borland Pascal, Borland sells an
  358.     aditional package called Borland Open Architecture (and Borlad OA for 
  359.     Pascal) that include among other things - the THELP help linker.
  360.  
  361.   We have encountered some users that ran into problems, because they did 
  362.  not use the dos SHARE program. We advise that you will always load the 
  363.  SHARE program in your AUTOEXEC.BAT file.
  364.  
  365. *******************************************************************************
  366. *                                   History                                   *
  367. *******************************************************************************
  368.  
  369.  
  370.   Version 1.0 
  371.  
  372.         - First Version, Written for TXS V3.0 help system, 
  373.           as part of the WTGEN project, and generalized.
  374.  
  375.   Version 1.1
  376.  
  377.         - The Help Engine ALT-X (EXIT) command restores the screen
  378.           upon termination.
  379.  
  380.         - Added /R switch for the helpC help compiler.
  381.  
  382.         - From this version the helpC compiler can generate source
  383.           files for the Microsoft help compiler (HC) from the
  384.           SAME source .HDF). If the /w+ switch is specified,
  385.           the helpC compiler will create a .HPJ and .RTF files
  386.           to create the Windows .HLP file.
  387.  
  388.         - Includes a compiled version of the help demo database for
  389.           Windows WINHELP program. (View this if you do not have the
  390.           Microsoft HC Windows Help Compiler, to see the output that
  391.           can be generated with the helpC compiler, as a source to the 
  392.           HC compiler).
  393.  
  394.   Version 1.2
  395.  
  396.         - Windows RTF files will now display special characters ({, }, \),
  397.           by prefixing them with the RTF over-ride character (\), when the
  398.           /W+ switch is given to the helpC compiler.
  399.  
  400.         - helpC and helpEng were converted from TP6 to BP7.
  401.  
  402.         - The help engine and help compiler use the Paradox Engine V3.0 from
  403.           this release. (No need to keep your old PXENGINE.OVL file anymore).
  404.  
  405.         - Added the /W30 and /W31 switches to the helpC compiler. Use these
  406.           switches to set the output for the HC30 and HC31 Microsoft Windows
  407.           help compilers.
  408.  
  409.         - The help window scroll bars are are shown after a link is executed.
  410.           (A bug fix).
  411.  
  412.         - Added "Trouble Shooting" section to this document.
  413.  
  414.         - helpC and helpEng have DPMI versions to handle large projects.
  415.           (Available only with the registered version).
  416.  
  417.   Version 2.0
  418.  
  419.         - The help engine will display a new topic from the first line, and
  420.           not from the place that shows the current active link.
  421.  
  422.         - The help window in the help engine program can now be scrolled to
  423.           regions of the help topic, that do not include the current, or
  424.           any link.
  425.  
  426.         - A mouse click on a link, when the left-column is not 1 is recognized
  427.           as it should be.
  428.  
  429.         - The helpC help compiler will recognize .TOPIC and .END-TOPIC as
  430.           topic declaration keywords, as well as the .ENTRY and .END-ENTRY
  431.           that were used until this version.
  432.  
  433.         - The help topic table has a new field in it - the title field, using
  434.           this field you can specify the title of the help window, when it
  435.           displays a topic. Because of this field, databases created with
  436.           older versions of the help development kit will have to be 
  437.           re-compiled. (Please refer to HELPC.DOC).
  438.  
  439.         - The helpC help compiler will accept .TITLE keyword after the
  440.           .ENTRY (.TOPIC) line, to define a title to a topic window.
  441.  
  442.         - Added support for Microsoft Quick Help sources, and Borland THELP
  443.           sources generation.
  444.  
  445.         - The helpC compiler will translate ~~ in the source help definition
  446.           into a ~ sign in the help database. (In versions 1.x you could not
  447.           include the ~ sign in your help output text).
  448.  
  449.         - The help engine will except ALT-B as the go-back short-cut - to
  450.           display the previous help screen.
  451.  
  452.   Version 2.1 
  453.  
  454.         - I received several complaints that the HC31.EXE winHelp help compiler
  455.           does not work, and aborts at a specific place (byte 0x122) on the 
  456.           RTF file created by running HELPC /W31 HLPDK. It seems that for some
  457.           reason the HC31 compiler is not able to process all of the ascii 
  458.           characters. The ╔ character that appeared in byte offset 0x121
  459.           caused the HC31 compiler to abort. I do not know why this is 
  460.           a problem, I will try to investigate, and if I can not come with an
  461.           answer - I will try to contact microsoft (hey folks - they wrote it)
  462.           and find out. In the mean while - the HLPDK.HDF file provided with
  463.           this package - can be compiled by the HC31 compiler.
  464.  
  465.         - I have noticed that not all of the .HL files generated for THELP
  466.           users work. I must admit I can not find the reason, I will continue 
  467.           to investigate. I must admit it looks like a problem with the HL
  468.           docuimentation I have. In the mean while - please continue to
  469.           investigate the help development kit, and inform me of any 
  470.           other problems you face with it.
  471.  
  472.         - You can contact me (NEW NEW NEW) on my NEW (did I say that ..)
  473.           Compuserve Address : 100274,162
  474.           from internet that is : 100274.162@compuserve.com . 
  475.           Please send any enhancement requests, bug reports or other things - 
  476.           I'm currently in the process of planning the next major version,
  477.           and any input will be helpful.
  478.  
  479.         - QH (quickHelp) files will now display backslash characters that 
  480.           appear in the source file, by pre-fixing them with the over-ride 
  481.           character (\), when the /QH+ switch is given to the helpC compiler.
  482.  
  483.         - QH (quickHelp) links will now be visible, even when they are not
  484.           hi-lighted. These links will appear in BOLD face, by using the \b
  485.           bold source command.
  486.  
  487.         - For people interested in the HC help compiler - If you do not have
  488.           it in your development package (I was told that visual basic 
  489.           standard edition does not include it), you can download the 
  490.           3.0b version from CICA, in the winword directory.
  491.  
  492.         - NEW - Added TVHC Support - Use the /TV+ switch to create TVHC sources,
  493.           that you can compile using your version of TVHC (PASCAL or C++).
  494.  
  495.   Version 3.0
  496.  
  497.         - The THELP code generation was improved to support HL v6.10 that
  498.           comes as part of the Borland Pascal Open Architecture package.
  499.           Because of this change the following things should be noted :
  500.           1. The source screens inlude a ;INDEX directive, so HL will
  501.              not abort on FE02: Out Of Memory errors.
  502.           2. A new dummy screen that is needed for Borland Pascal IDE
  503.              is generated as the first screen in the soure .HL code.
  504.              You MUST compile the generate code using HL's -e switch,
  505.              specifing a number which is bigger then 1. HL will always
  506.              issue one error message - that screen DUMMY is not referenced,
  507.              this error should be ignored, the resulting .TPH/.TCH file
  508.              will be a valid THELP and IDE help file.              
  509.           3. HL V6.0 should still work, with better results, becasue the
  510.              Out Of Memory errors should be eliminated as well. (Do remeber
  511.              to use the -e switch with a value > 1).
  512.  
  513.         - The .TITLE directive cause titles to be generated for THELP
  514.           source now.
  515.  
  516.         - Added the .LINKCOLOR and .LINKHIGH commands in the Help Definition
  517.           File (.HDF) - that set the color of links in "normal" and 
  518.           hi-lighted states. This feature is relevant only when compiling
  519.           to native paradox engine (Help Engine) format.
  520.  
  521.         - Added the .INCLUDE commands to the .HDF specifications. Use this
  522.           help definition file command to create complex help projects that
  523.           are composed from multiple .HDF source files.
  524.  
  525.         - The helpC program will abort with an error message if no .end-topic 
  526.           command was supplied to the last topic in a .HDF file.
  527.  
  528.         - Added the ALT-T Topic Index command to the Help Engine. Use ALT-T
  529.           to display and choose from a list of all the topics in the help
  530.           database. For ease of use the topics are displayed with their titles.
  531.  
  532.         - Upon user's request - The ALT-X command will not have to be confirmed
  533.           by a TAB in order to exit the Help Engine.
  534.  
  535.         - Added support for the Search facility of WinHelp V3.x. From now on
  536.           the search button of windows help engine will display the list of
  537.           topic titles available in the help database.
  538.  
  539.         - Added the .FIXEDFONT command to the HDF syntax - use this command
  540.           to set the font used in the generated RTF file for WinHelp V3.x
  541.           to a fixed font. (By default a proportional font is used). If you
  542.           find that your help databases are not aligned after they are 
  543.           converted to winHelp format, use this command and re-compile.
  544.           This command has no effect on targets that are different from
  545.           windows winHelp formats.
  546.  
  547.         - The helpC compiler was converted to perform multiple passes on the
  548.           input data, if these passes are needed.
  549.  
  550.         - The maximum topic name length was expanded to 40 characters - this
  551.           means that V2.x help databases will have to be re-compiled for
  552.           this version.
  553.  
  554.         - Maximum Text displayed for a link was expanded to 60 characters.
  555.  
  556.         - The ALT-B HelpEng command has been enhanced to return to the position
  557.           viewed last.
  558.  
  559.         - Added POPHELP Source Generation. Use the helpC /PH+ parameter to
  560.           create source that can be used by TurboPower Software's makehelp
  561.           program - to create a pophelp .HLP file.
  562.  
  563.         - When generating code to winHelp source format, the helpC compiler
  564.           will issue a warning when an illegal HC link (topic) name is 
  565.           found, and will automatically convert this identifier to a name
  566.           that is supported by the HC compilers.
  567.  
  568.   Version 4.0
  569.  
  570.         - Help Source Generation is much faster in this version, when the
  571.           target is NOT the native format, and no Report is generated.
  572.  
  573.           In this case, helpC storage requirements will be much
  574.           smaller as well, because no paradox topic and link tables will
  575.           be created during the compile phase.
  576.  
  577.           Please notice that if POPHELP is the target, a temporary paradox
  578.           table will still be created, during pass 1 pre-processing, pass 2
  579.           however, will be much faster than what it was before.
  580.  
  581.           Compiling the hlpdk source on my 33MH 486 computer using 
  582.           helpc hlpdk /w30 /r- 
  583.           takes 1.76 sec. in V3.1 Vs. 5.23 sec. in V3.0.
  584.  
  585.         - Added the .PARAGRAPH .. .-END-PARAGRAPH paragraph markers in the
  586.           topic text section of the .HDF language. Use this feature to 
  587.           create long paragraphs that will be wrapped as one paragraph when
  588.           the help window is resized by the user. This feature is currently 
  589.           supported for winHelp code generation only.
  590.  
  591.           Please refer to the HELPC.DOC file for further discussion of this
  592.           text formatting feature.
  593.  
  594.         - Updated To Paradox Engine 3.01.
  595.  
  596.         - For easier development the .TOP and .ENDTOP commands are equivelent
  597.           to the .TOPIC and .END-TOPIC commands.
  598.  
  599.         - If no data file name is given to the helpC compiler, the set name
  600.           with target specific extention is given instead of the default
  601.           name given in previous versions.
  602.  
  603.         - If the help topics and link names are not specified, names that are
  604.           derived from the set name are given in this version, instead of the
  605.           default names that were given in previous versions.
  606.  
  607.         - Added support for long topic names, that include spaces in them.
  608.           Please refer to the HELPC.DOC file, regarding the /ST switch.
  609.  
  610.         - Added DESQview/X code generation support. Please refer to the 
  611.           HELPC.DOC File for the /XD+ HELPC Switch. In order to compile
  612.           the generated source you will have to use MDVXHELP, by 
  613.           Daniel J. Bodoh, that can be found in the file DVXHLP10.ZIP in
  614.           the DV-X directory on SIMTEL20, and probably some other places
  615.           on the internet, and other networks.
  616.  
  617.         - When generating code to THELP source format, the helpC compiler
  618.           will issue a warning when an illegal HL link (topic) name is 
  619.           found, and will automatically convert this identifier to a name
  620.           that is supported by the HL compiler.
  621.  
  622.         - Added the .PCFONT command to the HDF syntax - use this command
  623.           to set the font used in the generated RTF file for WinHelp V3.x
  624.           to a terminal font. (By default a proportional font is used). 
  625.           If you convert your help database that uses PC special characters,
  626.           and you want to preserve these characters in the windows version, 
  627.           use this statement.
  628.           This command has no effect on targets that are different from
  629.           windows winHelp formats.
  630.  
  631.         - When comiling to winhelp format, character with ordinal number 
  632.           bigger than 127 will be translated using the RTF override
  633.           mechanism. The "Famous" HC31 problem is over.. . (This solution
  634.           was offered by Mr. Lars Fosdal.)
  635.  
  636.         - When generating to winHelp Target, TAB characters are translated
  637.           to rtf \tab commands. For other targets no TAB translation is 
  638.           performed. It is advised that you set your editor to fill spaces
  639.           when a tab is inserted.
  640.  
  641.         - Added the /CS switch to the helpC compiler. Using this switch 
  642.           topics and links can be set to be case sensative. It is not advised
  643.           to use this switch, unless you want to create lower case indexes
  644.           in a help engine such as POPHELP or THELP. Please notice - setting
  645.           this switch to ON (+) can break help databases that used to compile
  646.           fine. Use With Care!. (By default case sensativity is set to off).
  647.  
  648.         - The HELPENG help engine can now handle topics with up to 500 lines,
  649.           vs. 125 in the previous version.
  650.  
  651.   Version 5.0
  652.  
  653.         - The helpC compiler will convert illegal winhelp 3.1 (HC31) characters
  654.           in titles to spaces. The previous version corrected only body text,
  655.           but did not detect illegal titles.
  656.  
  657.         - When THELP (HL) is the target, The OVERVIEW topic will be renamed to
  658.           Index - This is the name that MUST be attached to ;MainIndex screens
  659.           in THELP, if we want the IDE to display them as the main index.
  660.  
  661.         - The helpC compiler will look for a configuration file called 
  662.           HELPC.CFG in the current directory, and if it finds one will process
  663.           the switches in this file before any other command line switches.
  664.  
  665.         - Control Characters (ASCII < 32) are not acceptble by HC31 as well,
  666.           helpC will now create the RTF over-ride for these characters as
  667.           well.
  668.  
  669.         - Reports use virtual memory tables for cross reference manipulation,
  670.           so compile with report generation is faster. On my 486-33 computer
  671.           compiling HELPC HLPDK /W31 /R+ took 11 sec. in the previous version
  672.           Vs. 5 sec. only in this version. 
  673.  
  674.           As a side effect - the compiler will not create the helpct* temporary
  675.           tables. 
  676.  
  677.         - During Pass 1 of POPHELP and DV/X source generation - a temporary 
  678.           memory table will be used instead of a paradox table in previous
  679.           versions. Code generation will be both faster, and will not require
  680.           disk space for these targets. On my computer HELPC /R- /PH+ HLPDK 
  681.           takes 2.32 sec. Vs. 3.24 sec. on the previous version.
  682.  
  683.         - Added the .TEXTCOLOR command to the HDF syntax. Use this command to
  684.           set the value of the text color. This command is supported only
  685.           in the Native help format target.
  686.  
  687.         - Added The menu-bar to the helpEng help engine program.
  688.  
  689.         - The helpEng program can display multiple help windows.
  690.  
  691.         - Added the ability to save and print a help topic from within the
  692.           help engine.
  693.  
  694.         - Fixed a bug in the cross reference report that was cutting long
  695.           link names, and report on errors that did not exist.
  696.  
  697.         - A NEW Optimized Native help database format is introduced with this
  698.           version. The new Native Mem format uses Fast, Optimized code with
  699.           memory based indexes to display help faster, and with less 
  700.           distribution overhead. The HE.EXE Help Engine supplied with this
  701.           version is smaller in size than HELPENG.EXE, because it does not have
  702.           the Paradox Engine in it. The Help Databases Generated are smaller,
  703.           because the format is simple RAW Binary representation of the 
  704.           data structures handled in memory by the help engine.
  705.  
  706.         - The helpC compiler now supports the /MT+ switch to generate the
  707.           new Native Mem Format.
  708.  
  709.         - The Help Engine Source Code is now available to registered users,
  710.           (for additional cost) for the New Native Mem Format.
  711.  
  712.         - The Native Paradox Based format is still supported in this version,
  713.           and should be used to handle Huge help databases that will not fit
  714.           into memory, or to support PAL/ObjectPAL help applications from
  715.           within Paradox/Paradox for Windows. Use the helpC /PX+ switch to
  716.           generate code to this target. The HelpEng.EXE help engine is supplied
  717.           with this package as well.
  718.  
  719. *******************************************************************************
  720. *                                   Credits                                   *
  721. *******************************************************************************
  722.  
  723.   HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  724.   Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. 
  725.   (Trademarks of Borland International).
  726.  
  727.   Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  728.   of Microsoft Corp.
  729.  
  730.   The HELPENG program was written using the WINTEXT UI library, 
  731.   (c) 1991,93 Loewy Ron.
  732.  
  733.   THELP, HL and TVHC are Trademarks or copyrights Borland International.
  734.  
  735.   TVHC support, and other ideas were suggested by MunLeong Chan.
  736.  
  737.   POPHELP is a copyright of TurboPower Software.
  738.  
  739.   Parts of the Help Engines were generated using Ron Loewy's WTGEN and dbGen
  740.   CASE code generators.
  741.  
  742.   Parts of the Help Compiler were generated using Ron Loewy's dbGen database 
  743.   code generator.
  744.  
  745.   Yaniv Golan helped me with beta-testing, debugging and suggestions.
  746.  
  747.   John Murphy notified me of the paragraph formtting difficulties that
  748.   lead to the .PARAGRAPH .END-PARAGRAPH formatting capabilities.
  749.  
  750.   DESQview/X is a trademark of Quarterdeck Office Systems.
  751.  
  752.   MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his
  753.   excelent documentation of DESQview/X help format to generate code
  754.   to this environment.
  755.  
  756.   The HC31 problem with characters with ordinal values biggen than 127
  757.   was solved thanks to Mr. Lars Fosdal of Norway.
  758.  
  759.   OS/2 is a registered trademark of International Bussiness Machines.
  760.  
  761.   The Text Cursor restore problem in the help engines was reported by Prof.
  762.   Timo Salmi of the Univ. of VAASA, Finland.
  763.