findinsite-js look and feel

Here is a full list of the available options:

Initial search page

• You can use the findinsite-js welcome page to show to your users if you want.  The URL for this page varies from case to case, but might be http://localhost/findinsitejs/ which usually actually shows the file index.html in the findinsitejs directory.

  If you use the welcome page, you will almost certainly want to alter its HTML.  Note that this is a static HTML page.

• Most people will probably want to display the findinsite-js generated search page, because this is localised for each user.  The look and feel of this search page can be changed using configurable template files as described below.

  Again, the URL for the findinsite-js search page will vary, but might be http://localhost/findinsitejs/search.  This search page is dynamically generated by findinsite-js.

• Alternatively, add a search form to an existing page to call findinsite-js.

Template files

findinsite-js gets the name of each file from the values set in the configuration screen Look and Feel section.  However, if any file is not available then findinsite-js supplies a basic default value.

Each template file can contain any HTML.  However, each file is a template, so any instance of a findinsite-js variable is replaced with a suitable value at runtime.  The heading and footer template files may contain Heading and Footer Variables.  The top and bottom template files may contain Top and Bottom Variables.  The results line template file should contain Result Line Variables.

Each template file may use %INCLUDE=...% directives to include other pages in the output, as described below. The included pages may be static files or dynamically generated. An included JSP page may refer to various findinsite-js session variables.

Heading and Footer Variables

As well as ordinary HTML (of any sort), findinsite-js replaces any instances of the following variable names with the described text.  If the description says that the text is localised then the text is taken from the language file for the user's preferred language.  See the findhead.htt and findfoot.htt files in the findinsite-js Web Application directory for examples of these variables in use.

Top and Bottom Results Variables

As well as ordinary HTML (of any sort), findinsite-js replaces any instances of the following variable names with the described text.  If the description says that the text is localised then the text is taken from the language file for the user's preferred language.  See the findtop.htt and findbot.htt files in the findinsite-js Web Application directory for examples of these variables in use.

The default text for both the top and bottom template is: %L_SEARCH_RESULTS_FOR% <SPAN STYLE='background: pink;'><CODE>%SEARCH_TEXT%%FIELDS_TEXT%</CODE></SPAN> %L_STOP_WORDS%
&nbsp;&nbsp;%L_HITS_TEXT%&nbsp;&nbsp;
%L_PREV_SHEET% %SHEET_NO% %L_NEXT_SHEET%&nbsp; %SHEET_FIRST_DOTS% %SHEET_DECADE% %SHEET_LAST_DOTS%
<BR>

Result Line Variables

findinsite-js precedes the results list with a <UL> tag and follows it with a </UL> tag, so you can use <LI> in your line file template HTML.

The line file can contain any HTML.  However, it will mainly contain result variables, described in this list:

Example line template

<DL><DT><B>%RESULTNO%. %TITLE_LINK%</B> %FILENAME%<DD>%ABSTRACT%</DL><BR>

Here is an example of what this result will look like, in the middle of a results list:

3. findinsite-js Configuration Screen config.htm How to use the online configuration screen of findinsite-js 4. findinsite-cd rules for Word stemming and Synonyms rules.htm findinsite-cd rules for Word stemming and Synonyms

Template Include Directives

Any of the template files may use a directive %INCLUDE=...% to include another file or page in the findinsite-js output. The page name must start with /, and must not be in quotes. The actual page must be in the findinsite-js application context directory (or one of its sub-directories).

The following examples assume a directory and file structure similar to the following, where header.htt and the jsp directory have been added to the standard findinsite-js runtime.

Use the following in a findinsite-js template file (eg findhead.htt) to include the contents of file header.htt in the findinsite-js output.

%INCLUDE=/header.htt%

A template file can refer to a JSP file if you want, eg:

%INCLUDE=/jsp/top.jsp%

JSP Template include session variables

Use the JSP session.getAttribute() function to access the various findinsite-js variable objects. This example shows a JSP page that simply outputs three of the findinsite-js session variables:

SearchText <%=session.getAttribute("SearchText")%>
SheetNo <%=session.getAttribute("SheetNo")%>
ResultsPerSheet <%=session.getAttribute("ResultsPerSheet")%>

The following session variables are available, and valid as indicated. The type of each variable objects is also given. All the objects used have implicit toString() methods that allow them to be printed out simply as shown above. The "SearchText", "Title" and "Abstract" strings are made HTML-safe for printing out in a browser.