| search_results.html
This template is used to display results from a search. It is also used
to display a "not found" or "expired results" page.
TemplateCells
| templatecell |
description |
|
ignore_words |
show the user which words were ignored, if there were any
|
|
navigate_prev |
a link to the previous page of results
|
|
navigate_next |
a link to the next page of results
|
|
search_form |
a form provided for the user to quickly try another search
|
|
result_title * |
a single result row, title and url only
|
|
result_brief * |
a single result row, brief description only
|
|
result_full * |
a single result row, full description
|
|
not_found |
what to show the user if no results were found
|
|
expired_results |
what to show the user if the results have expired
|
|
rating_0 |
visual identifier for a poor result
|
|
rating_1 |
visual identifier for a fair result
|
|
rating_2 |
visual identifier for a good result
|
|
must_words |
the style which "must include" words will be displayed
|
|
may_words |
the style which "may include" words will be displayed
|
Note: Search Engine supports alternating rows: if you create a
result_title2 templatecell,
it will be used for every second result in the list. Likewise,
result_brief2 and
result_full2 templatecells
may also be created.
Note: You can add or remove consecutive
rating cells, but the
rating_0 cell must exist
(it can, however, be empty). The best search result will always be assigned
the highest rating. As search results become less accurate, they will receive
lower numbered ratings.
Placeholders
Global Placeholders
| placeholder |
description |
|
$_cgisearchurl$ |
the url to the Search Engine's search.cgi program
|
|
$_imageurl$ |
the url to the program's image directory
|
|
$_search_title$ |
the 'titlebar' of the program
|
|
$_category_list$ |
a list of <option> tags to create a category dropdown
|
|
$_row_list$ |
a list of <option> tags to create a dropdown for 'results per page'
|
document placeholders
| placeholder |
description |
|
Global Placeholders |
For a complete list of Global Placeholders, click here
|
|
$result_list$ |
a list of result rows, showing the results of the search. this cell is comprised of a list of
result_title, result_brief,
or result_full in the case of a successful search, or
not_found or
expired_results in the case of an unsuccessful one.
|
templatecell : ignore_words
| placeholder |
description |
|
Global Placeholders |
For a complete list of Global Placeholders, click here
|
|
$ignore$ |
a comma separated list of words which have been ignored
|
templatecell : navigate_prev
| placeholder |
description |
|
Global Placeholders |
For a complete list of Global Placeholders, click here
|
|
$prev_url$ |
an url to the previous page of results
|
templatecell : navigate_next
| placeholder |
description |
|
Global Placeholders |
For a complete list of Global Placeholders, click here
|
|
$next_url$ |
an url to the next page of results
|
templatecell : search_form
| placeholder |
description |
|
Global Placeholders |
For a complete list of Global Placeholders, click here
|
|
$search$ |
the text that the user has searched for
|
|
$categories$ |
the categories the user has searched for
|
|
$search_mode$ |
the mode of the current search (any, all, or phrase)
|
|
$search_what$ |
the parts of the document the search is confined to (body, keywords, title, and/or url)
|
|
$case_sensitive$ |
whether or not the search is case-sensitive
|
|
$result_rows$ |
the number of results to show per page
|
|
$format$ |
the type of result rows to show the user (result_title, result_brief, or result_full)
|
|
$skin$ |
the html file used to display the results
|
Note: These placeholders are intended to provide state persistence between searches. Since these all of these placeholders should generally be inside of <input value=""> tags, they should be HTML Encoded with the _he modifier. For example: $search_he$
templatecells : result_title, result_brief, and result_full
| placeholder |
description |
|
Global Placeholders |
For a complete list of Global Placeholders, click here
|
|
$num$ |
this result number, starting with 1
|
|
$rating$ |
the contents of one of the rating cells, using higher numbers for better results and rating_0 for the worst
|
|
$score$ |
a numerical value, showing the relevance of this result
|
|
$max_score$ |
a numerical value, showing the limit of result scores
|
|
$percent$ |
a numerical value, showing the relevance of this result in a percentage
|
|
$size_kb$ |
the size of the file in kilobytes
|
|
$update_date$ |
the date the file was last updated
|
|
$title$ |
the title of the page
|
|
$url$ |
the url of the page
|
|
$description$ |
the description of the page
|
|
$context$ |
a sampling of the page's content, showing highlighted words
|
templatecells : not_found and expired_results
| placeholder |
description |
|
Global Placeholders |
For a complete list of Global Placeholders, click here
|
|
These templatecells do not have any additional placeholders. |
templatecells : rating_ cells
| placeholder |
description |
|
Global Placeholders |
For a complete list of Global Placeholders, click here
|
|
These templatecells do not have any additional placeholders. |
templatecells : must_word and may_word
| placeholder |
description |
|
Global Placeholders |
For a complete list of Global Placeholders, click here
|
|
$word$ |
the word to be highlighted
|
|