Search Help Pages

Command link:     /search/[character]
HTML document:  srchhelp_[character].html

The WebPAC Search Help pages use the following naming convention:

srchhelp_[character].html

where [character] is the one-character tag used in the search command link that accesses the index associated with the Search Help page. For example the /search/t command link calls the srchhelp_t.html Search Help page.

Valid tokens are:

Token Description
<!--{toplogo}--> The system replaces this token with the HTML defined in the TOPLOGO Web option.
<!--{formbegin}--> The system replaces this token with a formatted opening <form> HTML tag. This token must be placed in the custom form before any form-related tokens.
The <!--{nosort}--> Token

If you omit the <!--{nosort}--> token from this form, replace the <!--{formbegin}--> token with the following <form> HTML tag:

<form class="unpadded" action="/search/" method="get" name="search" id="search">

or

<form class="unpadded" action="/search/[char]/" method="get" name="search" id="search">

Where [char] is the one-character tag associated with the index the system searches. For more information, see the /search command link.
<!--{search}--> This token places a text input box on the page for search string entry. See Advanced Search for details on the Advanced Word Search syntax.
This token must appear between <form> and </form> HTML tags on the page.
<!--{availlim}--> The system replaces this token with a "Limit to available" checkbox in the search tool. The label text (i.e., "Limit to available") is set with the AVAILLIM Web option.
NOTE

This functionality is not supported on INN-Reach Central Servers.
<!--{circ_hist_limit}--> The system replaces this token with a checkbox in the search tool to remove any limits on search results based on patron type or reading history, such as Homebound Patron Services.
<!--{clearform}--> The system replaces this token with a Clear Form link. The appearance of this link is defined by the ICON_CLEAR_FORM Web option.
<!--{communities}--> The system replaces this token with a list of links to communities.
<!--{currentscope}--> The system replaces this token with the name of the current scope the user is searching.
<!--{indexsort}--> If the SORT_BROWSE Web option is defined, the system replaces this token with a sort type selection drop-down menu listing the library-defined labels for the sort types in the order defined.
NOTES
  • This token requires a JavaScript-enabled browser.
  • The SORT_BROWSE Web option does not work with keyword searches.
<!--{innreach}--> If a search has no results on an INN-Reach Local Server, the system replaces this token with the link defined in the INNREACH Web option.
<!--{logout}--> Libraries using the My Account feature can place this token on any WebPAC page to display a Logout and a Return to Patron Record button after a patron logs onto the system. After selecting this button, the patron returns to the Patron Information page for the original log on. If the TOPLOGO_LOGGEDIN Web option is set to a false value, the system ignores this token.
<!--{msg}--> The system replaces this token with any system messages.
<!--{netli_ask}--> If your library has set the Set netLibrary Code system option, the system replaces this token with a check-box that allows the user to pre-limit the searches to netLibrary eBooks.
<!--{netli_force}--> The presence of this token instructs the system to automatically limit any searches to netLibrary eBooks.
<!--{nosort}--> This token enforces browse list sorting in the order specified by the first option that your library has set in Advanced Searching: Ranking Options option. The user has no opportunity to change the order. This token can appear anywhere on the page. If you do not use this token, your form must contain a specially-formatted HTML <form> tag.
<!--{partner}--> This token places a PARTNER button on the page and allows the search to pass through to the partner library. The button appears only following a search with no resulting entries. This token can appear anywhere on the page.
<!--{patron}--> If your library uses My Account, the system replaces this token with a You are logged in as:[patron name] message if the patron is logged in.
NOTE

