skWare's HTML User Finder Online Documentation

Release 1.00f


Introduction

skUserFinder is a HTML driven user search engine for a Wildcat5 BBS. It is written in wcCode for speed and ease of integration. The user can specify a word to search for. If the user is logged into the system skUserFinder will return a html page that allows them to send email to one or more users found on the system. If the user is not logged into the system skUserFinder will return a html page that shows them the users that could be sent email if they were logged on. In the registered version the sysop can customise the headers and footer of the html pages. The help page displayed is also customisable.

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 - v1.00f

To upgrade skUserFinder you should follow these steps when upgrading from v1.00e to v1.00f.

Upgrading - v1.00e

To upgrade skUserFinder to v1.00e you should follow these steps when upgrading from v1.00d.

Upgrading - v1.00d

To upgrade skUserFinder to v1.00d you should follow these steps whether upgrading from v1.00a, v1.00b or v1.00c.

Installation

To install skUserFinder you should follow these steps.

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 of which are described in the following table.
ParameterDescription
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.
NormalHomePageLink 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. It is used when the program is started in the /code directory by a user that is already logged in.
NormalBackPageLink This is the link used by the back button so the user can return quickly to the page that called the query program. It is used when the program is started in the /code directory by a user that is already logged in.
PublicHomePageLink 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. It is used when the program is started in the /public/code directory by a user that is not logged in.
PublicBackPageLink This is the link used by the back button so the user can return quickly to the page that called the query program. It is used when the program is started in the /public/code directory by a user that is not logged in.

Header Customisation

To customise the headers displayed by the program you should modify the supplied templates (in http\skware\template\userf and http\public\skware\template\userf) to suit your needs. Header customisation only works in the registered version of the program. The templates supplied are discussed in the following table:-
Template FileUsed By
query_h.htm This template is used as the header on the query page. If the program does not find this file it will use the internal default.
result_h.htm This template is used as the header on the results page. If the program does not find this file it will use the internal default.

Footer Customisation

To customise the footers displayed by the program you should modify the supplied templates (in http\skware\template\userf and http\public\template\userf ) to suit your needs. Footer customisation only works in the registered version of the program. The templates supplied are discussed in the following table:-
Template FileUsed By
query_f.htm This template is used as the footer on the query. If the program does not find this file it will use the internal default.
result_f.htm This template is used as the footer on the results page. If the program does not find this file it will use the internal default.

Help File Customisation

You can totaly customise the help page shown to users when they select the help button in the program. To do this all you need to do is modify the html file help.htm found in the http\skware\template\userf and http\public\skware\template\userf directories. You should ensure that the form part at the bottom of the files are left intact so that users can still navigate around the program.

Registration

To Register skUserFinder 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 © 1997-1998 skWare, All Rights Reserved