Previous Page: Guidelines for Using Variables  Next Page: Exploring Search Result Variables

Exploring 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 4. Search Page Variables

Variable Name Description of Use

$$BeginCollectionsLoop

Begins the repeating section in the search template where collection information will be written.

$$EndCollectionsLoop

Ends the repeating section in the search template where collection information will be written.

$$ServerCollectionName

Inserts the name of the collection defined in the Web Search Manager.

$$ServerCollectionDescription

Inserts the description of a collection as found in the Web Search Manager.

$$TemplateName

Identifies the filename of the template.

$$TemplateLocale

Identifies the locale of the template, such as zh_TW.

$$TemplateTheme

Identifies the theme (or theme directory) in which you want to place the template.

$$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 the this variable.

$$Countervariablenumber, incrementnumber

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.

$$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.

$$ResultEncoding

Identifies the encoding used to return the current search results page.

$$QueryTemplateTheme

Identifies the theme requested by the search client.



  Previous Page: Guidelines for Using Variables  Next Page: Exploring Search Result Variables