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