home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / MAKDOC.ZIP / MAKEDOC.DOC < prev   
Text File  |  1993-02-14  |  5KB  |  149 lines
  1. ------ DOCUMENTATION OF MakeDoc v.1.0 by XmbSoft (CIS ID 100031,2136) ------
  2.  
  3.  
  4.  
  5. With MakeDoc, the creation of Book objects (hipertext documentation)
  6. from an .INF file is easy. Once MakeDoc has been installed, drag
  7. the icon of the *.INF file that contains the documentation of the
  8. new program onto the MakeDoc v.1.0 Object Program: MakeDoc will 
  9. automatically create the Book object. So, no need to use the Program 
  10. template.
  11.  
  12.  
  13. * Contents of MAKDOC.Zip *
  14.  
  15. MakeDoc.DOC    This documentation
  16. Install.CMD    Installation Programa
  17. MakeDoc.CMD    Main program
  18. DOC.EA    Extended Attributes of MakeDoc.DOC
  19. CMD.EA    Extended Attributes of MakeDoc.CMD
  20.  
  21.  
  22. * Files after installation *
  23.  
  24. MakeDoc.DOC
  25. MakeDoc.CMD
  26.  
  27.  
  28. * Installing MakeDoc *
  29.  
  30. Doble-click onto the Install.CMD icon. The program will ask you to 
  31. pick one of the following options:
  32.  
  33.    1 - Create the Book object in the Desktop.                    [/D]
  34.    2 - Create the Book object in the folder of the *.INF file.   [/F]
  35.    3 - Create the Book object in the Information folder of OS/2. [/I]
  36.  
  37. I recommend to pick option 1. If you're used to intall all the Docs of 
  38. your programs in the Information folder, pick 3. Depending on your 
  39. selection, the Install program will create an object program with the
  40. parameter /D, /F or /I. You can change later your selection: just open 
  41. the Values window of MakeDoc v.1.0 object program and change what it is
  42. typed in the Paramaters field (the program will display an error message
  43. if the Parameters field is void or fill with an option different than 
  44. /D, /F or /I).
  45.  
  46. Of course, choosing 1 does NOT mean that the Book object will be place 
  47. permamently in the Desktop. You can move it wherever you want once it is
  48. created.
  49.  
  50. The Install program will ask you then to type the drive and full path of
  51. the directory where you want to install MakeDoc. If the directory does not
  52. exist, it will be created.
  53.  
  54. The Install program will create three objects in your Desktop:
  55.  
  56.    1 - The MakeDoc v.1.0 by XmbSoft Program Object
  57.    2 - The MakeDoc.DOC Shadow Object (documentation)
  58.    3 - The REXX.INF Shadow Object (*.INF to use as example)
  59.  
  60. If you doble-click onto the MakeDoc.DOC shadow, you will view this 
  61. documentation. If you drag the REXX.INF shadow onto the MakeDoc program
  62. icon, an Object Book will be created (double-click the Object Book and
  63. you will get the hipertext documentation of Rexx).
  64.  
  65. After installing and trying you can send to the Shreder the REXX.INF 
  66. shadow (the original file will remain in your disk) and place the MakeDoc
  67. program object and the MakeDoc.DOC shadow wherever you want (for example, 
  68. in a Tools folder).
  69.  
  70.  
  71. * Name of the Object Book *
  72.  
  73. If NAME.INF is the filename of the *.INF archive, the name of the new 
  74. Object Book will be 'NAME Guide' (NAME will be written in uppercase).
  75.  
  76.  
  77. * Checking your file is a real INFormation file *
  78.  
  79. MakeDoc will process the file especified only if:
  80.  
  81.    1 - the name of the file contents the substring ".INF";
  82.    2 - the first five character of the file are "HSP¢".
  83.  
  84. The second condition is controlled by the variables CompStr and CompNum
  85. at the beginning of MakeDoc.CMD.
  86.  
  87.  
  88. * Command Line Execution *
  89.  
  90. You can execute MakeDoc from an OS/2 Command Line Session. From the 
  91. directory where MakeDoc is installed or elsewhere if that directory is
  92. included in the PATH variable, type:
  93.  
  94.    MAKEDOC /X FULLPATH_FILENAME
  95.  
  96. where /X can be:
  97.    /D   Place Book Object in the Desktop
  98.    /I   Place Book Object in the Information folder
  99.    /F   Place Book Object in the folder of the INF file
  100.  
  101. For example,
  102.  
  103.    MAKEDOC /D C:\OS2\BOOK\CMDREF.INF
  104.  
  105. will create the Command Reference Book in your Desktop.
  106.  
  107.  
  108. * Errors *
  109.  
  110. If a Book Object is not immediatley created, an error has ocurred. Open 
  111. the Task List Window (pressing at the same time both buttons of your mouse)
  112. and select MakeDoc. An OS/2 Window session will be open and the error will 
  113. be reported. Two kind of errors are supported:
  114.  
  115.    A - Syntax error.
  116.        A Help message is displayed. This error occurs when no file is 
  117.        provided or an incorrect option has been typed in the parameters
  118.        field. If you doble-click onto MakeDoc v.1.0 instead of dragging 
  119.        a file, you'll get this error.
  120.  
  121.    B - Bad file format.
  122.        If you drag a file that is not a true INF file, the OS/2 Window
  123.        Session will report that the file is not a Documentation file.
  124.  
  125.  
  126. * Disclaimer *
  127.  
  128. THIS IS A FREEWARE PROGRAM AND AS SUCH YOU ARE PERMITTED TO 
  129. DISTRIBUTE IT WITHOUT CHARGE PROVIDED THAT ALL FILES ARE DISTRIBUTED
  130. TOGETHER. THIS PROGRAM IS PROVIDED AS IS WITHOUT ANY WARRANTY, 
  131. EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO FITNESS FOR A
  132. PARTICULAR PURPOSE. THAT IS, YOU MAY USE AND DISTRIBUTE THIS 
  133. PROGRAM BUT AT YOUR OWN RISK.
  134.  
  135.  
  136. * The Author *
  137.  
  138. You can contact the author at:
  139.  
  140. CompuServe as:          100031,2136
  141. Internet as:            100031.2136@compuserve.com
  142. LaConexión BBS 
  143. (Barcelona, Spain 
  144. 8/N/1 34-3-3516180) as: Xavier Martin
  145.  
  146.  
  147.  
  148. Barcelona, 14/02/93
  149.