User Guide

192 Getting Results with Novell Web Services
Getting Results with Novell Web Services
103-000133-001
August 29, 2001
Novell Confidential
Manual 99a38 July 17, 2001
For more information about how to implement variables in a search or print
template, or how to implement search parameters in an HTML document to
create a search form, see Chapter 17, “Customizing Your Search Solutions,”
on page 185.
Search Page Variables
The following table lists all available search page variables that can be used to
extend the functionality of the default search templates (SearchTemplate.html
or SearchTemplate.Simple) or to create new templates from scratch.
Table 10 Search Page Variables
Variable Name Description
$$BeginCollectionsLoop Begins the repeating section in the search template where index
information will be written.
$$Collection The name of the collection.
$$Countervariable_number,
increment_number
Inserts the value of the specified var# counter into the search result
page. All counters initialize to zero. The optional second parameter
specifies the amount to increment or decrement the current value. A
maximum of 10 counters is supported. For example:
$$Counter[1] = insert value of counter #1
$$Counter[1,1] = increment counter #1 by 1 and display the new value
$$Counter[5,-3] = decrement counter #5 by 3 and display the new value
$$EndCollectionsLoop Ends the repeating section in the search template where index
information will be written.
$$IncludeFile Automatically pulls in the designated template at the location of this
variable. The included template can contain other template variables,
which will be processed as though they were a part of the original
template. The template name parameter can either be a full FILE:// URL
based on the file system of the server or a relative path based on the
location of the parent template. The template name parameter can be
located within quotation marks. See the SearchResultTemplate.html file
for an example use of this variable.
$$QueryTemplateTheme Identifies the theme requested by the search client.
$$ResultEncoding Identifies the encoding used to return the current search results page.