SFS Software's SiteSearch version 1.33

"SiteSearch instantly makes any HTML searchable",

release date 14. November 1997

produced, written and developed by SFS Software


1. Introduction
2. How to create the search index
3. How does SiteSearch parse my files ?
4. How to exclude HTML files from the repository ?
5. How to let SiteSearch periodically update my Site ?
6. How to integrate the SiteSearch applet to my own pages ?
7. How to upload SiteSearch to a remote server ?
8. Known problems
9. How to purchase a SiteSearch license ?
10. Parameters




1. ************* 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 .



2. ************** 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.


3. ***************** How does SiteSearch parse my files ? **************************************

SiteSearch parses your code for any HREF and SRC tag (e.g. <A HREF="main.html"> ) 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.


4. ***************************  How to exclude HTML files from the repository : *************

In some cases it can be useful, to exclude some files from the indexing process.
For instance, if your WebSite is parted in several big sections, you could make several SiteSearch's for these section.
If you don't want your customers jump directly to a page, without seeing contents "before" it, you could simply exclude this file.

The process to set files as "forbidden" files for the SiteSearch creator is very easy:

1. Create a file "forbidden.txt" in your local website root directory.
2. write all names of the files in it, which should be forbidden for the SiteSearch creator.

------------ file forbidden.txt Begin -------------------

Example:

C:\website\sitesearch_download_now.html
C:\website\sitesearch_info.html
C:\website\sitesearch_info_action.html
C:\website\sitesearch_info_faq.html
C:\website\sitesearch_info_features.html
C:\website\sitesearch_info_screenshots.html 

----------- file forbidden.txt End ----------------------

3. Save the file as "forbidden.txt" in your local WebSite root directory and start the SiteSearch creator.

If you have large amounts of files that you would like to exclude, we recommend the following method:

1. Open a dosbox and change to your local website root directory

2. Insert the following command and press <ENTER>

	dir /B /S *.ht* > forbidden.txt
	(this command will write all html files in the local website root and it's subdirectories into 	the file forbidden.txt.)

3. Open the file forbidden.txt with a texteditor, like Notepad and delete all files that you would like to see in the SiteSearch repository.

Note: All files stated in the file forbidden.txt will be not indexed by the SiteSearch creator.


5. ********************   How to let SiteSearch periodically update my Site ? **********************


Simply check the "Reentrant" - checkbox and enter a reentrant time in minutes. The result will be that SiteSearch parses your site and update your site within this period.

Of course, this feature only works, if SiteSearch is active all the time.



6. ********************  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="sitesrch" width="120" height="42" archive="sitesrch.zip">
	   	   <PARAM NAME="CABBASE" VALUE="sitesrch.cab">
	   	   <PARAM NAME="autostart" VALUE="0">
	   	   <PARAM NAME="closeOnShow" VALUE="0">
	   	   <PARAM NAME="font" VALUE="Arial">
	   	   <PARAM NAME="fontSize" VALUE="12">
	   	   <PARAM NAME="targetWindow" VALUE="_blank">
</APPLET>


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

7. ************************  How to upload 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. It's important that, all files appear exactly on your remote server as created on your local drive. 


8. ************************ 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.

9. ************************* How to purchase a SiteSearch license ? *****************************

SiteSearch trial version is limited to build an search index for 50 HTML pages.
If you would like to use SiteSearch after a evaluation period of 30 days, you must purchase a SiteSearch license. After purchasing, we will send you a license key, which removes all limitations in the software and makes the product forever your.


A SiteSearch license costs:

USD 199.00 for commercial use
USD  39.00 for non-commerical use

Your money helps us extremely putting more fine features in SiteSearch and other related software products. 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 the license key 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

email: info@sfs-software.com
fax: 0049 3681 394015


10. *************** 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 when you are working with frames
	
	font: lets you specify a font. Default=Helvetica
	fontSize: lets you specify the fontSize. Default=12
	autoLoadIndex: loads the index file automatically in the background
	autoLoadKeywords: loads the keyword file automatically in the background


Example:

<APPLET code="com.sfs.sitesearch.SiteSearch" codebase="sitesrch" width="120" height="42" archive="sitesearch.zip">
	   	   <PARAM NAME="CABBASE" VALUE="sitesrch.cab">
	   	   <PARAM NAME="autostart" VALUE="0">
	   	   <PARAM NAME="closeOnShow" VALUE="0">
	   	   <PARAM NAME="font" VALUE="Arial">
	   	   <PARAM NAME="fontSize" VALUE="12">
	   	   <PARAM NAME="targetWindow" VALUE="_blank">
		   <PARAM NAME="autoLoadIndex" VALUE="0">
		   <PARAM NAME="autoLoadKeywords" VALUE="0">
 		
	   </APPLET>



************** 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.

SiteSearch was tested successfully on these operating systems:

Microsoft Windows 95 and Windows NT
Sun Solaris 2.5
Linux (Kernel version 2.0)
Hewlett Packard HP-UX


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

The trial version of SiteSearch can handle up to 50 html-files. The licensed version is unlimited and was tested successfully, using CNET's NEWS.com (9000 html files - 35.000 keywords.)






Copyright  1997 SFS Software
Martin-Luther-Ring 31 , 98574 Schmalkalden / Germany
http://www.sfs-software.com 	info@sfs-software.com
phone: 0049 172 4714485 fax: 0049 3681 394015
All rights reserved.