           -= skWare's HTML Next Card Game Online Documentation =-



skWare's HTML User Stats Online Documentation


Release 1.00b

-----------------------------------------------------------------------------


Introduction

   skWare's skUserStats is a program that produces an HTML page on the fly for
   callers using a browser. This page will show the caller their statistics
   such as:- 
       * Total Messages Written 
       * Total Number of Calls 
       * User Since Date 
       * Last Call Date 
       * Last New Files Date 
       * Downloads in files and kbytes 
       * Uploads in files and kbytes 
       * Date User Account Expires On 
       * Account Balance 
       * Netmail Balance 
       * Security Level 
   
   
   Usage of this software is covered by skWare's Software License which you
   should read at some stage and you should also check out skWare's Software
   Warranty. You may also want to check out the Trademarks page at some stage.
   
   
   You should definately read the Software History page. 
   
   You can also check out skWare Online for the latest information on this
   program and also the others written by skWare. 
   
   In this documentation we have assumed that Wildcat! has been installed on
   drive d: in the directory wc5 resulting in the fact that the default
   wildcat directory is d:\wc5, as this is how our development system is set
   up. Your system may not be set up like this. 




Upgrading to v1.00b

   To upgrade from v1.00a to v1.00b you should first install the program as
   decribed in the installation section. You should then:- 
       * Edit the configuration file skware.cfg as per the section on the
         configuration file. Please note that that v1.00b has a new
         registration scheme and the registration code will have changed. We
         have emailed new registartion codes to all registered users. If you
         have not received your new code please contact us and we will send
         you your new code. 
       * If you have made changes to the old header template you will need
         to apply these changes to the new template file called
         http\skware\template\ustat\main.htm as we now only have one template.
         
       * Once you are happy with the new version you can delete the old
         header template http\skuserstats_html_header.htm as it is no longer
         used. 
   




Installation

   To install skUserStats you should follow these steps.
   
      
          * Unzip the package skus100b.zip into a temporary directory with
            a 32 bit unzip program such as unzip as shipped with WildCat.
            
          * Move the following files to your default WildCat directory (eg:
            d:\wc5). 
               
             * html-skuserstats.wcx 
            
          * The rest of the files supplied in the package are in relative
            directories and should be moved as follows:- 
               
               Source Directory            Example Destination Directory   
               data                        d:\wc5\data                     
               http\skware\ol_docs\ustat   d:\wc5\http\skware\ol_docs\ustat 
               http\skware\template\ustat  d:\wc5\http\skware\template\usta 
               
            
          * Next you should edit the configuration file skware.cfg as
            explained in the section on the configuration file. 
            
          * Add one or more links to the game on the pages that you want.
            An example of the link required is as follows:-
            
               <a href="/code/html-skuserstats.wcx"<b>Skware's HTML User
               Stats</b></a> 
            
            
      
   




Configuration File

   The operation of the program is controlled by the configuration file. This
   configuration file is called skware.cfg and must be in your WildCat data
   directory (d:\wc5\data). This file is in the process of being setup so that
   it is shared by all of skWare's programs as the single source of
   configuration information. An example file has been shipped with the
   package called skware.cfg.dist which can be used as an example. 
   It is an 'ini' type file the contents for the [skuserstats] section are
   described in the following table. 
      
      Parameter      Description                                           
      RegCode        Once registered this parameter should contain your    
                     registration code as supplied by skWare. In the       
                     shareware version this should contain the word        
                     "SHAREWARE" without the quotes.                       
      HomePageLink   This is the link to your home page. It is used by the 
                     Home button so that the user can return quickly to    
                     you home page.                                        
      BackPageLink   This is the link used by the back button so the user  
                     can return quickly to the page that called the query  
                     program.                                              
      
   




HTML Template Customisation

   The template used by the program is totally customisable. The template
   supplied is in the http\skware\template\ustat and can be edited by any text
   editor to suit your needs. 




Registration

   To Register skUserStats print the file register.txt fill it in, and send it
   and the required amount to the following address:-
   
      skWare
      PO Box 9559
      Wellington
      NEW ZEALAND
      
   If you want to pay by Credit Card (either Mastercard or Visa) to can either
   print the file ccreg.txt fill it in and send to the address above or fill
   in the form and email it to skWare. 
   
   You can also register online at skWare Online - Online Registration. 


-----------------------------------------------------------------------------

                Copyright (c) 1998 skWare, All Rights Reserved
                                       

