FindinSite-CD: Search engine for CD/DVD   .
 
Powered by FindinSite-MS
. Home | Examples | Starting | Set up | Advanced | Languages | Purchasing | Email .
. .
  Screen layout | Applet parameters | Indexes & Subsets | Search page HTML

 

findinsite-cd applet parameters


Introduction

This page lists the standard FindinSite-CD applet parameters. See the instructions for search page HTML for full details of how to change or add parameters.

The standard search page generated by FindinSite-CD-Wizard already sets several applet parameters. If a parameter is already set, then you should change the parameter value, rather than adding a whole new parameter definition.

Here is an example of the plain text you need to add to an HTML file to change the target window, some colours and the font:

<PARAM NAME=target VALUE="_blank">
<PARAM NAME=bgcolor VALUE="white">
<PARAM NAME=fgcolor VALUE="blue">
<PARAM NAME=fieldbgcolor VALUE="#ffffef">
<PARAM NAME=font VALUE="TimesRoman 15pt">

Highlight parameters

If you use fisLight to do word highlighting (in a popup window or as a part of frameset) then various highlighting parameters need to be set for fisLight as well. For the standard popup window, also add the parameters to the popup window page fiscdpop.htm. Do this for these parameters: HighlightStart, HighlightStop, HighlightNavBack, HighlightNavNext and HighlightAnchorName.

"Pro Sub" parameters

There are also parameters that are only available to Professional Subscription licence holders:
  • Change the FindinSite-CD icon
  • Add a line of text to the help information (with an accompanying URL)
  • Remove the help text at startup
  • Set the entire help text


Parameter List

Parameter Type Description Default
AddSearchToASPResults String If this parameter is present (with any value), FindinSite-CD adds the search query as a parameter named fisCDSearch when displaying all .asp pages. A parameter named httpReferer set to fisCD is also added.  
AddSearchWordsToASPResults String If this parameter is present (with any value), FindinSite-CD adds the parsed search query as a parameter named fisCDSearchWords when displaying all .asp pages. A parameter named httpReferer set to fisCD is also added.  
bgcolor
bgcolour

More info

RGB triplet
or colour name
The background colour #FFFFCC
ie light yellow
buttonbgcolor

More info

RGB triplet
or colour name
The background colour of the buttons #DCD9C8
ie light gray
buttonfgcolor

More info

