SFS Software's SiteSearch version 1.1

"SiteSearch makes any HTML searchable",

release date 22. September 1997

produced, written and developed by SFS Software


************* I N T R O D U C T I O N ***************

SiteSearch produces an search index for your WebSite or HTML-documentation. SiteSearch is 100% pure Java 
and makes instantly any HTML searchable. It prepares an index which lets you search through all titles of a WebSite and a keywords index itself. All you have to do is to give SiteSearch a start file, normally this is the index.html or welcome.html .


************* HOW IT WORKS **************************

SFS Software's SiteSearch - instantly makes any HTML searchable.

SiteSearch is a pure Java search engine for websites and HTML documentations.
it consists of an applet which sits on your site and this application, which
parses your site and creates a repository for indexes and keywords.

How to create the search index ?

At first you need to start SiteSearch's creator component. This is very easy:
In Windows you could use our run.bat, which starts the creator. In any other operating system, you need
the Java Development Kit 1.02 at first. Install it and then start SiteSearch's creator with the following command:


	jdk102\bin\java -classpath .;jdk102\lib\classes.zip com.sfs.sitesearch.installer_102.SiteSearch

	We assume the following:

	Example:

	If you installed JDK 1.02 in c:\Java\JDK102 the command to start SiteSearch must be:

	c:\java\jdk102\bin\java .;c:\java\jdk102\lib\classes.zip com.sfs.sitesearch.installer_102.SiteSearch


	If you have problems with this, please mail us to info@sfs-software.com, we will help you.
	
The process to create the repository is very easy. SiteSearch needs at first the
location of your website or HTML documentation. Please insert something like:

c:\website (Windows) or /usr/share/website (Unix)

The next thing SiteSearch needs is the name of your startpage. This file is normally,
a index.html or welcome.html etc. Insert the name in SiteSearch's second Textfield.

At least you must insert the license key to remove the SiteSearch 50 pages limitation.
If this textfield is blank, SiteSearch will stop parsing after 50 HTML files and builds
the repository for it.

How does SiteSearch parse my files ?

SiteSearch parses your code for any HREF and SRC tag and jumps so through all referenced
files. After this process it will create an sitesearch directory in your website's directory,
where the applet and the repository files are located. Your website root directory will contain
the file sitesearch.html, which shows you the SiteSearch applet. This applet displays all indexes
keywords of your site.

How to integrate the SiteSearch applet to my own pages ?

You can easily integrate SiteSearch in your own pages. Simply copy the following tag in your HTML file(s):

<APPLET code="com.sfs.sitesearch.SiteSearch" codebase="sitesearch" width="120" height="55">

</APPLET>

Please consider, that visitors of your site or readers of your HTML docs, need a Java enabled browser to use SiteSearch

Uploading SiteSearch to a remote server

If your website is connected to a remote server, simply copy the complete SiteSearch directory, located in your website directory
to your remote server. Please make sure that you use a ftp-client which can create all subdirectories. It's important that, that
all of SiteSearchs directories appear exactly on your remote server as created on your local site.
Remember, that Java is case sensitive and it could result in problems, if your ftp-client renames file from com to Com etc.
We recommend ftp-clients called Cupertino or Cute-FTP for this work.

Known problems:

1. We made a lot of improvements to SiteSearchs parser. But it can happen that there are mistakes in your HTML code, which
SiteSearch cannot ignore. In this case, SiteSearch will leave you the name of the HTML file, and the location where the
error happened. Please go to this place and fix the problem. Then restart SiteSearch and the creating process.

How to purchase a SiteSearch license ?

You could purchase a SiteSearch license via various ways. Our preferred method is to purchase the product online
at our website http://www.sfs-software.com . You will receive a license within the same day. Other methods are described in
the products orderform. You could fill/print it out and send/email/fax it to us.

SFS SOFTWARE 
Martin-Luther-Ring 31
98574 SCHMALKALDEN / GERMANY


*************** PARAMETERS *************************

You can set the following parameters within the applet tag, to configure SiteSearch for your own needs:

Syntax: <param name="the parameter" value"the value">
Example: <param name="autostart" value="1">

Parameters available:

	autostart: enables SiteSearch's autostart. Default value=0 (disabled) - enabled =1
	closeOnShow: closes SiteSearch after each Search. Default = 0 (disabled) - enabled =1
	targetWindows: says SiteSearch in which window it should open the contents. Default= _blank 
			this parameter is interesting in working with frames
	Parameter available to licensed users - URL for the banner. Default = 		http://www.sfs-software.com


<APPLET code="com.sfs.sitesearch.SiteSearch" codebase="sitesearch" width="120" height="55">





</APPLET>






************** I N S T A L L A T I O N **************

Please start the file setup.exe to install SiteSearch. After installation you could start SiteSearch using SiteSearch.exe



************** U P G R A D E S - N E W S ************

For updates, sources and newest informations about SiteSearch and other exciting titles, please visit our WebSite at http://www.sfs-software.com .

Versions for other operating systems, especially Linux, Solaris, OS2, MacOS are available too.

************** Limitations **************************

The free version of SiteSearch can handle up to 50 html-files only. The licensed version is unlimited and was tested successfully, using CNET's NEWS.com (9000 html files - 35.000 keywords.) You can purchase a SiteSearch license online from our WebSite or via various other ways.   

Known bugs are reported in the file known-bugs.txt



Copyright  1997 SFS Software
Martin-Luther-Ring 31 , 98574 Schmalkalden / Germany
http://www.sfs-software.com
All rights reserved.