home *** CD-ROM | disk | FTP | other *** search
/ Borland Programmer's Resource / Borland_Programmers_Resource_CD_1995.iso / utils / qdhelp / readme < prev    next >
Encoding:
Text File  |  1995-05-19  |  5.3 KB  |  151 lines
  1. Welcome to QDHELP v3.0
  2.  
  3. This program allows you to use a normal text editor to generate Windows
  4. 3.x 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.x 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 $49.00 + 5.00 S/H, which is a drop in the 
  15. bucket next to a 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.  
  36.     QDHELP.WRI   -  A windows write format full document of QDHELP.
  37.  
  38.     README       -  This file
  39.  
  40.     WHATSNEW.WRI -  A windows write format document describing the new 
  41.                     features for this release.
  42.  
  43.     REGISTER.TXT -  The registration form.
  44.  
  45.     QDREPORT.EXE -  A program which will generate 3 reports from the
  46.                     .DB file output by QDHELP.  TOPICS.RPT, BROWSE.RPT
  47.                     and LINKS.RPT.  Each report gives information about
  48.                     the structure and layout of your help file.
  49.  
  50.     QDHELPSR.ZIP -  A archive that contains the source files used to
  51.                     generate the QDHELP.HLP help file. To build the help
  52.                     file simply execute
  53.                     QDHELP QDHELP
  54.  
  55.  
  56.     QDHELP.HLP   -  A actual windows 3.1 help file that describes QDHELP
  57.                     syntax and commands.  This file can be viewed in 
  58.                     windows by opening the help window from the program
  59.                     manager.  Then choose the Open option under the 
  60.                     File menu.  From the open file dialog box choose the
  61.                     QDHELP.HLP file and you will be rocking and rolling.
  62.                     The following template .hlp files can be viewed in the
  63.                     same way as this file.
  64.  
  65.     TPLATE30.QDH  - A simple sample QDH file to get you started with help
  66.                     files for windows 3.0
  67.  
  68.     TPLATE31.QDH  - A simple sample QDH file to get you started with help
  69.                     files for windows 3.1
  70.  
  71.     GLOSS.QDH      - A simple sample QDH file showing how to implement a
  72.                     glossary like all the fancy help files you are used to.
  73.  
  74.     UPTEST.QDH    - A simple example showing how to creat a up button using
  75.                     QDHELP.
  76.  
  77.     SOUND.QDH     - A example showing how to play sound from q QDHELP file.
  78.                     This example also needs the file SOUND.SHG and QDHELP.WAV
  79.  
  80.     KEYWORDS.QDH  - A example showing how to use QDHELP to generate a help
  81.                     file with keywords placed at different places in a
  82.                     topic.
  83.  
  84. Basic Steps:
  85.  
  86.     These are the basic steps needed to generate a help file for 
  87.     windows 3.x using the QDHELP program.
  88.  
  89.     Write the .qdh file using any standard editor. This should be
  90.     a raw ascii file.
  91.  
  92.     Run the .qdh file thru the QDHELP program until there are no
  93.     errors.
  94.  
  95.     run the hc command on the .hpj file output by QDHELP.
  96.  
  97.     You should now have a .hlp file which you can load into the windows
  98.     3.x help engine by choosing the open command from the file menu
  99.     of the help window.
  100.  
  101.     Thats it.
  102.  
  103.  
  104. QDHELP file syntax.
  105.  
  106.     There are three places to learn about the syntax of the qdhelp
  107.     input file.
  108.  
  109.     1) look at the provided .qdh files
  110.  
  111.     2) Running Windows 3.x load the qdhelp.hlp file into the help
  112.         system and browse thru it.  The meaning of all of the
  113.         commands can be found there.  Many of the commands are not
  114.         really qdhelp command but straight RTF commands that are
  115.         passed thru to the help compiler.
  116.  
  117.  
  118. NEWS FLASH:
  119.  
  120.     The Microsoft help compiler is available on Compuserve.  
  121.    
  122.     There is also a version of the 3.1 help compiler in the WINSDK Forum
  123.     on compuserve. Library 16 (WinHelp).  It is a version that will use
  124.     extended memory for compiling large help files.  I suspect you are
  125.     supposed to have a current version of the help compiler to use this
  126.     one.  So your on your honor.
  127.  
  128.  
  129. REFERENCES:
  130.  
  131.     I would strongly suggest that you beg, borrow or in some other way
  132.     get your hands on a copy of Microsoft Windows 3.1 Programmers Reference
  133.     Volume 4 Resource.   Chapter 15 of this book covers all the Win 3.1
  134.     Macros and what they do.  Along with some other information on help.
  135.  
  136. Your Help:
  137.  
  138.     I would appreciate your help in finding and killing the bugs that
  139.     are lurking in QDHELP.  If you have questions, comments, bug reports
  140.     or anything else on your mind you can reach me at the following
  141.     locations
  142.  
  143.     Compuserve:    72047,2134
  144.     internet       allen@isgtech.com
  145.  
  146.     I use QDHELP to generate help files, I hope you will find it useful
  147.     as well.
  148.  
  149.  
  150. Phil Allen.
  151.