Customizing Search Results
© 1995-1999 StarNine Technologies, Inc. and its Licensors.

This document describes the included example files, the search template format and the variables that can be used to customize the search results.


Description of Example Files

search.html
An example search form which returns the Plug-Ins built-in result format.

search_using_template.html
An example search form which uses the "search_template" file for defining search result format.

search.ssi and results.ssi
An example SSI processed search form which returns the Plug-Ins built-in result format in an SSI processed page.

search_using_template.ssi and results_using_template.ssi
An example SSI processed search form which uses the "search_template" file for defining of search result format and which returns the results in an SSI processed page.

search_template
Template for defining of search result format. 


Search Template Format

The template is devided into the following six sections: 

<RESULTS_PREVIOUS>
- Used for defining of text to use in "Previous Results" link.

<RESULTS_NEXT>
- Used for defining of test to use in "Next Results" link.

<RESULTS_HEAD>
- Used for defining header and form results to return.  Supports the following variables (described below): ###SEARCH_INDEX, ###NUMBER_DOCS, ###MINIMUM_SCORE, ###RESULTS_HIT

 <RESULTS_HIT>
- Used for defining the format of the actual query results.  Supports the following variables (described below): ###RELEVANCE, ###URL, ###TITLE, ###SUMMARY, ###MATCHING_TERMS, ###MORE_LIKE_THIS

<RESULTS_FOOT>
- Used for defining footer to return at bottom of results.  Supports the following variables (described below): ###RESULTS_PREVIOUS, ###RESULTS_CURRENT, ###RESULTS_NEXT, ###PREVIOUS_SEARCH_QUERY

<RESULTS_FAILURE>
- Used for defining the page to return when no matching items were found.  Supports the following variables (described below): ###SEARCH_INDEX, ###NUMBER_DOCS, ###MINIMUM_SCORE, ###PREVIOUS_SEARCH_QUERY


Definition of Variables

###SEARCH_INDEX
- Defines the path name to the index file to be used in the search, as for use in the Form Action.

###NUMBER_DOCS
- Defines the maximum number of matching documents to return.

###MINIMUM_SCORE
- Defines the minimum match score for documents that are to be returned in the results.  

###RESULTS_HIT
- Defines the number of matching documents found.

###RELEVANCE
- Defines the relevance ranking, showing how relevant the document is to the query. 

###URL
- Defines the URL of the found document.

###TITLE
- Defines the title of the found document.

###SUMMARY
- Defines the summary of the found document.

###MATCHING_TERMS
- Defines the title of the found document.

###MORE_LIKE_THIS
- Defines a link for refining the search by using the document itself as a query string.

###RESULTS_PREVIOUS
- Defines a link to the previous results displayed.  This variable is may not always be displayed.

###RESULTS_CURRENT
- Defines the number of results currently displayed.

###RESULTS_NEXT
- Defines a link to display the next results.  This variable is may not always be displayed.

###PREVIOUS_SEARCH_QUERY
- Defines the terms used in the previous search query.


Contacting StarNine Technologies, Inc.

StarNine Technologies, Inc.
2550 Ninth Street, Suite 112
Berkeley, California 94710

Email:
  info@starnine.com
  sales@starnine.com
  support@starnine.com

Web: 
  http://www.starnine.com/

Phone:
  Main: (510) 649-4949
  Sales: (800) 525-2580 or  (510) 649-4949
  Support: (510) 704-1272

Fax:
  Sales: (510) 548-5959
  Main: (510) 548-0393


Edited 10/19/99