home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / filbase2 / filebase.doc < prev    next >
Text File  |  1992-06-02  |  9KB  |  225 lines
  1. FILEBASE the File database creator  Written by Paul Baker , The Tavern BBS
  2. --------------------------------------------------------------------------
  3. --->>>This Version of Filebase is for use on Turbo V2 BBS ONLY!<<<---
  4.       =========================================================
  5.  
  6.                             -: FNET NODE 1042 :-
  7.  
  8. If you are running this program for the first time follow these instructions
  9. otherwise skip them and go onto the section titled MACROS.
  10.  
  11. If you are using an earlier version of Filebase that ISN'T V2 specific then
  12. I suggest you run CREATE as below and Choose R for rename when asked, this
  13. is due to the fact that the new .INF has more entries than the old one.
  14.  
  15. If you are using a V2 specific version of Filebase then just replace the old
  16. .TTP with the new one.
  17.  
  18. The archive
  19. -----------
  20.  
  21. Your Archive should contain the following files
  22.  
  23. FILEBASE.TTP - This is the actual program file
  24. FILEBASE.EXP - Example FILEBASE.INF
  25. FILEBASE.DOC - You are reading it
  26. FILEBASE.FUL - Header for the top of the FULL filelist (optional)
  27. FILEBASE.LAT - Header for the top of the LATEST files list (optional)
  28. FILEBASE.ALL - Header for the top of each seperate file area list (Optional)
  29. FILEBASE.IN  - Header put inbetween each file section in the FULL and 
  30.                LATEST filelists. (Optional)
  31.  
  32.  
  33. Starting Filebase from scratch
  34. ------------------------------
  35. Run  CREATE.PRG for create a basic FILEBASE.INF file
  36.  
  37. 1) Make sure you run it from your main bbs directory as it has to have 
  38.    access to your turbo.opt.
  39.  
  40. 2) The program will then read the drives , directory names and paths that it
  41.    needs and will display them on screen as it does so, it will then write
  42.    out a FILEBASE.INF file.
  43.  
  44. 3) You need to edit FILEBASE.INF with a text editor to do the following :
  45.  
  46.    a) Enter the  maximum file access level that you want listed
  47.  
  48.    b) Enter either a  1,2 or 0 depending if you want it to create ROOT1.TXT
  49.       or ROOT2.TXT or not create a header file , you can then create your
  50.       own ROOT1.TXT.
  51.  
  52.             (see filebase.exp for further details and examples)
  53.  
  54.    c) You have 2 Options if you do not want some of your file sections to be
  55.       accessable by others.
  56.  
  57.         1) Make the access level next to the File area name 32767 and the
  58.            list will still be produced , but ONLY you will be able to view
  59.            it and it won't appear in the Full or xxDays listings.
  60.  
  61.         2) Delete the lines containing names of any directories that you do 
  62.            not wish to be listed, if you do delete any please make sure you
  63.            reduce the number above the directory names accordingly.
  64.  
  65.    d) The newly created FILEBASE.INF has an access level of 0 set just after
  66.       the Directory name, if you change these values , then only users of
  67.       that value or above will be able to view it.
  68.  
  69.             (see filebase.exp for examples)
  70.  
  71.    e) If you wish to have your own descriptions of your file areas instead of
  72.       just the file directory names, Enter the descriptions you wish to be 
  73.       included in the database menu, by deleting the ! after the comma and 
  74.       replacing it with your own text.
  75.  
  76.             (see filebase.exp for further details and examples)
  77.  
  78.    f) Enter the FULL path of the database  you want filebase to create 
  79.       , minus the last \     e.g. e:\turbo\filebase\ becomes just
  80.       e:\turbo\filebase
  81.  
  82.    g) Enter the FILENAME.EXT (Without a path) of the full filelist you want
  83.       to be created (I have mine set to TAVERN.TXT to identify the BBS), If
  84.       you leave it blank then FULL.TXT will be used as a default.
  85.  
  86.    h) Enter the FILENAME.EXT (Without a path) of the last XX Days Uploads
  87.       list , leaving it blank will make it default to XXdays.txt
  88.  
  89. [If you don't require the full List or XXdays list you MUST still leave a
  90. blank line in these spaces]
  91.  
  92.    i) If you wish any extra files not created by Filebase itself to be 
  93.       kept in the Database (An archived Filelist for example) , the lines
  94.       following the xxdays.txt list name will allow you to do this.
  95.  
  96.       The first line is the number of extra files you want to add.
  97.       (Make the line 0 if you don't want to add any)
  98.  
  99.       This is followed by THREE lines per file , one for the filename 
  100.       (No Path) , the second is the files access level and the third is
  101.       for the description to appear in the database.
  102.  
  103.       [See Filebase.exp for examples and further details]
  104.  
  105.  
  106. If you add another download directory at a later date , just add the folder
  107. name to the current list of folder names in FILEBASE.INF, making sure you
  108. follow the following format and also remembering to increase the number
  109. above the folder names by 1.
  110.  
  111. Folder Name,Access Level,Description
  112.  
  113.  
  114. MACROS
  115. ------
  116.  
  117. The Optional Text files used as headers in Filebase have Macros, this allows
  118. you to put the information anywhere in the text file.
  119.  
  120. #SECTION   - This will be replaced by the name of the current download
  121.              section being read.
  122. #LISTINGDT - This will be replaced by the current Date
  123. #TIME      - This will be replaced by the current Time
  124.  
  125. e.g.
  126. ---------------------------------------------------------------------------
  127. |  The Tavern BBS       Turbonet 100:101/11    Fidonet  2:255/408         |
  128. |                                                                         |
  129. |                               #SECTION                                  |
  130. |                                                                         |
  131. |                Files are sorted so most recent are at top               | 
  132. ---------------------------------------------------------------------------
  133. List Last Updated on #LISTINGDT at #TIME
  134.  
  135. will be shown as 
  136.  
  137. ---------------------------------------------------------------------------
  138. |  The Tavern BBS       Turbonet 100:101/11    Fidonet  2:255/408         |
  139. |                                                                         |
  140. |                               GRAPHICS                                  |
  141. |                                                                         |
  142. |                Files are sorted so most recent are at top               | 
  143. ---------------------------------------------------------------------------
  144. List Last Updated on 14.10.1992 at 12:34
  145.  
  146.  
  147. Running Filebase.ttp
  148. --------------------
  149.  
  150. The Program accepts 7 parameters  S , F , U , R , P , L & C
  151.  
  152. ( It doesn't matter in what order you put the above commands)
  153.  
  154. S - Sorts the files into alphabetical order
  155.  
  156. F - Produces a Full list of everything in all the File sections
  157.  
  158. U - needs to be followed by a delimiter, it shows files that have been 
  159.     recently uploaded/added within a specified number of days from the 
  160.     current day.
  161.  
  162. [ Both the Full List and xx days Upload List will NOT show those file
  163.   areas which have an access level greater than the lowest access level
  164.   in the FILEBASE.INF file  ..e.g....
  165.  
  166.   You have 10 file area lists, 2 of which are sysop support (Say level 20)
  167.   the rest are at level 0 to allow new users to view or download.
  168.  
  169.   Only those people at level 20 or above will be able to view the text
  170.   files for the Sysop Support Areas , when it comes to writing out the Full
  171.   or Upload lists , the program will skip the level 20 file areas and only
  172.   write out the level 0 file areas. ]
  173.  
  174. R - Stops the Seperate download section lists being produced, it will only
  175.     write out the files created using the F and U options, if you only want
  176.     these lists produced.
  177.  
  178. P - Will Print out the full description of the download next to the filename
  179.     instead of the shorter 1 line description.
  180.  
  181. L - Needs to be followed by the FULL path and filename of the file to be
  182.     created, it will print out a Full list of files available WITHOUT the 
  183.     menu being created, this could be used for those boards who are running 
  184.     FIDO style mailers and want to have a full list available for FREQ 
  185.     by other mailers.
  186.  
  187.     NB: if you use option L you can only access the S,P & C parameters at
  188.         that time.
  189.  
  190. C - Will add a box [   ] with the Access Count for that file and the
  191.     Percentage rating given to that file to the description.
  192.  
  193. Some Examples
  194. -------------
  195.  
  196. FILEBASE SFU 28  
  197.  
  198.  will sort the files alphabetically in the database and provide a 
  199.  full list ,( I also archive this using a batch file into another
  200.  database entry) and the U 28 will show all files added to the
  201.  BBS within the last 28 days.
  202.  
  203. FILEBASE RSFPUC 28 
  204.  
  205.  Will only sort and write out a full list and the last 28 days 
  206.  upload list, print the full description of each file instead
  207.  of a single line and add the Access count and % rating for each
  208.  file.
  209.  
  210. FILEBASE LSP E:\TURBO\TXT\FILELIST.TXT
  211.  
  212.  Will create just a single file with no menu where the full 
  213.  descriptions are used and the entries are alpha sorted.
  214.  
  215. I have in my Daily.Bat the following command line.
  216.  
  217. d:\turbo\filebase.ttp FUPC 28
  218.  
  219. The Program maintains it's own 'Main Menu' unless L is used in which case no
  220. menu is produced.
  221.  
  222. I hope you find this useful.
  223.  
  224. Paul Baker  The Tavern BBS   Node: 1042 
  225.