             -= skWare's HTML Whos Online Online Documentation =-



skWare's HTML Whos Online Online Documentation


Release 1.00g

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


Introduction

   skWare's skWhosOnline is a program that produces an HTML page on the fly
   for callers using a browser. This page will show the current people online
   and allow them to send any caller currently online caller email if they
   want. The template used by the program can be fully customisable by the
   sysop. 
   
   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.00g

   To upgrade to v1.00g you should first install the program as decribed in
   the installation section. You should then:- 
       * The configuration file has changed from skwhosonline.cfg to
         skware.cfg. You will need to edit the configuration file skware.cfg
         as per the section on the configuration file transfering you
         registration code across. Also please note that that v1.00g has two
         new parameters namely ShowOpenDialUp and ShowOpenTelNet. Please check
         the section on configuration to see what these are used for. 
       * If you have made changes to the old header/footer templates you
         will need to apply these changes to the new template file called
         http\skware\template\whosol\main.htm as we now only have one
         template. 
       * Once you are happy with the new version you can delete the
         following files as they are no longer used:- 
             * data\skwhosonline.cfg 
             * http\skware_templates\skwhosonline_html_footer.htm 
             * http\skware_templates\skwhosonline_html_header.htm 
         
   




Installation

   To install skWhosOnline you should follow these steps.
   
      
          * Unzip the package skwo100g.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-skwhosonline.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\whosol   d:\wc5\http\skware\ol_docs\whos 
               http\skware\template\whosol  d:\wc5\http\skware\template\who 
               
            
          * 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-skwhosonline.wcx"<b>Skware's HTML Whos
               Online</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 [skwhosonline] 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.                      
      ShowOpenDialUp   If this parameter is set to 'YES' the program will   
                       display free nodes that are open for dialup          
                       connection. If this parameter is set to 'NO' then    
                       free nodes open for dialup will not be displayed.    
      ShowOpenTelNet   If this parameter is set to 'YES' the program will   
                       display free nodes that are open for telnet          
                       connection. If this parameter is set to 'NO' then    
                       free nodes open for telnet will not be displayed.    
      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\whosol and can be edited by any
   text editor to suit your needs. 




Registration

   To Register skWhosOnline 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
                                       

