
            
            #====================================================#


               *ENHANCED* FILE REQUEST SCRIPT FOR TELEGARD v3.X


               Original script code by The Sandman (Brad Koski)

              Enhancements and ANSI Header by Xypher Matryx/DARK

                             Released : 06/01/97


            #====================================================#




                              *** DISCLAIMER ***

   #1 -- I hate documentation, and any of these instructions, or the comments
         within the script itself, could be utterly useless.  Therefore, I'll
         warn you:  If you get confused, stuck, or lost in any way, you're on
         your own.  It made sense to me at the time, and that's that.  ;>
         
   #2 -- I take no responsibility for *any* damage this script might cause to
         your BBS setup, your computer, your sanity, your social standing, or
         the fabric of the space/time continuum in your vicinity.  Though I'm
         fairly certain this simple little script is harmless, there may have
         been unseen hands at work on it since I sent it out.
         
         In summary: USE AT YOUR OWN RISK!
         
                              *** DISCLAIMER ***
                              



            #====================================================#

            
                                   FUNCTION

      Many Bulletin Board Systems have message bases devoted to file requests
   of some sort. The Sandman (Brad Koski) wrote a small script that asked the
   user for a filename and description of their request.  The concept to this
   script was sound, but in my eyes, the execution was lacking.
    
      (Nothing personal Brad. =)

      This Enhanced Version of The Sandman's File Requester script offers you
   an ANSI header, improved performance (said debugged code ;), and formatted
   output, among other things.  I'm afraid you'll still have to manually edit
   the File Request List though.
   
      To be perfectly honest, it's my first attempt with Telegard's scripting
   code.  I've been a programmer for years, and a SysOp even longer.  From my
   SysOp's perspective, I'm excited at the prospect of building more advanced
   features into my BBS, without the need for external doors. As a coder, I'm
   frustrated by the lack of certain features.  Even so, Telegard's scripting
   language is perfect for these sorts of utilities.  (IMHO)
   
      I've commented the script as thoroughly as I could, though I hate docu-
   mentation with a passion.   I hope it's clear enough to understand.  Strip
   all the ;'d lines out to make it clearer.  ;>
   

            #====================================================#
            

                                 INSTALLATION
                                 
      Before you do anything else, backup your system.  I don't mean to alarm
   you; this is (to my knowledge) a completely harmless script.   Better safe
   than sorry, though. =)  This script was run using Telegard v3.02/mL, so if
   you're using a different version, best to check the code and make sure I'm
   not employing commands that don't exist, or work differently.

   --

      First things first: edit the script (FREQLIST.SCR) and change the paths
   to reflect those of your Telegard setup.  FREQLIST.SCR should be placed in
   your default \TEXT\ directory.  If you plan to use the ANSI header instead
   of the internal one, you'll have to rename it to FREQLIST.MSG, and move it
   into the \TEXT\ directory as well.
   
      Once you've edited the script and placed it in the \TEXT directory, two
   commands will have to be added to your menu(s) in order to make use of the
   script and it's output.  I've included example below to illustrated :


             1. Long Description                                   
                " R.equest File      - Submit File Request"        
             2. Short Description                                  
                " R.equest File"                                   
             3. Keys       R                                       
             4. Command    -E - Execute Script                     
             5. Options    "freqlist ~UH ~SJ"                      
             6. Access     ""                                   
             7. Display    ACS Dependant

             
      Using Telegard's -E command to execute the script explains itself.  The
   Options field is most important; two parameters must be passed so that the
   script's output displays properly.  ~UH is the User's Handle (if you don't
   use anything but Real Names, use ~UR), and ~SJ is the current date.
   
      [I recommend placing these commands in the File menu.]


             1. Long Description                                  
                " L.ist Requests    - Display File Request List" 
             2. Short Description                                 
                " L.ist Requests"                                
             3. Keys       L                                      
             4. Command    -G - Display file (def. PP, Pause)     
             5. Options    "freqlist"                             
             6. Access     ""                                  
             7. Display    ACS Dependant                          
             
      -G displays a file with a pause after it's done.  If you'd rather there
   was no pause, use -F.  FREQLIST.MSG will be displayed.
   
      [If you're up to suggestions, you might to consider displaying the list
   just before the "Scan for New Files? Y/N" prompt.  And if you're up to the
   task of writing a batch file, you could rename the file with your bulletin
   prefix and display it there. =]
   
      Now you're all set!
      

            #====================================================#

            
                               FUTURE FEATURES
                               
   -- Like what?  Highlight bars?  Ugh.  Excessive.  Write your own.  ;)
   
   -- List editing: Unless you're utterly inept with a text editor, it really
      shouldn't be too difficult to go in delete a few lines.  If I find some
      way of doing it though, *with* the script language, I'll release it.
      

            #====================================================#
            

                             CREDITS & GREETINGS
                             
   The Sandman / Original Script Code
   
   Xypher Matryx / Enhancements, ANSI header, stuff.
   
   Tim Strike / Telegard
   
   --
   
   "Harro-kens" to Carnifex, watOr, Space Ace, The Green Hornet, & Yggdrasil.
   
   Greets to the entire 416/905 dynasty.  Take a bow, you maniacs. ;)
   

            #====================================================#
