

                       -------------------------
                          skTopTenFiles  (tm)
                             Version 1.00e
                     a wcCode Top Ten Files Lister
                          for Wildcat! 5 BBS
                       -------------------------


                       (c) Copyright 1996 skWare
                          All Rights Reserved

                              skWare (tm)

                   Steve Davies (steve@welcom.gen.nz)                      
                   Kevin Murphy (kevin@welcom.gen.nz)

                 Documentation version 1.00e 14/06/1997

 *** By using this software you agree to the terms of the Software ***
 *** License Agreement and Disclaimer of Warranty. These are in the ***
        *** files license.txt and warranty.txt respectively. ***

Contents
--------
1.  Purpose
3.  Registration
4.  Files
5.  Installation Instructions

1.  Purpose
-----------
skTopTenFiles is a program that produces an HTML page for Navigator
callers. This page will list the hottest ten files on your system, and
will include their description and size, etc. Also it creates a link to
each file so that your callers will only have to click on the file name
to download the file. It also is able to produce a TEXT file of the top
ten file downloads.

Please note that unlike a number of other "top ten" file listers, this
program searches through your activity logs for downloads. It does not
simply find the 10 files in the database with the most downloads. This
way your top ten page will list what is hot right now.

Once the program is registered you can specify a header file that will
be inserted into the output page. This can include whatever graphics you
want to keep with your BBS theme, and can include custom backgrounds,
etc.  The program can be set up to run as an event each night or you
can run it manually at any time.

2.  Registration
----------------
Please refer to the file register.txt for details on registration of
skTopTenFiles.

3.  Files
---------
The following files are included in the archive that you downloaded.

skware.txt             <--- important information about skWare
sysop.txt              <--- you are reading it now
history.txt            <--- notes about changes etc.
register.txt           <--- notes about registration
sktoptenfiles.wcx      <--- THE executable program for the game
sktoptenfiles.bat      <--- an example batch file to run the program
sktoptenfiles.cfg      <--- an example configuration file
file_id.diz            <--- Long program description
desc.sdi               <--- Short program description
*.gif                  <--- Some gifs to pretty up the html output
sk*.htm                <--- Example html pages to customise output page

feedback.txt            <--- information on sending feedback to skware
license.txt             <--- information on software license
warranty.txt            <--- information on software warranty


4.  Installation Instructions
-----------------------------
- Package Installation

    1 - Create a subdirectory for skTopTenFiles where you wish.  We
        suggest c:\wc5\sktoptenfiles or something similar.

    2 - Extract all the files from the archive into this directory.
    
    3 - Move the following files into the wildcat home directory
        (eg: c:\wc5)

        sktoptenfiles.wcx
        sktoptenfiles.bat

    4 - All the other files in the archive are already in relative
        directories and should be move as follows:-

            data                    => c:\wc5\data
            http                    => c:\wc5\http
            http\public\graphics    => c:\wc5\http\public\graphics


    7 - Edit the sktoptenfiles.cfg file as required following the
        instructions in config.txt

    8 - Its now ready. You can run the batch file manually to see the what
        the output is like. You may also want to set it up as an event that
        runs on a regular basis.
 	
        Note: skTopTenFiles searches through your activity logs for files
              that have been downloaded.  You will have to consider how
              you truncate your activity logs. Eg: you might run this 
              program each week before using wcReports to produce other
              statistics and have wcReports archive your logs at that
              time.

    9 - You will need to add a link on one or more of your html pages so
        that your users can access the output file. An example is

`           <b><a href="/skTopTenFiles.htm">
                The Ten Hottest Downloads</a></b>

   10 - Once registered the program will look for and use (if found)
        the file sktoptenfiles_html_header.htm as the html header
        sent to the html output file. This allows the sysop to add a
        logo, change background colours etc. It will also check for the
        and use the file sktoptenfiles_html_header.htm as the html
        footer sent to the html output file.

        When you customise your header and footers the following macros
        are recognised and expanded:-

            @SUB1@  => the 'since date'
            @SUB2@  => the create date and time

========================================================================

          Copyright (C) skWare 1996-1997, all rights reserved

    skTopTenFiles is a trademark of skWare.
    skWare is a tradmark of skWare.

    WildCat! is a trademark of Mustang Software Inc.

    Other products and corporate names may be trademarks or registered
    trademarks of other companies, and are used for illustrative
    purposes only, and to the owners benefit, without an intent to
    infringe.

========================================================================


