skFileFinder is a HTML driven file finder search engine for a Wildcat5 BBS. It is written in wcCode for speed and ease of integration. The user can specify up to 5 words to search for and use and/or to join the words that they are looking for.
If the user is logged into the system skFileFinder will return a html page that allows them to download one or more of the files found.
If the user is not logged into the system skFileFinder will return a html page that shows them the files that could be downloaded 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.
To upgrade skFileFinder you should follow these steps when upgrading from v1.00e to v1.00f.
- Unzip the package skff100f.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-skfilefinder.wcx
- You should then modify your copies of the html template files to refelect the change in version or copy the supplied template files into the appropriate directories.
To upgrade skFileFinder you should follow these steps when upgrading from v1.00d to v1.00e.
- Unzip the package skff100e.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-skfilefinder.wcx
- Once you have done this you will need to customise the new html headers and footers if your version is registered. The following table lists the old filenames and the new filenames.
Old File New File http\skfilefinder_html_help.htm This file has been replaced by http\skware\template\filef\help.htm http\skfilefinder_html_query_header.htm This file has been replaced by http\skware\template\filef\query_h.htm http\skfilefinder_html_query_footer.htm This file has been replaced by http\skware\template\filef\query_f.htm http\skfilefinder_html_results_header.htm This file has been replaced by http\skware\template\filef\result_h.htm http\skfilefinder_html_results_footer.htm This file has been replaced by http\skware\template\filef\result_f.htm - Next you should edit the configuration file skware.cfg as explained in the section on the configuration file.
- Finally you can delete the following files as they are no longer used. They have all been specified releative to your default wildcat directory. (d:\wc5)
- data\skfilefinder.cfg
- http\skware_templates\skfilefinder_html_help.htm
- http\skware_templates\skfilefinder_html_query_footer.htm
- http\skware_templates\skfilefinder_html_query_header.htm
- http\skware_templates\skfilefinder_html_results_footer.htm
- http\skware_templates\skfilefinder_html_results_header.htm
To upgrade skFileFinder you should follow these steps when upgrading from v1.00c to v1.00d.
- Unzip the package skff100d.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-skfilefinder.wcx
- As all of the header and footer templates have been modified to reflect the version change you can either copy them to the skware_templates directory or elect no to.
To upgrade skFileFinder you should follow these steps whether upgrading from v1.00a or v1.00b.
- Unzip the package skff100c.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-skfilefinder.wcx
- Update the configuration file as follows:-
- Add the BackPageLink entry.
- Remove the WWWHostName entry.
To install skFileFinder you should follow these steps.
- Unzip the package skff100f.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-skfilefinder.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\filef d:\wc5\http\skware\ol_docs\filef http\skware\template\filef d:\wc5\http\skware\template\filef http\public\skware\template\filef d:\wc5\http\public\skware\template\filef - 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 program on the pages that you want. An example of the link required is as follows:-
<a href="/code/html-skfilefinder.wcx?BtnClear=Clear"<b>Skware's HTML File Finder</b></a>- If you want to enable people to use the file finder program when they are not logged onto your system (ie from the internet) you should add one or more links to pages in your http\public directory. The link should be as follows:-
<a href="/code/html-skfilefinder.wcx?BtnClear=Clear"<b>Skware's HTML File Finder</b></a>
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.
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. 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.
To customise the headers displayed by the program you should modify the supplied templates (in http\skware\template\filef and http\public\skware\template\filef) 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 File Used 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.
To customise the footers displayed by the program you should modify the supplied templates (in http\skware\template\filef and http\public\template\filef ) 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 File Used 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.
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\filef and http\public\skware\template\filef 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.
To Register skFileFinder print the file register.txt fill it in, and send it and the required amount to the following address:-
skWareIf 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.
PO Box 9559
Wellington
NEW ZEALAND
You can also register online at skWare Online - Online Registration.