home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 3 / Meeting_Pearls_III.iso / Pearls / dev / AmigaE / Mods2Guide / Mods2Guide.doc < prev    next >
Encoding:
Text File  |  1995-08-13  |  6.5 KB  |  160 lines
  1.                                                         
  2.                            Mods2Guide V2.1                (August 13, 1995)
  3.                            ---------------
  4.     General:
  5.     -------
  6.     This is a simple program that will convert the contents of the Amiga E
  7.     "Modules" directory into an AmigaGuide file, for easy reference.
  8.     This AmigaGuide file will contain the expanded ascii contents of the
  9.     Emodules: directory.  Two hypertext files will be created:
  10.     E_Modules.guide and E_Modules.index.  Keep these 2 files together in the
  11.     same directory.
  12.  
  13.     Since this program is only of use to E programmers, it is designed to
  14.     be run from a Shell.  However, if you are happy with the default values,
  15.     just double-click the icon.  "Mods2Guide INFO" gives a brief description
  16.     of the requirements and command line arguments.  Command line arguments
  17.     are optional - all options have defaults.
  18.  
  19.     <Control - C> will halt the program at any time.
  20.  
  21.  
  22.     Requirements:
  23.     ------------
  24.     *  "Emodules:" must be assigned to the directory containing the modules.
  25.     *  Kickstart 37 (Workbench 2.04) or later.
  26.     *  When I ran this version of Mods2Guide on the Modules directory of
  27.        the Amiga E V3.2a distribution package, about 900K of free RAM where
  28.        required to create the files.  This included 374893 bytes for the
  29.        E_Modules.guide file, and 21548 bytes for E_Modules.index (using the
  30.        default settings).  If your Emodules: directory is larger, you will
  31.        need even more.
  32.  
  33.  
  34.     Limitations:
  35.     -----------
  36.     The program will exit gracefully if:
  37.     *  There are directories nested inside of directories.
  38.     *  There are more than 98 directories.
  39.     *  There are more than 75 files in any directory (except the
  40.          root directory).
  41.  
  42.     If for any reason Wouter should change the output format of his
  43.     ShowModule program, this version of Mods2Guide will probably no longer
  44.     function properly.
  45.  
  46.  
  47.     Mods2Guide V1.1:
  48.     ---------------
  49.     If you have a problem with Requirements/Limitations above, you might
  50.     try V1.1 of Mods2Guide.  This is an ARexx program that does exactly
  51.     the same job, (except that it does not create the ".index" file), but
  52.     quite a bit slower.  The requirements are the same, except that it
  53.     requires an additional PD library (see the docs).
  54.  
  55.     It's only limitation is that there can be no nested directories.
  56.  
  57.  
  58.     Command Line Template:
  59.     ---------------------
  60.     The command line template of Mods2Guide V2.1 is as follows:
  61.  
  62.         Mods2Guide  INFO/S, S=SMDIR/K, H=HEIGHT/N, ND/N, NF/N, NR/N
  63.  
  64.  
  65.     Argument Description:
  66.     --------------------
  67.       INFO    Displays some basic information.
  68.       SMDIR   The path to the directory containing ShowModule.  The default
  69.               is that ShowModule is already in your search path.  If used,
  70.               the path must end in a ":" or a "/".
  71.       HEIGHT  The height, in rows, of the created AmigaGuide window.
  72.               The default is 16, which nicely fills a 200 pixel high window.
  73.               A height of 5 will be used if a number < 5 is entered.
  74.       ND      Number of directory names placed on 1 line.  These are the
  75.               names in the main (Contents) window.  The default is 4.
  76.       NF      Number of filenames placed on 1 line.  These are the filenames
  77.               shown when you click on a directory name.  The default is 2.
  78.       NR      Number of root-filenames placed on 1 line.  The default is 3.
  79.  
  80.       The ND, NF and NR only pertain to the "E_Modules.guide" file.  Entries
  81.       in the "E_Modules.index" file are always 1 to a line.
  82.  
  83.  
  84.       Example:
  85.       -------
  86.       1> Run Mods2Guide  S=DH0:AmigaE/Bin/  NR=1
  87.  
  88.       will specifically look for ShowModule in the "DH0:AmigaE/Bin/"
  89.       directory, and create the "E_Modules.guide" file with the directory
  90.       names placed 4 across, the nested filenames 2 across, but the root
  91.       filenames only 1 to a line, similar to the "E_Modules.index" file.
  92.  
  93.  
  94.     E_Modules.guide:
  95.     ---------------
  96.     The "Contents" page of this file has a gadget for every directory
  97.     in "Emodules:", plus another labeled "Modules in the Root Directory".  
  98.  
  99.     Clicking on one of the directory gadgets will display a list of
  100.     every module in that directory.  Clicking on one of the module names
  101.     will show the expanded ASCII contents of that module.
  102.  
  103.     Clicking on the "Modules in the Root Directory" gadget will display a
  104.     list of every module in the root directory.  Clicking on one of the
  105.     module names will show the expanded ASCII contents of that module.
  106.  
  107.  
  108.     E_Modules.index:
  109.     ---------------
  110.     If you click on the AmigaGuide "Index" gadget, when E_Modules.guide is
  111.     loaded, and the E_Modules.index file is in the same directory, that file
  112.     will be loaded.  This displays an alphabetical list of ALL the modules,
  113.     and also shows that module's parent directory.  Clicking on one of the
  114.     module names will show the expanded ASCII contents of that module.
  115.  
  116.  
  117.     Advantages:
  118.     ----------
  119.     The two main advantages of this program are:
  120.  
  121.     1.  It should also work for any future revisions of the Modules
  122.         directory (subject to the limitations above), and
  123.  
  124.     2.  It will not be necessary to distribute a 350K+ AmigaGuide
  125.         document, just a < 15K program, as everyone will be able to
  126.         create their own AmigaGuide document.
  127.  
  128.  
  129.     Don't Have Room to Keep These Files?:
  130.     ------------------------------------
  131.     I have written another program, similar to this, for those who do not
  132.     have disk space to keep these large AmigaGuide documents around.
  133.     "SeeModule" is sort of a GUI for ShowModule.  It creates a file that
  134.     looks almost identical to E_Modules.guide (or E_Modules.index, your
  135.     option), and also works the same way.  The difference is that the
  136.     modules have NOT been pre-expanded - this is done individually, as they
  137.     are selected.  Therefore, the only file you need to have handy is about
  138.     20K in size.  Users with hard drives will probably prefer Mods2Guide.
  139.  
  140.  
  141.     Problems/Questions:
  142.     ------------------
  143.     This is the first program I have written in E, so bear with me.
  144.  
  145.     Thanks to Wouter for a great job in forming the language.  Thanks also
  146.     to Barry Wills and Jaco Schoonen for their help in the development of
  147.     this program.
  148.  
  149.     Address comments or questions to:
  150.  
  151.             Robert Bromley                         Email:
  152.             1168 Timber Lane
  153.             Victoria,   B.C.          Bob_Bromley@amusers.victoria.bc.ca
  154.             CANADA
  155.  
  156.     Hope you find this useful.
  157.           __
  158.          /_/  __   /_
  159.      _  /_/  /_/  /_/  _
  160.