home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / progmisc / hlpdk30.zip / HLPDK.DOC < prev    next >
Text File  |  1993-04-10  |  22KB  |  476 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 V3.0                              *
  13. * LAST UPDATE - Apr. 08, 1993. (c) 1992,93 - Loewy Ron.                       *
  14. *******************************************************************************
  15.  
  16.  
  17.  
  18.         RL Help Engine.
  19.         
  20.         Help Compiler, Run-Time help engine and docs.
  21.  
  22.         Support for Dos & Windows.
  23.  
  24.         Supported Formats :
  25.  
  26.         Native, Win30, Win31, QuickHelp, THELP, TVHC, POPHELP
  27.  
  28.         "Write Once, Help Many!"
  29.  
  30.                    
  31. *******************************************************************************
  32. *                                  File-List                                  *
  33. *******************************************************************************
  34.  
  35.  This package contains the following files :
  36.  
  37.  HELPENG.EXE    - Help Engine.
  38.  HELPC.EXE      - Help Compiler.
  39.  HLPDK.DOC      - This file.
  40.  HELPC.DOC      - Help Compiler documentation
  41.  HELPDEMO.HDF   - Demo Help Project.
  42.  2NDDEMO.HDF    - Demo Help Project - file 2.
  43.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  44.  HLPDK.REG      - Registration file.
  45.  HLPDK.HDF      - Help Development Kit hypertext help database source.
  46.  HLPDK.HDT      - Help Development Kit help database file.
  47.  HLPDK.SET      - Help Development Kit help database file.
  48.  HLPDKTOP.*     - Help Development Kit help database files.
  49.  HLPDKLNK.*     - Help Development Kit help database files.
  50.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  51.  
  52. *******************************************************************************
  53. *                                Why Register                                 *
  54. *******************************************************************************
  55.  
  56.   The Help Engine Development Kit (HLPDK) is a shareware product, 
  57.  if you find this product valuable, please register it. 
  58.  This section describes the reasons you should register.
  59.  
  60.   By registering you will receive a complete discussion
  61.  of the help engine features, and many examples of usage. You will receive a 
  62.  diskette with the latest HLPDK version, and DPMI (dos protected mode)
  63.  versions of the help compiler and engine!.
  64.  
  65.   Your registration will help us to create the next versions of HLPDK, that
  66.  will include more options, and features, some of them might even be your
  67.  enhancement requests!.
  68.  
  69.   A point to consider - If you want to create Windows Help source files,
  70.  you will have to purchase a word processor that can output RTF files,
  71.  the WORD for Windows 2.0 package, for example, is listed at around $500!.
  72.  
  73. *******************************************************************************
  74. *                                  What's New                                 *
  75. *******************************************************************************
  76.  
  77.   Version 3.0
  78.  
  79.         - The THELP code generation was improved to support HL v6.10 that
  80.           comes as part of the Borland Pascal Open Architecture package.
  81.           Because of this change the following things should be noted :
  82.           1. The source screens inlude a ;INDEX directive, so HL will
  83.              not abort on FE02: Out Of Memory errors.
  84.           2. A new dummy screen that is needed for Borland Pascal IDE
  85.              is generated as the first screen in the soure .HL code.
  86.              You MUST compile the generate code using HL's -e switch,
  87.              specifing a number which is bigger then 1. HL will always
  88.              issue one error message - that screen DUMMY is not referenced,
  89.              this error should be ignored, the resulting .TPH/.TCH file
  90.              will be a valid THELP and IDE help file.              
  91.           3. HL V6.0 should still work, with better results, becasue the
  92.              Out Of Memory errors should be eliminated as well. (Do remeber
  93.              to use the -e switch with a value > 1).
  94.  
  95.         - The .TITLE directive cause titles to be generated for THELP
  96.           source now.
  97.  
  98.         - Added the .LINKCOLOR and .LINKHIGH commands in the Help Definition
  99.           File (.HDF) - that set the color of links in "normal" and 
  100.           hi-lighted states. This feature is relevant only when compiling
  101.           to native paradox engine (Help Engine) format.
  102.  
  103.         - Added the .INCLUDE commands to the .HDF specifications. Use this
  104.           help definition file command to create complex help projects that
  105.           are composed from multiple .HDF source files.
  106.  
  107.         - The helpC program will abort with an error message if no .end-topic 
  108.           command was supplied to the last topic in a .HDF file.
  109.  
  110.         - Added the ALT-T Topic Index command to the Help Engine. Use ALT-T
  111.           to display and choose from a list of all the topics in the help
  112.           database. For ease of use the topics are displayed with their titles.
  113.  
  114.         - Upon user's request - The ALT-X command will not have to be confirmed
  115.           by a TAB in order to exit the Help Engine.
  116.  
  117.         - Added support for the Search facility of WinHelp V3.x. From now on
  118.           the search button of windows help engine will display the list of
  119.           topic titles available in the help database.
  120.  
  121.         - Added the .FIXEDFONT command to the HDF syntax - use this command
  122.           to set the font used in the generated RTF file for WinHelp V3.x
  123.           to a fixed font. (By default a proportional font is used). If you
  124.           find that your help databases are not aligned after they are 
  125.           converted to winHelp format, use this command and re-compile.
  126.           This command has no effect on targets that are different from
  127.           windows winHelp formats.
  128.  
  129.         - The helpC compiler was converted to perform multiple passes on the
  130.           input data, if these passes are needed.
  131.  
  132.         - The maximum topic name length was expanded to 40 characters - this
  133.           means that V2.x help databases will have to be re-compiled for
  134.           this version.
  135.  
  136.         - Maximum Text displayed for a link was expanded to 60 characters.
  137.  
  138.         - The ALT-B HelpEng command has been enhanced to return to the position
  139.           viewed last.
  140.  
  141.         - Added POPHELP Source Generation. Use the helpC /PH+ parameter to
  142.           create source that can be used by TurboPower Software's makehelp
  143.           program - to create a pophelp .HLP file.
  144.  
  145.         - When generating code to winHelp source format, the helpC compiler
  146.           will issue a warning when an illegal HC link (topic) name is 
  147.           found, and will automatically convert this identifier to a name
  148.           that is supported by the HC compilers.
  149.  
  150. *******************************************************************************
  151. *                                Introduction                                 *
  152. *******************************************************************************
  153.  
  154.   The Help Engine Development Kit is a system that allows you to create 
  155.  hyper-text database help systems with topics and hot links, using a simple
  156.  text editor and the help compiler. 
  157.  
  158.   The help databases can be distributed (free of charge) with the HELPENG
  159.  help engine display program. 
  160.  
  161.   If you own the Paradox Engine you can use the help databases with your
  162.  own programs. 
  163.  
  164.   The helpC compiler that is part of this development kit includes the
  165.  ability to create Windows Help source files from the same source the 
  166.  dos help sources are created!. Write your help once, and create help
  167.  databases for Dos and Windows!
  168.  
  169.   Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  170.  Turbo Pascal programs, and use the help engine window in your pascal
  171.  programs.
  172.  
  173. *******************************************************************************
  174. *                                    Setup                                    *
  175. *******************************************************************************
  176.  
  177.   Copy the files in this package to a directory of your choice.
  178.  
  179. *******************************************************************************
  180. *                                 Quick Start                                 *
  181. *******************************************************************************
  182.  
  183.   From the command line enter HELPC HELPDEMO to compile the demo help database.
  184.  
  185.   After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  186.  demo help database.
  187.  
  188.  If you want to compile for windows :
  189.  
  190.  from the command line enter HELPC HELPDEMO /W31
  191.  and after that HC31 HELPDEMO
  192.  (HC31 is the Microsoft Help Compiler)
  193.  from windows, open the HELPDEMO.HLP file from the windows help engine.
  194.  (Notice - if you do not have the HC help compiler from windows, we have
  195.   included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  196.   able to feel the quality of the output that can be generated, and decide
  197.   if you want to purchase the HC31 program. (Included with the SDK, BC++, 
  198.   TPW, BP and probably some other packages)).
  199.  
  200.  If you use windows 3.0, or want your help file to be compatible with
  201.  winHelp 3.0 use :
  202.         HELPC /W30 HELPDEMO
  203.         HC HELPDEMO
  204.  
  205.  To compile for THELP use : 
  206.         HELPC /TH+ HELPDEMO
  207.         HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
  208.  
  209.  To compile for QuickHelp : 
  210.         HELPC /QH+ HELPDEMO
  211.         HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
  212.  
  213.  To compile for TVHC :
  214.         HELPC /TV+ HELPDEMO
  215.         TVHC HELPDEMO.TXT
  216.  
  217.  To compile for POPHELP :
  218.         HELPC /PH+ HELPDEMO
  219.         MAKEHELP HELPDEMO
  220.  
  221. *******************************************************************************
  222. *                                  Operation                                  *
  223. *******************************************************************************
  224.  
  225.   To start the help engine program enter HELPENG on the command line, and 
  226.  choose the help database you want to view from the list box. Use the Tab key
  227.  to cycle between hot-link words, and press Enter to go to that link.
  228.  
  229.   If you know the name of the SET file of the database you want to activate, you
  230.  can enter it on the command line, and the help engine will display it.
  231.  
  232.   To create a new help database please refer to the HELPC documentation
  233.  file.
  234.  
  235. *******************************************************************************
  236. *                                  Warranty                                   *
  237. *******************************************************************************
  238.  
  239.   There is no warranty what so ever, The package is supplied as is,
  240.  The distributor (ISoft D&M), or the author (Loewy Ron), are not, 
  241.  and will not be responsible for any damages, lost profits, 
  242.  or inconveniences caused by the use, or inability to use this package. 
  243.  The use of the program is at your own risk. 
  244.  By using (or attempting to use) the package you agree to this.
  245.  
  246. *******************************************************************************
  247. *                                   General                                   *
  248. *******************************************************************************
  249.  
  250.   HLPDK is distributed by ISoft D&M, P.O.B. 5517 CORALVILLE IA 52241, U.S.A.
  251.  
  252.   HLPDK is (c) copyrighted by Loewy Ron, 1992, 93.
  253.  
  254.   HLPDK is a shareware program, please register your copy. 
  255.   To register your copy of HLPDK please refer to the supplied
  256.   HLPDK.REG file. 
  257.  
  258.   Other programs distributed by ISoft D&M are described in the supplied  
  259.   PROGRAMS.TXT file.
  260.  
  261.  
  262. *******************************************************************************
  263. *                                   Contact                                   *
  264. *******************************************************************************
  265.  
  266.   Please contact :
  267.  
  268.   ISoft D&M,  
  269.   P.O.B 5517
  270.   Coralville IA 52241,
  271.   U.S.A
  272.  
  273.   To contact the author directly : 
  274.  
  275.   Contact :     Loewy Ron,
  276.                 9 Haneveem st.
  277.                 Herzeliya, 46465
  278.                 ISRAEL.
  279.  
  280.   e-mail address : CompuServe - 100274,162
  281.  
  282. *******************************************************************************
  283. *                              Trouble Shooting                               *
  284. *******************************************************************************
  285.  
  286.   If you receive some kind of an error message while using the help development
  287.  kit please refer to this section.
  288.  
  289.  tableOps: xxxx error message :
  290.  This message is generated by the Paradox Engine if an internal error occurs,
  291.  if you receive a message that is not understood (e.g. Table is busy), 
  292.  please try one of the following :
  293.  1. Try running the Help Compiler or the Help Engine with another input and 
  294.     notice if the problem exists, if it does, turn to the next entry,
  295.     otherwise try to see what the difference between the inputs is.
  296.  2. Check your free memory, try to move some TSR's from memory, or use the
  297.     protected mode compiler/engine available with the registered version.
  298.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE
  299.     with programs that use the Paradox Engine. If you receive a table busy
  300.     error, try to see if you have another program that uses the same table 
  301.     in another session (Windows/DESQview etc..).
  302.  4. PANIC - Please contact the distibuter/author for additional help.
  303.  
  304.  Microsoft's HC31 help compiler will generate a error in RTF file error :
  305.  1. Use a binary disk editor to look at the character at the position x - 1
  306.     in the RTF file (where x is the error position reported by HC31).
  307.  2. Try to replace that charqacter from a special PC oem character to a 
  308.     "standard" ascii character (such as *). If the problem still occurs,
  309.     please contact ISoft D&M/The author, otherwise - you probably came 
  310.     accross a character that HC31 can not handle. In that case - try using
  311.     HC300b (the one that generates winHelp 3.0 format), or delete these 
  312.     characters from your source HDF file.
  313.  
  314.  Borland's HL help linker will generate a FE02: Out Of Memory error :
  315.  1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the
  316.     screen's definitions.
  317.  
  318.   We have encountered some users that ran into problems, because they did 
  319.  not use the dos SHARE program. We advise that you will always load the 
  320.  SHARE program in your AUTOEXEC.BAT file.
  321.  
  322. *******************************************************************************
  323. *                                   History                                   *
  324. *******************************************************************************
  325.  
  326.  
  327.   Version 1.0 
  328.  
  329.         - First Version, Written for TXS V3.0 help system, 
  330.           and generalized.
  331.  
  332.   Version 1.1
  333.  
  334.         - The Help Engine ALT-X (EXIT) command restores the screen
  335.           upon termination.
  336.  
  337.         - Added /R switch for the helpC help compiler.
  338.  
  339.         - From this version the helpC compiler can generate source
  340.           files for the Microsoft help compiler (HC) from the
  341.           SAME source .HDF). If the /w+ switch is specified,
  342.           the helpC compiler will create a .HPJ and .RTF files
  343.           to create the Windows .HLP file.
  344.  
  345.         - Includes a compiled version of the help demo database for
  346.           Windows WINHELP program. (View this if you do not have the
  347.           Microsoft HC Windows Help Compiler, to see the output that
  348.           can be generated with the helpC compiler, as a source to the 
  349.           HC compiler.
  350.  
  351.   Version 1.2
  352.  
  353.         - Windows RTF files will now display special characters ({, }, \),
  354.           by prefixing them with the RTF over-ride character (\), when the
  355.           /W+ switch is given to the helpC compiler.
  356.  
  357.         - helpC and helpEng were converted from TP6 to BP7.
  358.  
  359.         - The help engine and help compiler use the Paradox Engine V3.0 from
  360.           this release. (No need to keep your old PXENGINE.OVL file anymore).
  361.  
  362.         - Added the /W30 and /W31 switches to the helpC compiler. Use these
  363.           switches to set the output for the HC30 and HC31 Microsoft Windows
  364.           help compilers.
  365.  
  366.         - The help window scroll bars are are shown after a link is executed.
  367.           (A bug fix).
  368.  
  369.         - Added "Trouble Shooting" section to this document.
  370.  
  371.         - helpC and helpEng have DPMI versions to handle large projects.
  372.           (Available only with the registered version).
  373.  
  374.   Version 2.0
  375.  
  376.         - The help engine will display a new topic from the first line, and
  377.           not from the place that shows the current active link.
  378.  
  379.         - The help window in the help engine program can now be scrolled to
  380.           regions of the help topic, that do not include the current, or
  381.           any link.
  382.  
  383.         - A mouse click on a link, when the left-column is not 1 is recognized
  384.           as it should be.
  385.  
  386.         - The helpC help compiler will recognize .TOPIC and .END-TOPIC as
  387.           topic declaration keywords, as well as the .ENTRY and .END-ENTRY
  388.           that were used until this version.
  389.  
  390.         - The help topic table has a new field in it - the title field, using
  391.           this field you can specify the title of the help window, when it
  392.           displays a topic. Because of this field, databases created with
  393.           older versions of the help development kit will have to be 
  394.           re-compiled. (Please refer to HELPC.DOC).
  395.  
  396.         - The helpC help compiler will accept .TITLE keyword after the
  397.           .ENTRY (.TOPIC) line, to define a title to a topic window.
  398.  
  399.         - Added support for Microsoft Quick Help sources, and Borland THELP
  400.           sources generation.
  401.  
  402.         - The helpC compiler will translate ~~ in the source help definition
  403.           into a ~ sign in the help database. (In versions 1.x you could not
  404.           include the ~ sign in your help output text).
  405.  
  406.         - The help engine will except ALT-B as the go-back short-cut - to
  407.           display the previous help screen.
  408.  
  409.   Version 2.1 
  410.  
  411.         - I received several complaints that the HC31.EXE winHelp help compiler
  412.           does not work, and aborts at a specific place (byte 0x122) on the 
  413.           RTF file created by running HELPC /W31 HLPDK. It seems that for some
  414.           reason the HC31 compiler is not able to process all of the ascii 
  415.           characters. The ╔ character that appeared in byte offset 0x121
  416.           caused the HC31 compiler to abort. I do not know why this is 
  417.           a problem, I will try to investigate, and if I can not come with an
  418.           answer - I will try to contact microsoft (hey folks - they wrote it)
  419.           and find out. In the mean while - the HLPDK.HDF file provided with
  420.           this package - can be compiled by the HC31 compiler.
  421.  
  422.         - I have noticed that not all of the .HL files generated for THELP
  423.           users work. I must admit I can not find the reason, I will continue 
  424.           to investigate. I must admit it looks like a problem with the HL
  425.           docuimentation I have. In the mean while - please continue to
  426.           investigate the help development kit, and inform me of any 
  427.           other problems you face with it.
  428.  
  429.         - You can contact me (NEW NEW NEW) on my NEW (did I say that ..)
  430.           Compuserve Address : 100274,162
  431.           from internet that is : 100274.162@compuserve.com . 
  432.           Please send any enhancement requests, bug reports or other things - 
  433.           I'm currently in the process of planning the next major version,
  434.           and any input will be helpful.
  435.  
  436.         - QH (quickHelp) files will now display backslash characters that 
  437.           appear in the source file, by pre-fixing them with the over-ride 
  438.           character (\), when the /QH+ switch is given to the helpC compiler.
  439.  
  440.         - QH (quickHelp) links will now be visible, even when they are not
  441.           hi-lighted. These links will appear in BOLD face, by using the \b
  442.           bold source command.
  443.  
  444.         - For people interested in the HC help compiler - If you do not have
  445.           it in your development package (I was told that visual basic 
  446.           standard edition does not include it), you can download the 
  447.           3.0b version from CICA, in the winword directory.
  448.  
  449.         - NEW - Added TVHC Support - Use the /TV+ switch to create TVHC sources,
  450.           that you can compile using your version of TVHC (PASCAL or C++).
  451.  
  452. *******************************************************************************
  453. *                                   Credits                                   *
  454. *******************************************************************************
  455.  
  456.   HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  457.   Paradox Engine 2.0, and Paradox Engine 3.0. 
  458.   (Trademarks of Borland International).
  459.  
  460.   Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  461.   of Microsoft Corp.
  462.  
  463.   The HELPENG program was written using the WINTEXT UI library, 
  464.   (c) 1991,93 Loewy Ron.
  465.  
  466.   THELP, HL and TVHC are Trademarks or copyrights Borland International.
  467.  
  468.   TVHC support, and other ideas were suggested by MunLeong Chan.
  469.  
  470.   POPHELP is a copyright of TurboPower Software.
  471.  
  472.   Parts of the Help Engine were generated using Ron Loewy's WTGEN CASE code
  473.   generator.
  474.  
  475.   Yaniv Golan helped me with beta-testing and debugging.
  476.