home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / TEXT / INFO / ADDHELP.ZIP / ADDHELP.TXT < prev    next >
Encoding:
Text File  |  1991-06-18  |  3.5 KB  |  90 lines
  1. ADDHELP - An Application Help Installation Utility - Version 1.01P
  2. Copyright (C) 1991 Richard Sands CIS 70279,103
  3. All rights reserved
  4.  
  5.  
  6. OVERVIEW
  7. ---------
  8. This utility will install a DOS 5 help entry into the HELP System.  It is
  9. intended to be distributed with DOS 5 applications and used from the
  10. application's batch setup file or exec'd from an installation program.
  11. I know it's easy to just edit the helpfile, but this "ensures" that the help
  12. file is not accidentally corrupted.  It also gives the developer more,
  13. although not absolute, control over what wording goes into the help file
  14. about their application.
  15.  
  16. What it does is reads a specified help entry file and automatically inserts
  17. it into the DOSHELP.HLP file in the correct position.  It allows 255
  18. characters of description to be inserted, with ADDHELP doing the formatting.
  19.  
  20. If the description already exists, it displays the existing help item (first
  21. line only) and prompts the user for a Y/N decision to overwrite the existing 
  22. description.
  23.  
  24. ADDHELP creates a DOSHELP.BAK file before overwriting the original.
  25.  
  26.  
  27. USAGE
  28. ------
  29.           ADDHELP newhelp[.hlp] [d:path]
  30.     where
  31.           newhelp[.hlp] is the new help entry to be inserted into the
  32.                         existing DOSHELP.HLP file.
  33.  
  34.           [d:path]      is an optional path specifying the directory to
  35.                         find DOSHELP.HLP.  However, ADDHELP will search
  36.                         the path to find the DOSHELP.HLP file if omitted.
  37.  
  38.     Returns
  39.             ERRORLEVEL = 3 if user terminated
  40.             ERRORLEVEL = 2 could not find DOSHELP.HLP
  41.             ERRORLEVEL = 1 invalid params or file not found
  42.             ERRORLEVEL = 0 on success
  43.  
  44. HELP ENTRY FILE FORMAT
  45. -----------------------
  46.    New Help File Entries are contained in a ascii file with the extension
  47.    .HLP although any extension works.  You can create this file with the
  48.    EDIT program supplied with DOS.
  49.  
  50.    The first line contains the application's filename (no file extension).
  51.    The following lines contain the short description of the application
  52.    limited to 255 characters.  You do not have to worry about word wrap or
  53.    indention.
  54.  
  55.    You may not have blank lines in the file.  Remarks may be before the
  56.    application name, and must be preceded by an "@" character.  Remarks are
  57.    not placed into the DOSHELP file.
  58.  
  59.  
  60. HELP ENTRY FILE EXAMPLE
  61. -----------------------
  62. @
  63. @ You may delete this file after running SETHELP.BAT
  64. @
  65. AddHelp
  66. Help installation utility for new
  67. DOS 5.0 external commands.
  68.  
  69.  
  70. DISTRIBUTING & OTHER THINGS
  71. ----------------------------
  72. This software is submitted to the Public Domain "as is".  It may be freely
  73. distributed with applications.  It is requested that both the ADDHELP.EXE and
  74. ADDHELP.HLP files are included and the user is given an option to install
  75. ADDHELP.HLP on the destination DOSHELP file as part of the installation.
  76.  
  77. You may also include just your ADDHELP format .HLP file and allow the user
  78. to use either ADDHELP or manually combine the .HLP and the DOSHELP.HLP file.
  79. No distribution of ADDHELP.EXE is required, it is up to the user to get a
  80. copy of ADDHELP.EXE.
  81.  
  82. If you would like to be emailed whenever there is a new update, or have
  83. greater leverage for suggestions, bug-fixes, etc., send $5.00 to register
  84. your Name and CompuServe ID with us to
  85.                                       Richard Sands
  86.                                       P.O. Box 3917
  87.                                       Portland, Oregon 97208
  88.  
  89. Please include your Name and CompuServe ID.
  90.