RGB triplet
or colour name
The foreground text colour of the buttons same as fgcolor
defaultLocale String If the browser cannot determine the user's locale (eg Navigator 3 or Internet Explorer 3) then this parameter specifies the default locale. If not present, then English is used as the default language.  
DontUseAnchors String If this parameter is present (with any value), FindinSite-CD does not use anchors names (eg #anchor) when displaying a page. This solves a problem experienced when using Netscape Communicator to access a networked drive.  
fgcolor
fgcolour

More info

RGB triplet
or colour name
The foreground colour black
fieldbgcolor

More info

RGB triplet
or colour name
The background colour of the field boxes white
fieldfgcolor

More info

RGB triplet
or colour name
The foreground text colour of the field boxes same as fgcolor
Font

More info

Font definition The font used in the results Dialog 12pt
FullScroll String Set to yes to force FindinSite-CD to scroll the whole applet window when scrolling, rather than the normal intelligent scrolling. Use this to fix a bug in Internet Explorer when part of the applet window is not visible in the browser window. no
getFocus String Set to false to stop FindinSite-CD requesting the input focus at startup. true
help String The URL that is displayed if the Help button is pressed.
If set to off then no Help button is displayed
 
Highlight

More info

String Specify one or more of the following, separated by spaces:
on Word highlighting in Windows IE4+ and similar
off Turns off word highlighting
nojump Turn off jumping to first instance of word.
nonav Turn off navigation arrows.
frameset[,frameno] Enables word highlighting in a frameset.
Specify a frameno if fisLight is not in frame number 0. See example
nopopup Turns off highlighting using a popup window
on
Word highlighting in Windows IE4+ and similar
HighlightAnchorName

More info

String The HTML anchor base name. A number is added to this base name.

Also set for fisLight in fiscdpop.htm.

fisanchor
HighlightNavBack

More info

String The HTML for word highlighting back arrow.
This is only used in Windows Internet Explorer version 4 or later

Also set for fisLight in fiscdpop.htm.

<B>&lt;</B>
ie <
HighlightNavNext

More info

String The HTML for word highlighting next arrow
This is only used in Windows Internet Explorer version 4 or later

Also set for fisLight in fiscdpop.htm.

<B>&gt;</B>
ie >
HighlightStart

More info

String The HTML to start highlighting a word

Also set for fisLight in fiscdpop.htm.

<SPAN STYLE='background: yellow;'>
<FONT COLOR=red><B>
ie default highlighting
HighlightStop

More info

String The HTML to stop highlighting a word

Also set for fisLight in fiscdpop.htm.

</B></FONT></SPAN>
IEhiliteLoadMethod

More info

String The JavaScript function to call after highlighting in Internet Explorer  
IndexDbBase String If set to "CodeBase" then various files are loaded from the applet CodeBase, rather than the default DocumentBase. Alternatively, set this to a complete base URL. These are the affected files:
  • Search database files
  • rules files
  • Language files
 
indexN

More info

String See the search page HTML for simple use of index parameters, and the Indexes and Subsets page for full details..  
Languages

More info

String A comma-separated list of language file URLs etc. for the languages that you want to add.  
Lang_XXX

More info

String Add one or more Lang_XXX parameters to change individual strings in a language.  
layout

More info.

string If set to vertical then the FindinSite-CD buttons are arranged underneath the search text box.  
linkcolor

More info

RGB triplet
or colour name
The colour of hypertext links blue
LoadAllDbs

More info

yes, no or auto If yes, then full index loading means that all search database files are loaded at startup. If no then only some of the search database files are loaded. If auto then FindinSite-CD turns on full index loading if it is running online or on an intranet; for normal CD use, it is turned off. auto
LoadingFont Font definition The font used to display the initial "Please Wait..." message (L_LOADING) Dialog 50pt
LoadingColor RGB triplet
or colour name
The colour used to display the initial "Please Wait..." message (L_LOADING) red
maxResults integer The maximum number of results to display. If 0, then all results displayed. 0
PopupWindow

More info

string The name of the file used to do popup window word highlighting fiscdpop.htm
PopupUsingURL

More info

String If present with any value, then popup window word highlighting is done by passing information in the URL.  
ReorderResults

More info

String Specify one the following:
filename Sort results on the page filename
title Sort results on the page title
abstract Sort results on the page abstract
priority
(or revision)
Sort results on the page Priority
wordcount Sort results on the count of search words in each page (slow)

Optionally then specify one of the following after a space:
ascending Sort ascending [default]
descending Sort descending
off
ResultsLayout

More info

string This string specifies how each result is displayed in the FindinSite-CD window. Use ordinary text and various tags, as described in the screen layout section.

If FindinSite-CD is producing HTML Results then this parameter determines the HTML returned for each hit.

<B><TITLE_LINK></B><FILENAME> <BLOCKQUOTE><ABSTRACT>
ResultsLines

More info

integer[,integer] The number of lines for each results hit, and optionally the number of empty lines between each result.
The maximum permitted values are 10,5.
3,0
rules

More info

string A comma-separated list of rules files to do word stemming and synonyms. The supplied English rules file is called rulesen.txt. none
ie no rules used
sagrSearchTimeout

More info

integer "HTML Results" timeout in seconds (must be greater than zero) 15
selboxColor

More info

RGB triplet
or colour name
The colour of the keyboard link selection box lightGray
setFieldsFn

More info

String The name of the JavaScript function that FindinSite-CD should call to set the user's current field selections. none
ShowFullSearchTextInResults

More info

String If this parameter is present (with any value), the full search text is shown in italics at the top of the results after the count of pages found.  
ShowLanguages

More info

yes or no Whether to show the "Languages" button if more than one language is available yes
ShowSearchTextInResults

More info

String If this parameter is present (with any value), the search text is shown in italics at the top of the results after the count of pages found (ShowSearchTextInResults takes precedence).  
ShowSubsets

More info

yes, no or startup Whether to show the "Subsets" button if an index has subsets. If set to "startup" then this Subsets tab is shown at startup. yes
SystemFilesOffset String Used to help FindinSite-CD access various system files such as language files.

Use this parameter if the HTML that calls FindinSite-CD is in a different directory to the fiscd.zip and fiscd.cab runtime files. Set this parameter to the relative path to get from your HTML to the runtime.

This is needed for some versions of Java that only let FindinSite-CD access files in the runtime directory (rather than both the runtime and the HTML directory).

none
target String The name of the frame target that is used if a page does not have a target in the database.

The following target frame names have special meaning:

_self current frame
_parent parent frame
_top top-most frame
_blank new unnamed top-level window
_self
UseLanguages

More info

String A comma-separated list of language locale specifiers that you want to be available. By default all languages are available
  All site Copyright © 1996-2011 PHD Computer Consultants Ltd, PHDCC   Privacy  

Last modified: 22 March 2010.

Valid HTML 4.01 Transitional Valid CSS!