Applet Parameters

AppletBackgroundColour

This sets the background colour for the Applet.

The value of this parameter is red/green/blue hexadecimal. There is a colour chart for reference at the end of the readme contents list

Background

This sets the background colour for the search report.

The value of this parameter is red/green/blue hexadecimal. There is a colour chart for reference at the end of the readme contents list

CacheSize

The cache is a temporary store of web page files. This allows repeat searches to use previously downloaded file content to be stored on the local computer thus saving time on subsequent searches. The value of this is in number of files to be cached. Minimum is 0.

The value of this parameter is a integer number.

FontFace

The font face of characters used for the Applet and Search report. This allows the same font to be used as for the rest of the web site.

FontSize

The font size of characters used for the Applet and Search report. This allows the same font size to be used as for the rest of the web site.

Foreground

This is the colour of the font used in the Applet and Search Report. This allows the same font colour to be used as for the rest of the web site. Its value is red/green/blue hexadecimal. There is a colour chart for reference at the end of the readme contents list

HelpText

This allows the web master to set the help text with words in the preferred language. The value is free text. The user is presented with this text whenever the "?" button, near the keyword text entry is clicked on the Applet.

In English, the text should read "Enter the keywords to search for separated by a space. <br><br>Select the 'or' button to find any keyword or select the 'and' button to find all keywords." Note: HTML tags can be used as the text is presented in a pop up browser window. This adds flexibility in the event that alternate formatting is required.

KeywordBackgroundColour

This sets the background colour for the keyword text entry.

The value of this parameter is red/green/blue hexadecimal. There is a colour chart for reference at the end of the readme contents list

PagesToSearch

This sets the initial set of web pages to search. All specified pages must be on the host site and are specified relative to the HTML BASE element defined in the web page that called the Applet. I.e. the following have valid values;

"./mysite/index.htm"

"index.htm"

"index.html"

"../cages/birds"

The Applet will only search files on the same host as the Applet. It will not call other sites or search engines.

The specified files will be searched for the keywords entered by the user. No other file will be searched unless the "Spider" parameter is set to value "true". Each file must be separated by a semicolon ";" and have no gaps between file names.

PhraseForAnd

This parameter is the text character(s) placed next to the "AND" button on the Applet. When selected, the search will look for all keywords in each file scanned. i.e. It will search for keyword1 AND keyword2 AND keyword3….. etc..

The value of this parameter is free text.

PhraseForClose

This parameter is used to provide text on a button at the bottom of pop up windows. When clicked, the button closes the window.

The value of this parameter is free text.

PhraseForHelp

This parameter is used to provide text on the help button. This is the button on the Applet when clicked, informs the user how to enter the keyword, set the "AND/OR" search type and initiate the search.

The value of this parameter is free text, although a simple "?" may suffice.

PhraseForInformationAboutTheSearchEngine

This parameter is used to provide a text description on the Browser's status bar (if one exists) informing the user that selecting the "?" button on the search report will provide additional information about Client Search search engine.

The value of this parameter is free text.

PhraseForNoDescription

When the search has completed and the search report is presented to the user, it provides the description text as one of the summarising details of the file along with its title, hyperlink and rank (based on the number of times the keyword was found). If the file scanned had no description, this parameter's value is used instead.

The description is meta data within the HTML document. The following example shows how meta data is defined within the HEAD tags of the HTML document:

<meta name="description" content="This is the text I want to appear in the search report.">

The value of this parameter is free text.

PhraseForNoHitsFound

This parameter is used to present a message to the user that the search revealed no hits at all.

The value of this parameter is free text.

PhraseForNoTitle

When the search has completed and the search report is presented to the user, it provides the title text as one of the summarising details of the file along with its description, hyperlink and rank (based on the number of times the keyword was found). If the file scanned had no title, this parameter's value is used instead.

The title is defined in the HEAD tag of the HTML document. The following provides an example of title definition;

<title>My Big Website</title>

If the file scanned had no title, this parameter's value is used instead.

PhraseForOr

This parameter is the text character(s) placed next to the "OR" button on the Applet. When selected, the search will look for any of the keywords in each file scanned. i.e. It will search for keyword1 OR keyword2 OR keyword3….. etc..

The value of this parameter is free text.

PhraseForSearch

This parameter sets the text on the Applet button which when clicked initiates the search.

The value of this parameter is free text.

PhraseForSearchReport

This parameter sets the text on the search report to inform the user that the displayed information is the result of the search. It appears at the top of the search report.

The value of this parameter is free text.

PhraseForStopSearch

This parameter sets the text on the Applet button displayed on the place of the "Search" button during the search which when clicked stops the search on the next file fetch.

The value of this parameter is free text.

ReportBackgroundColour

This parameter sets the background colour of the search report.

The value of this parameter is red/green/blue hexadecimal. There is a colour chart for reference at the end of the readme contents list

ReportBackgroundImage

This optional parameter allows the specification of an image file (e.g. jpg) to be displayed on the search report as a background.

All specified impage must be on the host site and is specified relative to the HTML BASE element defined in the web page that called the Applet. I.e. the following have valid values;

"./mysite/myimage.jpg"

" myimage.jpg "

"../cages/birds.jpg"

SearchReportFrame

This parameter sets the name of the HTML frame where the search report should be directed. If the frame name doesn't exist, the report will be placed in a window of the same name.

Frames are named in HTML using the "frame" tag. The following is an example;

<frame src="" name="Rpt">

Here src specifies the source as "", meaning null. This allows the frame to be created with no content. Once created, the Client Search Applet will populate the frame instead of the Browser retrieving its content from another HTML source. The name "Rpt" is used here to give the frame a name. The name is used by the Client Search Applet to direct its search report frame. You can use any name and so long as the name of the frame is the same as this Client Search parameter.

The value of this parameter is free text.

Spider

This parameter is used to instruct the Client Search Applet to spider to the site. When set to "true" the Applet will scan the initial files for the specified keywords and also extract out hyperlinks to pages on same site to follow. When the hyperlinks are followed, the files are again scanned and further hyperlinks on the same site are followed and so on until all files are scanned.

This provides a powerful facility to check entire web sites by specifying only one initial file.

Tip: The spider works by traversing the HTML links (i.e. href and src tags). If your site uses some other mechanism such as JavaScript to link pages, the spider will not be able to traverse your site. To enable the spidering to work, create a file with a link to each of your web pages. This file could then be specified in the "PagesToSearch" parameter as the initial file. Client Search will then be able to find each of your web site's files.

The value of this parameter is either "true" or "false".

WebMasterEMail

This parameter is used in the Warning report to encourage users who do invoke a error condition to report it to the web master by providing a mailto link.

The value of this parameter is an Internet e-mail address.