home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / TGMPF101.ZIP / TGMPF.DOC < prev    next >
Text File  |  1998-10-01  |  13KB  |  247 lines
  1.                       Telegard Most Popular Files v1.01
  2.                             by Ken Reaverson
  3.                               For TG 3.09+
  4.  
  5. ┌─────────────────────────────────────────────────────────────────────────────┐
  6. │▒▒ Introduction ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  7. └─────────────────────────────────────────────────────────────────────────────┘
  8.  
  9.  Telegard Most Popular Files (referred to as TGMPF througout this docuement)
  10.  is a simple utility. It reads through your Telegard file bases, compiles
  11.  a list of which files have been downloaded the most, ranks that list,
  12.  and generates a bulletin for you to display to your users.
  13.  
  14. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  15. │▒▒ License and Disclaimer ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  16. └─────────────────────────────────────────────────────────────────────────────┘ 
  17.  
  18.  The author of TGMPF is not responsible for any damaged, corrupted, lost,
  19.  or otherwise harmful occurences that may occur from use (or inability
  20.  thereof) of this program. It has been tested, and the author runs it on his
  21.  own system. To the best of my knowledge, TGMPF has no bugs and will not
  22.  destroy anything on your system. However, I guarentee nothing, except that
  23.  this program will take up hard drive space.
  24.  
  25.  If it breaks, you own both halves.
  26.  
  27. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  28. │▒▒ Requirements ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  29. └─────────────────────────────────────────────────────────────────────────────┘ 
  30.  
  31.  TGMPF's requirements differ depending on which executable is being run:
  32.  
  33.    TGMPF/DOS:
  34.  
  35.      - MS-DOS (or compatible) 5.00 or higher
  36.      - Telegard BBS v3.09.g1 or higher
  37.      - An 80286 processor or better
  38.  
  39.    TGMPF/2:
  40.  
  41.      - OS/2 Warp 3 or higher
  42.      - Telegard BBS v3.09.g1 or higher
  43.      - An 80486 processor or better
  44.  
  45. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  46. │▒▒ Installation ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  47. └─────────────────────────────────────────────────────────────────────────────┘ 
  48.  
  49.  Installation of TGMPF is pretty simple. First, decide which executable
  50.  you're going to use (DOS or OS/2) and rename either TGMPF.DOS or TGMPF.OS2
  51.  to TGMPF.EXE. When you're done with that, move or copy the executable to
  52.  your main Telegard directory. TGMPF *must* be run from your main TG
  53.  directory.
  54.  
  55. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  56. │▒▒ Usage ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  57. └─────────────────────────────────────────────────────────────────────────────┘ 
  58.  
  59.  There is really only one consideration before starting to use TGMPF. Do
  60.  you want to exclude some file bases from consideration? For example, let's
  61.  say you have an adult base. You don't necessarily want the descriptions
  62.  for those files to be popping up in a Most Popular Files list that's
  63.  going to be seen by your entire user base.
  64.  
  65.  If you decide to exclude some bases from consideration, it's simple. Just
  66.  create a file called EXCLUDE.MPF in the same directory that TGMPF.EXE
  67.  resides (which, if you were paying attention above, would be your Telegard
  68.  Main directory ;)). EXCLUDE.MPF is a text file, one filename per line (no
  69.  extension) of the filebase you wish to exclude. An example EXCLUDE.MPF is
  70.  included in the archive. A maximum of 1000 filebases can be excluded.
  71.  
  72.  Normal usage of TGMPF is as such:
  73.  
  74.  TGMPF.EXE <root filename>
  75.  
  76.  Root filename is an eight letter filename that you wish TGMPF to output
  77.  it's information to, *no* extension. The file will be created in your
  78.  Telegard Text directory with that root filename and the extension .ANS.
  79.  
  80.  EX:
  81.  
  82.  TGMPF.EXE TOPTEN
  83.  
  84.  Would generate TOPTEN.ANS in C:\TG\TEXT if C:\TG were your main Telegard
  85.  path.
  86.  
  87.  Commandline Parameters -                                                     
  88.  
  89.    FE2TG will accept three commandline parameters:                              
  90.  
  91. <filename> - As explained above, this is an up to 8 letter 
  92.              root filename for the bulletin TGMPF will
  93.              create. This must be the first parameter
  94.              on the commandline.
  95.  
  96.        /A  - This is an optional parameter, and if specified, must
  97.              be the second parameter on the commandline. What it
  98.              does is turn off the random quote generation and ansi
  99.              header. I realize that my choice in quotes and choice
  100.              in pic may not coincide with what many sysops use for
  101.              a theme on their BBS. Specifying this option will generate
  102.              a simple header and the data, nothing more.
  103.  
  104.       /V  -  Version Information                                              
  105.  
  106.              Displays the Copyright and compilation information.
  107.  
  108.              This is optional, and replaces the root filename
  109.              parameter (meaning it must be the first). If run
  110.              with this parameter, TGMPF doesn't actually do
  111.              anything beyond displaying the copyright and
  112.              compilation information.
  113.  
  114. ┌─────────────────────────────────────────────────────────────────────────────┐
  115. │▒▒ Notes ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  116. └─────────────────────────────────────────────────────────────────────────────┘ 
  117.  
  118.  I realize that because of it's limited configurability, TGMPF may not be
  119.  popular among my peers. My primary motivation behind coding TGMPF was the
  120.  fact that I wanted it. As such, the output screens are slanted toward what
  121.  I want displayed on my own system.
  122.  
  123.  I do plan on updating TGMPF so that it'll take a user defined template,
  124.  and generate it's output using that. However, templates are a coding
  125.  concept I haven't learned just yet, so it's going to be delayed for a
  126.  bit.
  127.  
  128.  Until then, if you absolutely hate the output screens in TGMPF, and that's
  129.  the only thing preventing you from using it, design your own screen,
  130.  and send it to me via one of the methods listed in my contact information.
  131.  I'll hardcode the screen in and send you back a custom version.
  132.  
  133.  There is one known problem with TGMPF. Right now, if your description has
  134.  color codes in it, when TGMPF's display screen displays, the end bracket will
  135.  be a little off. The reason for this is that TGMPF does not strip color codes
  136.  from the description. When it goes to pad the string out to 45 characters,
  137.  those color codes count toward the overall total. When TG displays, it
  138.  naturally translates the color codes, and the result is that the end bracket
  139.  is set further back. If this is a major annoyance, you have two options.
  140.  Either remove the color codes from the description, or bug me to add color
  141.  stripping. :)
  142.  
  143.  If anyone else is actually reading this, you might be wondering why I'm
  144.  taking such a lackadasical attitude about this program. The reason is this;
  145.  I don't think it'll see much use until it allows sysops to define their own
  146.  output. As such, that means it's being coded to satisfy me and me only.
  147.  When I put a template capable version out, I'll care a whole lot more about
  148.  everyone else's satisfaction.
  149.  
  150.  I can forsee one other request possibly being made of me in regards to
  151.  this program. I instituted an Exclude list, so why not an Include list?
  152.  I can understand the desire behind wishing to display a Most Popular
  153.  Telegard utilities list, or a Most Popular MIDI Files list, or even a
  154.  most popular XXX JPEG List. ;) However, I don't desire to do any of these
  155.  things on my own BBS, and consequently, this program doesn't support such
  156.  an option. However, if enough people ask me (preferably in a somewhat
  157.  civil manor) I will add this capability to the program.
  158.  
  159.  TGMPF/DOS has been compiled with Borland Pascal v7.0.
  160.  
  161.  TGMPF/2 has been compiled with Virtual Pascal v1.10                          
  162.  
  163.  The source code to either version is not available to the public, and it     
  164.  is not for sale, so please don't ask. :)                                     
  165.  
  166. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  167. │▒▒ Registration ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  168. └─────────────────────────────────────────────────────────────────────────────┘ 
  169.  
  170.  TGMPF is FreeWare. End of story. Live free or die, ladies and gentlemen. :)  
  171.  
  172.  If you appreciate the work I've put into the software, and if it's been      
  173.  useful to you, drop me a line via one of the below contact methods. The      
  174.  experience of writing the program has been payment enough for me, but it's   
  175.  always nice to hear 'Thanks dude!' once in awhile. :)                        
  176.  
  177. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  178. │▒▒ Distribution ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  179. └─────────────────────────────────────────────────────────────────────────────┘ 
  180.  
  181.  TGMPF may be freely distributed in it's unmodified format. See PACKING.LST
  182.  for a list of what should be included in the archive. The archive's original
  183.  fornat is ZIP, and it has been stamped with my AV codes. If the archive
  184.  you've received is not a ZIP, be wary. When unzipping this archive, at
  185.  the very end, you should see the following:
  186.  
  187.  Authentic Files Verified!   # CIS105
  188.  Blood Enterprises, Inc.
  189.  
  190.  If this message is not present, the archive may have been tampered with.
  191.  
  192.  The most current version of TGMPF will always be available for FREQ
  193.  on Shadowdale with the magicname TGMPF. See below for my contact
  194.  information. Any new versions will be hatched down the FidoNet TG_SUP
  195.  filebone.
  196.  
  197. ┌─────────────────────────────────────────────────────────────────────────────┐
  198. │▒▒ Copyrights ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  199. └─────────────────────────────────────────────────────────────────────────────┘ 
  200.  
  201.      Telegard Most Popular Files is Copyright Blood Enterprises, 1998.
  202.                                     All Rights Reserved.
  203.  
  204.      Telegard is Copyright Tim Strike, 1994,1998. All Rights Reserved.        
  205.  
  206. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  207. │▒▒ Special Thanks ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  208. └─────────────────────────────────────────────────────────────────────────────┘ 
  209.  
  210.  The following people deserve special thanks for their efforts, whether it
  211.  be direct or indirect, for bringing this utility about:
  212.  
  213.       Tim Strike  - Thanks, as always. :) You know the reasons, so I won't
  214.                     bother to repeat them for the 9 or ten millionth time.
  215.  
  216.      David Stumpf - For his help with the ranking code in this util, and
  217.                     a whole lot of example code for other projects. :)
  218.  
  219.      Arthur Stark - For being my beta tester. :)
  220.  
  221.  Thanks to Vision of ACiD Productions. I borrowed the little grey ansi guy
  222.  with the red flag from one of his ads for Santuary.
  223.  
  224.  Thanks also to Jeff Irvine, because I borrowed the basic template for this
  225.  document from him. ;)
  226.  
  227. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  228. │▒▒ Service & Support ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  229. └─────────────────────────────────────────────────────────────────────────────┘ 
  230.  
  231.  Contact Information -                                                        
  232.  
  233.    Author: Ken Reaverson                                                      
  234.     Email: tremere@mindless.com                                               
  235.       WWW: http://adrianblood.home.mindspring.com                             
  236.       BBS: Shadowdale - (770) 982-7859                                        
  237.            Login: Guest  Password: PRAISETIM                                  
  238.   Netmail: 1:133/1004   - FidoNet                                             
  239.            111:4350/101 - Sysop's TechNet                                     
  240.  EchoMail: TG_SUPPORT (FidoNet)                                               
  241.            ADV_TG (AdventureNet)                                              
  242.  
  243.  If you have a question or a problem with the software, by all means, get     
  244.  into contact with me via one of the above methods. I welcome comments and    
  245.  suggestions, and if you find a bug in the software, I'll do my damndest to   
  246.  fix it with all speed.
  247.