home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / makebook.zip / makebook.doc < prev    next >
Text File  |  1995-04-14  |  9KB  |  203 lines
  1. MAKEBOOK.CMD
  2. Version 2.1
  3. April 14, 1995
  4.  
  5. By: Derek Berube
  6.     <DCybertek@aol.com>
  7.  
  8. Package Contents
  9. ================
  10.  
  11. MAKEBOOK.CMD    the actual REXX program.
  12. MAKEBOOK.DOC    the document you now have in your hands (or your favorite
  13.                 editor).
  14. MAKEBOOK.ICO    the nifty designer icon for MakeBook
  15. REGISTER.FRM    MakeBook registration form
  16.  
  17. About MAKEBOOK
  18. ==============
  19.  
  20.         MAKEBOOK.CMD is a REXX utility designed to create icons for the 
  21. on-line documents located on your OS/2 system.  This utility will search
  22. all available drives (including network drives) for OS/2 .INF files and
  23. create icons for them with the appropriate titles.
  24.         MAKEBOOK.CMD uses the following logic process when it searches your
  25. hard disk for .INF files:
  26.  
  27. 1.)  MAKEBOOK.CMD starts with the root directory of drive C: and searches all
  28.      available subdirectories for files with a .INF extension.
  29. 2.)  When MAKEBOOK.CMD obtains a listing of all files on drive C: with an .INF
  30.      extension, it compares the filename with two different lists of .INF file
  31.      names.
  32.      a.)  The first list MAKEBOOK.CMD uses is a listing known OS/2 .INF
  33.           files and their corresponding titles.  When MAKEBOOK.CMD finds a
  34.           match in this list, the name of this book is automatically set to the
  35.           appropriate title for the book.
  36.      b.)  If an .INF file name is not found in the first list, MAKEBOOK.CMD
  37.           checks with a second list.  The second list contains the names of
  38.           files that are not OS/2 on-line books but do end with an .INF
  39.           extension.  MAKEBOOK.CMD will display a message that the file found
  40.           is not an OS/2 on-line book and an icon will not be created.
  41.      If an .INF file is not found in either of the above lists, an icon will
  42.      be created for the book using the file name as the title.
  43. 3.)  All icons will be created in a folder created on your OS/2 desktop titled
  44.      "MAKEBOOK.CMD - Find Results."
  45.  
  46. Modifying MAKEBOOK.CMD
  47. ======================
  48.  
  49.         MAKEBOOK.CMD is a REXX utility which means it is an ASCII text file 
  50. that you can modify.  Should you decide to modify MAKEBOOK.CMD, please do not
  51. distribute the modified version (i.e., don't post the modified version on a
  52. BBS).  If you make changes to MAKEBOOK which you feel would be of benefit to
  53. others, please send the modifications to me so I can make them in the master
  54. copy thereby keeping consistency with all the versions of MakeBook which 
  55. are in circulation.
  56.         The logic used by MAKEBOOK.CMD is a simple SELECT statement.  The
  57. following is an example from the list of known .INF files:
  58.  
  59.         when BookName="REXX.INF" then do
  60.                 BookName="REXX Information"
  61.                 FolderName="OS/2 Documentation"
  62.                 FolderID="<MB_OS2>"
  63.         end /* do */
  64.  
  65.      BookName - the title of the INF file
  66.      FolderName - the name of the folder this INF is to be placed in
  67.      FolderID - the Workplace shell ID of the folder (REQUIRED)
  68.  
  69.         The FolderName field is used to specify the name of the folder the
  70. object is to be placed in.  When specifying a folder name, you must also
  71. specify a folder ID which must be in the following format:
  72.                                 <folder_id>
  73. You may change the folder_id text to anything of your choice; however, you
  74. must have brackets (< >) on both sides of the folder_id.  This is a workplace
  75. shell construct and if you do not follow these guidelines when modifying 
  76. the MAKEBOOK.CMD utility, it may not function properly.
  77.  
  78. The following is an example from the list of files with a .INF extension which
  79. are not OS/2 .INF files:
  80.  
  81.         when BookName="OEMSETUP.INF" then Say "OEMSETUP.INF"NADA
  82.  
  83. NOTE: NADA is a variable used to store the generic text string "is not an OS/2
  84.       on-line book"  This is used in order to keep the size of MAKEBOOK.CMD
  85.       down to a minimium.
  86.  
  87. The BookName variable is a global variable which initially holds the file name
  88. of the .INF file in question.  The value of BookName will change depending on
  89. whether the file name is found in either of the lists.
  90.  
  91. Multiple Line Titles
  92. ====================
  93.  
  94.         If you want the book's title to be split into several lines, place
  95. the string "||"0a"x||" at the point where you want the line break to occur.
  96.  
  97. For example:
  98.  
  99. when BookName="MEMORY.INF" then BookName="Blake Payne's"||"0a"x||" Memory
  100.         Management Handbook"
  101.  
  102. In the above sample line (taken from MAKEBOOK.CMD), the titile of the book will
  103. be:
  104.                             Blake Payne's
  105.                      Memory Management Handbook
  106.  
  107.  
  108. Registration
  109. ============
  110.  
  111.         This is probably the last version of MakeBook that I will be
  112. circulating as shareware.  From now on, all future updates to this utility
  113. will be distributed to registered users only.  If you find this to be a 
  114. useful utility, I would encourage you to register your version.  I have
  115. spent a lot of time and energy developing this little utility, and if you
  116. are benefiting from all that laborious work the best way to thank me would
  117. be to register :-) !
  118.  
  119. ** Registered Version Features **
  120. * PM version Application with complete online help
  121.   - Easily modify or add INF titles and folders through a user-friendly
  122.     interface!
  123.   - Multimedia support! (Hey...if you have it, why not use it!)
  124.   - Any other nifty bells and whistles I can think of!
  125. * Free updates to the most recent revision!!
  126.  
  127. As you can see (look down a bit...) the registration fee is realatively
  128. inexpensive!!  Unfortunately, I want to make a little money off of this,
  129. so I have two different registration options:
  130.  
  131. $10 for electronic distribution of all updates to MakeBook
  132.         Since it doesn't cost me anything to send out email, I'll send you
  133.     updates to the most recent version of MakeBook as soon as I receive 
  134.     your registration form and check or money order.  You'll get an update
  135.     to the most recent version of MakeBook once every three months.
  136.  
  137. $20 for snail mail distribution of all updates to MakeBook
  138.         Since it costs money to send stuff through the US Postal Service,
  139.     I will send you an update to the MakeBook utility on diskette every 
  140.     three months.  The extra $10 ($2.50 per update) will cover the cost of
  141.     the diskettes, the diskette mailers, and the postage.
  142.         The one year period starts from the moment I receive your 
  143.     registration form.  I'll immediately send you your first update on a 
  144.     brand new floppy diskette!  For this distribution method, please 
  145.     allow 2-3 weeks for your first update.
  146.  
  147. PLEASE DO NOT SEND CASH!  Use check or money order and make it payable to
  148. DEREK BERUBE.  Send your payment along with the completed registration form
  149. (REGISTER.FRM) to:
  150.  
  151. Derek Berube
  152. P.O. Box 48013
  153. Athens, Georgia  30604
  154.  
  155. Thanks in advance!
  156.  
  157. Remember...registering the software you use makes you feel all warm
  158.  and fuzzy inside!
  159.  
  160. History
  161. =======
  162. 03.16.93 v1.00
  163.         *  Initial Release
  164. 07.07.93 v1.01
  165.         *  Fixed a problem with parameters field of the object that is created.
  166.            The drive on which the .INF file resides is not included in the
  167.            parameters section; therefore, when you go to look at the
  168.            book, you get an error that "Cannot open input files."
  169. 07.27.93 v1.02
  170.         *  Fixed a problem with the Express Setup query in that it would not
  171.            recognize the capital letter Y or N.  The Express Setup option will
  172.            no longer echo your key to the screen.
  173. 09.07.93 v1.03
  174.         *  Added .INF file names for the IBM 2.1 Developer's Toolkit
  175.         *  Added .INF file names for IBM C/Set++ Reference Manuals
  176.         *  Added .INF file names for miscellaneous applications
  177.         *  Made some titles multiple lines by adding the string
  178.            "||"0a"x||" to the line.  This adds a 'newline character' to
  179.            the program title.
  180. 12.27.93 v1.03
  181.         *  I only added a couple of more titles to the utility's database, so
  182.            I didn't think that incrementing the version number was in order.
  183. 04.12.94 v1.04
  184.         *  I made a significant update to the titles in the utility's database.
  185. 11.22.94 v1.05
  186.         *  I made yet another update to the titles in the utility's database.
  187.            Includes OS/2 Warp v3.
  188. 01.02.95 v2.0
  189.         *  Includes support for folders now!  Now instead of all objects being
  190.            placed in the "MakeBook  - Find Results" folder they will be placed
  191.            in specific folders inside the main MakeBook folder.
  192. 04.14.95 v2.1
  193.         *  Updated the title database some more and also optimized the use of
  194.            folder creation.
  195. ==============================================================================
  196.   THIS UTILITY IS SHAREWARE.  PLEASE FEEL FREE TO DISTRIBUTE THE ORIGINAL
  197.   MAKEBOOK.ZIP ARCHIVE, UNMODIFIED, TO ANYONE YOU CHOOSE.  PLEASE DO NOT 
  198.   MODIFY AND DISTRIBUTE THIS UTILITY.  IF YOU HAVE ANY SUGGESTIONS, PLEASE
  199.   SEND THEM TO:   DCYBERTEK@AOL.COM  RATHER THAN MODIFYING THE ORIGINAL REXX
  200.   SCRIPT.  THIS WILL HELP ME TO MAINTAIN CONSISTENCY WITH THE REVISION 
  201.   NUMBERS.
  202. ==============================================================================
  203.