home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / s / syread03.zip / MAKEIDX.DOC < prev    next >
Text File  |  1980-01-01  |  7KB  |  170 lines
  1.                                      - 1 -
  2.  
  3.  
  4.         ╔═══════════════════════════════════════════════════════════╗
  5.         ║            S Y N E R G Y   M A K E I D X  V1.0            ║
  6.         ║       a utility for Searchlight BBS Sysops and SLDIR      ║
  7.         ║                      Copyright(c) 1992                    ║
  8.         ║                  Synergy Computer Systems                 ║
  9.         ║                    Cocoa Beach, Florida                   ║
  10.         ╚═══════════════════════════════════════════════════════════╝
  11.  
  12.  
  13.  
  14. In addition to making an index file for the SYNERGY ALLFILES READER . . .
  15.  
  16. SLDIR Directory Listing for 2-24-92                     [SLDIR ? for Help]
  17.  /│\                                                     /│\
  18.   └── MAKEIDX will replace "SLDIR" with the               │
  19.       name of your BBS and place your phone number here ──┘
  20.  
  21.   ┌── Then replace "Searching" with any string you choose.
  22.  \│/
  23. Searching INTRO
  24.  
  25. NOTE:  Enhanced MAKEIDX.EXE is part of the registered SYNERGY.EXE package.
  26.  
  27. MAKEIDX.EXE is designed to run from inside a batch file (no user input
  28. required) so that you may run it during any event than that runs SLDIR,
  29. whether that event is a BBS maintenance event, a door for custom "User Level"
  30. Lists or from DOS.  MAKEIDX.EXE is NOT to be distributed with your BBS
  31. Allfiles list, it is for the sole use of the host BBS system.
  32.  
  33.  
  34.  
  35. ╔════════════════════════╗
  36. ║ THE CONFIGURATION FILE ║
  37. ╚════════════════════════╝
  38.  
  39.   The FreeWare version of MAKEIDX.EXE requires a configuration file:
  40.   MAKEIDX.CFG (optional with Enhanced MAKEIDX) to set colors and know
  41.   what strings to look for and append.  Should you be missing MAKEIDX.CFG,
  42.   MAKEIDX.EXE will make one with the following defaults:
  43.  
  44.   3                 <-- Main Text Color.
  45.   0                 <-- Main Background Color.
  46.   15                <-- Message Text Color.
  47.   1                 <-- Message Background Color.
  48.   Your BBS Name     <-- Replacement string for "SLDIR" (max 15 characters).
  49.   Synergy           <-- Legal DOS prefix for the .IDX and .LST files.
  50.   Searching         <-- Original directory prefix string (max 15 characters).
  51.   Directory         <-- Replacement string for dir prefix (max 15 characters).
  52.   (407) 555-1212    <-- Your BBS Phone number.
  53.  
  54.   MAKEIDX.CFG  should be edited to suit your needs.
  55.  
  56.                                      - 2 -
  57.  
  58.    ╓────────╖
  59. ───╢ COLORS ╟───
  60.    ╙────────╜
  61.      Lines 1 through 4, legal values for colors:
  62.     ┌────────────────┐       ┌───────────────────┐
  63.     │   Background   │       │    Text Colors    │
  64.     ├────────────────┤       ├───────────────────┤
  65.     │ Black      = 0 │       │ Background Colors │
  66.     │ Blue       = 1 │       │ DarkGray     =  8 │
  67.     │ Green      = 2 │       │ LightBlue    =  9 │
  68.     │ Cyan       = 3 │       │ LightGreen   = 10 │
  69.     │ Red        = 4 │       │ LightCyan    = 11 │
  70.     │ Magenta    = 5 │       │ LightRed     = 12 │
  71.     │ Brown      = 6 │       │ LightMagenta = 13 │
  72.     │ LightGray  = 7 │       │ Yellow       = 14 │
  73.     └────────────────┘       │ White        = 15 │
  74.                              └───────────────────┘
  75.  
  76.    ╓─────────╖
  77. ───╢ STRINGS ╟───
  78.    ╙─────────╜
  79.  
  80.        Lines 5 through 8 provide the required information to first scan  the
  81.   ????????.LST file, then create the ????????.IDX file and finally append the
  82.   ????????.LST file for use with the ????????.IDX file in SYNERGY.EXE Reader.
  83.  
  84.   NOTE: though SYNERGY.EXE may be renamed to your liking, and MAKEIDX will
  85.         append any .LST file with a legal DOS prefix (defined in MAKEIDX.CFG),
  86.         SYNERGY.EXE (UNREGISTERED) will ONLY read/use the file names
  87.         SYNERGY.LST and SYNERGY.IDX
  88.  
  89.   The MAKEIDX utility processes the .CFG file one character at a time,
  90.   counting each space, if there is more than one space in a row it is
  91.   interpreted as the end of the string, records that value, then goes
  92.   to the next line.  All strings are limited to 15 characters long
  93.   (EXCEPT for line 6, which is limited to 8 characters) and may be any
  94.   ASCII character in the decimal range of 32 to 254 (see the ASCII table
  95.   in your DOS manual), though I recommend using the range of 32 to 126
  96.   (keyboard characters) due to lack of support for higher characters with
  97.   some printers.
  98.  
  99.   Line 5  should contain the name of your BBS (less "BBS" - MAKEIDX adds
  100.           "BBS" to the end of this string.  This string replaces the string
  101.           segment "SLDIR" on the first line after the SLDIR.TXT insert.
  102.  
  103.           NOTE:   if the SLDIR string does not exist, then this string
  104.                   will be ignored while processing the .LST file.
  105.  
  106.           This line is also passed to the .IDX file for use by the end-user
  107.           registered version of SYNERGY.EXE (allowing the home viewer to
  108.           switch between multiple .LST and .IDX files from different BBS'
  109.           without leaving the reader.
  110.  
  111.                                      - 3 -
  112.  
  113.   Line 6  is the prefix name of the .LST file to be processed and the .IDX
  114.           file to be created.
  115.  
  116.   Line 7  is the string that MAKEIDX will look for in the .LST file (prior
  117.           to appending) that signifies "This line is a directory name!".
  118.           It should include all characters up to, but not including any
  119.           directory name.  Though I have not tested this with allfiles lists
  120.           created by utilities other than SLDIR, I added this feature in
  121.           hopes that this package would work with most any BBS.
  122.  
  123.   Line 8  is the string that you wish to replace line 7 with in the appended
  124.           .LST file. if you wish for the appended version of .LST to retain
  125.           the old directory prefix (line 7) then this line should duplicate
  126.           line 7.
  127.  
  128.   Line 9  is the phone number of your BBS.  This line is tagged on to the end
  129.           of the appended SLDIR line and replaces "[SLDIR ? for Help]".
  130.  
  131.           This line is  also added to the .IDX file for use by the end-user
  132.           registered version of SYNERGY.EXE (where it will be placed on the top
  133.           line along with the name of your BBS).
  134.  
  135. ╔══════════════════╗
  136. ║ THE COMMAND LINE ║
  137. ╚══════════════════╝
  138.  
  139.    This version of MAKEIDX.EXE has one command line switch:
  140.    MAKEIDX /x
  141.    the "x" must be in lower case, if this switch is present, MAKEIDX
  142.    will run in "Silent Mode" - it will not display to the screen what
  143.    it is doing.  This switch was added for the "Synergy Allfiles Door",
  144.    included in this package as "FILDOR10.ZIP".
  145.  
  146.    NOTE: Any other command line parameters with Enhanced MAKEIDX.EXE
  147.          will call up a menu complete with internal MAKEIDX.CFG
  148.          editor.
  149.  
  150. ╔═════════════════════╗
  151. ║ GENERAL INFORMATION ║
  152. ╚═════════════════════╝
  153.  
  154.   Should you run across a bug or have an idea for something you would like to
  155.   see added to this program please write me at:
  156.  
  157.           Ron Ryan
  158.           Synergy Computer Systems
  159.           524 S. Atlantic Ave. #3
  160.           Cocoa Beach, Florida, 32931
  161.  
  162.   Copyrighted(c), 1992, All Rights reserved -  Synergy Computer Systems.
  163.  
  164.   MAKEIDX.EXE may ONLY be distributed in its original archive.
  165.  
  166.   MAKEIDX.EXE  may not be modified in any way without the express
  167.   written consent of:
  168.                         Synergy Computer Systems
  169.                           Cocoa Beach, Florida.
  170.