home *** CD-ROM | disk | FTP | other *** search
/ C!T ROM 2 / ctrom_ii_b.zip / ctrom_ii_b / PROGRAM / C / MAKDOC12 / READ.ME < prev   
Text File  |  1992-02-17  |  3KB  |  101 lines
  1.  
  2. Program...... MAKDOC.EXE
  3.  
  4. Version...... 1.02
  5.  
  6. Description.. Documentation manual generator based on TesSeRact CXL help
  7.               file.
  8.  
  9. Author....... Preston Stroud
  10.               P.O. Box 5036
  11.               Kinston, NC  28501
  12.  
  13.  
  14.  
  15.    MAKDOC is a documentation utility I regularly use to simplify 
  16. my documentation requirements.  Using MAKDOC I can write my documentation
  17. once and then compile it to online help using MAKHLP from IDC and to
  18. a documentation for printing using MAKDOC.  
  19.  
  20.  
  21.    Features:
  22.    ---------
  23.      * Generates an include file with help category tags.
  24.  
  25.        Ex: WHSHELP.H which may contain:
  26.  
  27.         #define H_Warehouse_Description   91
  28.         #define H_Kinston_WTN_Usage   92
  29.         #define H_ACS_WTN_Usage   93
  30.         #define H_Test_Label    8
  31.         #define H_Exit_Menu    1
  32.         #define H_View_Menu    2
  33.         #define H_View_Lot_Info    3
  34.         #define H_View_WTN_Info    4
  35.         #define H_Date   34
  36.         #define H_Setup_Menu   81
  37.         #define H_Printer_Setup   97
  38.         #define H_No_Help   98
  39.         #define H_Change_History   99
  40.        etc...
  41.         
  42.      * Allows printer type selection from the following printers:
  43.        EPSON, IBMPRO, HEWLET PACKERD LASER JET 
  44.  
  45.      * Generates a printer ready documentation manual based on the
  46.        online help.
  47.  
  48.      * Allows documentation page header text specification.
  49.  
  50.      * Allows auto entry of cover page data for documentation.
  51.  
  52.      * Creates an index of each help topic with page numbers for users
  53.        and help category tags for the programmers.
  54.  
  55.  
  56.    Short Commings:
  57.    ---------------
  58.      * Does not strip out special characters added in for
  59.        changes in color, blinking, etc...  
  60.  
  61.  
  62.    Suggestions on Usage:
  63.    ---------------------
  64.      * All text in the ASCII help file before the first "*B" will
  65.        be printed on the cover sheet for the manual.
  66.  
  67.      * All text between the "*E" and the next "*B" is ignored.  This 
  68.        allows usage of separaters for easier view and editing for 
  69.        the programmers.  Ex: Usage of "----------------------" between
  70.        help help topic may make it easier to edit, etc..  Also, I use
  71.        dashes between help help topic to seperate them and also identify
  72.        the maximum length of the text.
  73.  
  74.  
  75.    Usage:
  76.    ------   
  77.    MAKDOC <input file> <output file 1> <output file 2> <printer> <text>
  78.  
  79.      <input file>..... TCXL ASCII help file
  80.      <output file 1>.. include file for program with help identifiers
  81.      <output file 2>.. program documentation manual
  82.      <printer>........ (E)pson (I)BM PRO (H)ewlet Packerd Laser Jet
  83.      <text>........... Page header text
  84.  
  85.    MAKDOC myprog.asc myprog.h myprog.doc E MY PROGRAM DOCUMENTATION Ver 2.1
  86.  
  87.    NOTICE: (Version 1.01)
  88.       This program has been placed into the public domain for usage by
  89.       programmers using the Innovative Data Concepts, Inc. TesSeRact CXL
  90.       User Interface Library.  It is being distributed free of charge AS IS
  91.       but I will consider enhancing the program.  If you have any suggestions
  92.       to make it more useful for you or others, please write or E-Mail on
  93.       on the IDC BBS
  94.  
  95.    CHANGES:
  96.    --------
  97.    02.17.92 1.02 PES Modified code to get printer drivers from program
  98.                      execution directory instead of current directory.
  99.                      (Good Suggestion Paul Morris)
  100.  
  101.