home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / w3_apps / qdhelp.arj / README < prev    next >
Text File  |  1992-01-22  |  6KB  |  167 lines
  1. Welcome to QDHELP v1.0
  2.  
  3. This program allows you to use a normal text editor to generate Windows
  4. 3.0 help files.  You will still need access to a copy of the Microsoft
  5. Help Compiler. 
  6.  
  7. What you will not need is an editor that outputs RTF (Rich Text Format)
  8. .  QDHELP takes an ascii file that contains commands, a very little bit
  9. like TeX, and outputs the RTF format that the Microsoft Help compiler
  10. needs to churn out Windows 3.0 help file.
  11.  
  12. QDHELP is shareware.  Check it out. If you use it register it!  To
  13. register just fill out the REGISTER.FRM file using any ascii editor
  14. and send it in.  The cost? A mere $20.00, which is a drop in the 
  15. bucket next to RTF word processors!
  16.  
  17.  
  18. Running:
  19.  
  20. To run qdhelp you type
  21.  
  22. QDHELP infile [outfile]
  23.  
  24. The infile is the file which contains the ascii text including commands
  25. for QDHELP.  The outfile (which is optional) contains the output RTF
  26. file.  If no outfile is given the output is written to out.rtf.
  27.  
  28. The standard file extensions for the input file is .qdh and for the
  29. output file is .rtf.
  30.  
  31.  
  32. Packing List
  33.  
  34.     QDHELP.EXE     -    The program
  35.     README         -    This file
  36.     REGISTER.FRM -  The registration form.
  37.     QDHELP.QDH     -    A Full (in progress) Windows 3.0 help file for QDHELP
  38.                     Specification.  This is a input file to QDHELP that
  39.                     is used to generate QDHELP.HLP
  40.                     This gets a little self referential at times!
  41.     QDHELP.HLP     -    A actual windows 3.0 help file that describes QDHELP
  42.                     syntax and commands.  This file can be viewed in 
  43.                     windows by opening the help window from the program
  44.                     manager.  Then choose the Open option under the 
  45.                     File menu.  From the open file dialog box choose the
  46.                     QDHELP.HLP file and you will be rocking and rolling.
  47.                     The following template .hlp files can be viewed in the
  48.                     same way as this file.
  49.  
  50.     QDHELP.HPJ     -    This is the input file used by the Microsoft Help Compiler
  51.                     (hc).  The format of this file is documented in your
  52.                     help compiler documentation.
  53.  
  54.  
  55.     DONE.BMP     -     These are bitmap files needed to generate the QDHELP.HLP
  56.     BULLET.BMP     -    file.
  57.  
  58.     QDHELP.MAK     -    A Makefile that will generate all the .hlp files and show
  59.                     you how to incorporate qdhelp into your standard make
  60.                     cycle.  This was tested using Borlands make utility but
  61.                     should be very close for other makes
  62.  
  63.                     To run it type 
  64.  
  65.                     make -fqdhelp.mak 
  66.  
  67.     QDHELP.WRI     -    This is the QDHELP document.  It is in Microsoft Write
  68.                     format.  Write is the word processor that comes packaged
  69.                     with windows.  Just read QDHELP.WRI into Write to view it or
  70.                     to print it out.
  71.                 
  72.     Template files:
  73.             The following files are placed here as a starting point 
  74.             for development of help files.  They give you an Idea of
  75.             the different things you can do with QDHELP.  When you 
  76.             decided to generate a help file I would suggest playing
  77.             with a template until you get a look and feel that you 
  78.             like.  Use that as a skeleton and fill it in.
  79.  
  80.     TPLATE1.QDH        QDHELP input file for template 1
  81.     TPLATE1.HLP        Windows 3.0 help file generated by TPLATE1.QDH        
  82.  
  83.     TPLATE2.QDH        QDHELP input file for template 2
  84.     TPLATE2.HLP        Windows 3.0 help file generated by TPLATE2.QDH        
  85.  
  86.     TPLATE3.QDH        QDHELP input file for template 3
  87.     TPLATE3.HLP        Windows 3.0 help file generated by TPLATE3.QDH        
  88.  
  89.     TPLATE4.QDH        QDHELP input file for template 4
  90.     TPLATE4.HLP        Windows 3.0 help file generated by TPLATE4.QDH        
  91.  
  92.  
  93. Basic Steps:
  94.  
  95.     These are the basic steps needed to generate a help file for 
  96.     windows 3.0 using the QDHELP program.
  97.  
  98.     Write the .qdh file using any standard editor. This should be
  99.     a raw ascii file.
  100.  
  101.     Run the .qdh file thru the QDHELP program until there are no
  102.     errors.
  103.  
  104.     Write the .hpj file.  This is the input file for the hc compiler.
  105.     Look into your help compiler documentation if you do not know the
  106.     format of this file.  In the worst case take the .hpj that comes
  107.     with the QDHELP system rename it and change the title line.  That is
  108.     about all that is needed for a basic help file.
  109.  
  110.     run the hc command on the .hpj file until there are no errors.
  111.  
  112.     You should now have a .hlp file which you can load into the windows
  113.     3.0 help engine by choosing the open command from the file menu
  114.     of the help window.
  115.  
  116.     Thats it.
  117.  
  118.  
  119. QDHELP file syntax.
  120.  
  121.     There are three places to learn about the syntax of the qdhelp
  122.     input file.
  123.  
  124.     1) look at the provided .qdh files
  125.  
  126.     2) Running Windows 3.0 load the qdhelp.hlp file into the file
  127.         system and browse thru it.  The meaning of all of the
  128.         commands can be found there.  Many of the commands are not
  129.         really qdhelp command but straight RTF commands that are
  130.         passed thru to the help compiler.
  131.  
  132.     3) Full documentation is in QDHELP.WRI READ IT!
  133.  
  134.  
  135. Things you should KNOW:
  136.  
  137.     At present qdhelp does not like tabs in the text.  I suggest
  138.     detabbing your .qdh file before running qdhelp on it.  If you 
  139.     want to put tabs into you help to align columns etc use the
  140.     literal string \tab this will pass thru as the tab command in
  141.     RTF.
  142.  
  143. NEWS FLASH:
  144.  
  145.     The Microsoft help compiler is available on Compuserve.  
  146.     GO MSL
  147.     Download file S12923.ARC (about 140k).  It includes the help compiler
  148.     and a utility for converting Excel help files for windows. There does
  149.     not seem to be an restrictions on it (this surprises me!).  At any rate
  150.     for what its worth! (Thanks to Keith Pleas for letting me know about
  151.     this)
  152.  
  153.  
  154. Your Help:
  155.  
  156.     I would appreciate your help in finding and killing the bugs that
  157.     are lurking in QDHELP.  If you have questions, comments, bug reports
  158.     or anything else on your mind you can reach me at the following
  159.     locations
  160.  
  161.     Compuserve:    72047,2134
  162.     Genie:        P.ALLEN8
  163.     internet     allen@mr.med.ge.com
  164.  
  165.     I use QDHELP to generate help files, I hope you will find it useful
  166.     as well.
  167.