| |
The following table lists all available print result variables that can be used to extend the functionality of the default print result templates, or to create new templates from scratch. For more information about how to implement variables in a template (HTML) page, see Building a Custom Search Solution.
Table 6. Print Result Variables
| Variable Name | Description of Use |
|---|---|
$$BeginTOCList[text] |
Beginning of the table of contents repeating section. This section is repeatedly parsed until there are no further TOC result items to process. This is a conditional text section. The items within the brackets [] are processed only if the current item represents a change in the depth of the hierarchy. If $$Product appears within the conditional text, it will be replaced only if the current item also represents a new product. |
$$EndTOCList[text] |
End of the table of contents section. This is a conditional text section. The items within the brackets [] are written out each time a result item occurs that decreases the depth of the hierarchy. If the depth of the current item is several levels less than the previous item, the text within the conditional text block is written out that many times. |
$$BeginLoop |
For a description of this item, refer to the equivalent search result variable in Table 5. |
$$EndLoop |
For a description of this item, refer to the equivalent search result variable in Table 5. |
$$Bookmark |
The HTML anchor name of the current result item. This can be used to jump from a TOC entry to the corresponding section within the print job. All bookmark entries begin with "novell_print_toc_" and are followed by the number of the current result item, as in novell_print_toc_1. |
$$TotalHits |
For a description of this item, refer to the equivalent search result variable in Table 5. |
$$Description |
For a description of this item, refer to the equivalent search result variable in Table 5. |
$$Number |
For a description of this item, refer to the equivalent search result variable in Table 5. |
$$Product |
The name of the product associated with the current item in the table of contents. This only displays if this is the first result item within that product. See also $$BeginTOCList[] |
$$Title |
For a description of this item, refer to the equivalent search result variable in Table 5. |
$$URL |
For a description of this item, refer to the equivalent search result variable in Table 5. |
$$URLContent |
The entire contents of the URL are placed into the template at this location. The URL contents are not parsed to validate their data type, formatting, or functionality. Only text/plain and text/html files are printed. All other files are inserted into the print job as an error message. |
$$TemplateName |
See the description of this variable in Table 4. |
$$TemplateLocale |
See the description of this variable in Table 4. |
$$TemplateTheme |
See the description of this variable in Table 4. |
$$IncludeFile |
See the description of this variable in Table 4. |
$$Countervariablenumber, incrementnumber |
See the description of this variable in Table 4. |
$$ResultEncoding |
See the description of this variable in Table 4. |
$$QueryTemplateTheme |
See the description of this variable in Table 4. |
| |