This token is not valid on INN-Reach Central Servers.
<!--{resetscope}--> The system replaces this token with a drop-down list of scopes defined in your Scope Menu.
<!--{resetscope:[#]}--> The system replaces this token with a link to the scope number defined in your Scope Menu. The scope to search is indicated by [#] in the token description (for example, <!--{resetscope:3}--> to search scope 3 as defined in your Scope Menu). The appearance of this link is controlled by the ICON_RESETSCOPE Web option.
<!--{return}--> Places a Return Home link on pages retrieved when searching the central machine's database in an INN-Reach consortium or when searching a remote, partnered machine's database. After selecting this link, the user returns to his or her home Innovative server.

Setting the BUT_RETHOME Web option displays a graphic image button, specified by the option, for this link. Otherwise, the link appears as the text Return Home.
<!--{RSS:[settings]}--> This token is replaced by an RSS feed where [settings] is specified using the following colon-delimited, elements:

[URL]:
[MAX_ITEMS]:[DISPLAY_DESCRIPTIONS]:[DISPLAY_DATES]:
[DISPLAY_IMAGE/TITLE]
Token ElementDescription
[URL]The URL of the RSS feed.
[MAX_ITEMS]The maximum number of items to display from the RSS feed.
[DISPLAY_DESCRIPTIONS]This element controls the display of the RSS feed item description. If this element is set to 1 or t, the WebPAC displays the RSS feed item description.
[DISPLAY_DATES]This element controls the display of the RSS feed item date. If this element is set to 1 or t, the WebPAC displays the RSS feed item date.
[DISPLAY_IMAGE/TITLE]This element controls the display of the image and title for the RSS feed. This element accepts the following settings:
  • 0— Show neither the title nor the image.
  • 1— Show only the title.
  • 2— Show only the image.
  • 3— Show both the title and the image.


For example:
<!--{RSS:http://www.nytimes.com/services/xml/rss/nyt/Science.xml:5:t:t:3}-->
Images for Items

The <!--{RSS:[settings]}--> token does not control display of titles and images for individual items. Use the feed configuration file to control that display.
<!--{scope}--> The system replaces this token with a drop-down list of scopes defined in your Scope Menu.
<!--{session}--> INN-Reach Central Only: The system replaces this token with a You are logged in as:[patron name] message if the patron is logged in to My Account.
<!--{sort}--> This token places a drop-down menu on the page allowing the user to select a sorting option, such as by Date, Alphabetically, or by Relevance, for the retrieved records. See Advanced Search for details on the sort options available with this feature.

This token must appear between <form> and </form> HTML tags on the page.
<!--{spellcheck}--> If your library has acquired Spell Check, this token inserts the Spell Check Tool on the page. Using the Spell Check Tool, the user can choose corrected search terms. For more information, see Using Spell Check.
Form Tags

Note that the spellcheck token creates a form and must not be placed between existing HTML form tags or tokens that generate form tags, such as the <!--{formbegin}--> token.
<!--{srchhist}--> This token places a Search History drop-down menu on the page, from which the user can select a previously entered search to repeat. The space for this menu is empty on the first search page that the user calls up. See Repeating Previous Searches (Search History) for more information on this feature.

This token must appear between the <!--{formbegin}--> and <!--{formend}--> tokens.
<!--{ifprogreg}--> If your library has acquired the Program Registration product, the system interprets the tokens between this token and its closing <!--{xif}--> token.
<!--{progregcal}--> The system replaces this token with the value of the ICON_PROGRAM_CAL Web option.
<!--{xif}--> Closes the <!--{ifprogreg}--> logic.
<!--{submit}--> The system replaces this token with a Submit button for searches from this page.
<!--{formend}--> The system replaces this token with a closing </form> HTML tag. This token must be placed in the custom form after all form-related tokens.
<!--{botlogo}--> The system replaces this token with the HTML defined in the BOTLOGO Web option.

You can create separate custom forms for each combination of language, scope, and patron type by using the following naming convention:

srchhelp_[character]_LANG_s#_p#.html

LANG The language code (spi for Spanish, frc for French, etc.).
s# The number of the scope (s1, s2, s3, etc.).
p# The patron type or PTYPE (p0 or p243, etc.).

For a current example of this form, see the appropriate example set in WebPAC Example Sets and Photoshop Files on CSDirect.