Last updated 2003-12-01 15:35:52 EST
Doc Title Findaid class Processing Instructions
Author 1 Stoeffler, Matt
CVS Revision $Revision: 1.6 $
Findaid Class Processing Instructions (PIs)

The following table includes descriptions of all the processing instructions (PIs) that appear in FindaidClass templates and that are supported by the CGI (see HTML Templates / Interfaces for more on PIs), as well as links to descriptions of the relevant template files in which they may appear. Note that PIs are not interchangeable with templates; they must be supported in the CGI to be rendered properly.

PI tagOptional parametersAssociated templatesDescription
<?BBAG_BOOLEAN_SEARCH_LINK> bbaglist.tpl
bbagsimplesearchform.chnk
Provides the HREF URL for the "Boolean" search within book bag link.
<?BBAG_SIMPLE_SEARCH_LINK> bbagbooleansearchform.chnk
bbaglist.tpl
Provides the HREF URL for the "simple" search within book bag link.
<?BIB_SEARCH_LINK> bbaglist.tpl
Provides the HREF URL for the "citation" search form link in the main or footer navigation bar.
<?BOOKBAG_DOWNLOAD> bbaglist.tpl
Used to insert a button to download book bag contents.
<?BOOKBAG_EMAIL> bbaglist.tpl
Used to insert a button to email book bag contents.
<?BOOKBAG_EMPTY> bbaglist.tpl
Used to insert a button for removing all book bag contents.
<?BOOKBAG_ITEMS> bbaglist.tpl
navheader.chnk
Used to insert the book bag items count in the current page.
<?BOOKBAG_LINK> navheader.chnk
Provides the HREF URL for the "view bookbag" link in a page.
<?BOOKBAG_RESULTS> bbaglist.tpl
Used to insert all current book bag items within table <TR> and <TD> tags.
<?BOOLEAN_SEARCH_LINK> bbaglist.tpl
navheader.chnk
simplesearchform.chnk
Provides the HREF URL for the "boolean" search form link in the main or footer navigation bar.
<?BROWSE_GROUPS_LINK> search.tpl
<?CHUNK> filename="[value]" browsecolls.tpl
outline.tpl
reslist.tpl
text.tpl
search.tpl
bbagsearch.tpl
browsecolls.tpl
outline.tpl
reslist.tpl
search.tpl
searchhistory.tpl
text.tpl
bbagsearch.tpl
browsecolls.tpl
outline.tpl
reslist.tpl
search.tpl
searchhistory.tpl
text.tpl
bbagsearch.tpl
search.tpl
Resolves to a chunk file specified in the filename attribute
<?COLL_LIST_WITH_CHECKBOXES> search.tpl
On multiple collection search forms, used to insert the table of available collections with check boxes for selecting or deselecting.
<?COLL_SPECIFIC_CONTENT> id="collspecinlinehelp" bbagsearch.tpl
navheader.chnk
Provides the HREF URL for a collection specific (e.g., browse) navigation link in main nav bar or footer nav bar.
<?CONTACT> type="[value]" footer.chnk
footernolist.chnk
searchhistory.tpl
If type="text" returns the text contact of the contact link. If type="link" provides the HREF value for the link
<?CSS_PATH> filename="[value]" searchhistory.tpl
searchhistory.tpl
reslist.tpl
bbagsearch.tpl
browsecolls.tpl
outline.tpl
reslist.tpl
search.tpl
text.tpl
bbagsearch.tpl
browsecolls.tpl
outline.tpl
reslist.tpl
search.tpl
Invoking the fallback mechanism, resolves to an appropriate path to a named css file.
<?DOC_ROOT> mode="[value]" bbaglist.tpl
viewtextnote.tpl
bbaglist.tpl
home.tpl
text.tpl
viewtextnote.tpl
Used to insert the appropriate root path for the collection accessing the template for relative file reference.
<?GO_TO_XCOLL> navheader.chnk
Provides the HREF URL for the "multiple collection search" link in a page.
<?GRAPHICS_PATH> filename="[value]" navheader.chnk
navheader.chnk
text.tpl
footer.chnk
searchhistory.tpl
Used to insert the appropriate path and filename for a graphics file.
<?GROUPS_COLLS_LIST> browsecolls.tpl
Returns the list of available group names as links with associated collection names on the browse collections page.
<?GROUPS_SELECTION_NAV> search.tpl
Used to filter in/out HTML for the groups selection menu in the search.tpl
page.
<?GROUP_IN_FOCUS_NAME> search.tpl
Returns the name of the currently selected group that is being searched for the search.tpl
page.
<?GUIDE_FRAME> reslist.tpl
Used to filter out HTML markup for the per-collection results summary from the results page when only one collection has been searched.
<?GUIDE_RESULTS_LINKS> reslist.tpl
That portion of the per-collection results summary code that inserts links for viewing results detail for each collection.
<?HELP_LINK> bbaglist.tpl
Provides the HREF URL for the "help" link in the main or footer navigation bar.
<?HIDDEN_BOOKBAG> bbagbooleansearchform.chnk
bbagsimplesearchform.chnk
search.tpl
Returns a hidden form variable named "bookbag" that is set to 1 if the current search form is restricted to the current bookbag.
<?HIDDEN_DEBUG> search.tpl
Used to flag the existence of a debug parameter in a call to the search template. Returns an <INPUT> type=hidden element with name equal to debug, and value equal to the param value.
<?HIDDEN_G> bbagbooleansearchform.chnk
bbagsimplesearchform.chnk
search.tpl
Returns a hidden form variable indicating the current group.
<?HIDDEN_IDNO> bbagbooleansearchform.chnk
bbagsimplesearchform.chnk
search.tpl
Returns a hidden form variable indicating current item id number.
<?HIDDEN_REQUESTED_COLLECTIONS> bbagbooleansearchform.chnk
bbagsimplesearchform.chnk
search.tpl
Used to insert a hidden INPUT element into a search form storing the currently selected collection[s].
<?HIDDEN_SID> bbagbooleansearchform.chnk
bbagsimplesearchform.chnk
search.tpl
Used to insert hidden INPUT form elements indicating the current session id.
<?HIDDEN_SORT_VARS> reslist.tpl
For the sort form, returns a list of <INPUT> type hidden elements.
<?HIDDEN_XC> bbagbooleansearchform.chnk
bbagsimplesearchform.chnk
search.tpl
Reflects a possible xc cgi parameter pair as an INPUT element of type hidden. The xc parameter is used to flag the current environment to indicate collection or group specific elements to the user interface (e.g., collection home link URLs, fallback modes, etc.).
<?HIDDEN_XG> bbagbooleansearchform.chnk
bbagsimplesearchform.chnk
search.tpl
Reflects a possible xg cgi parameter pair as an INPUT element of type hidden. The xg parameter is used to flag the current enviroment for searching; the presence of an xg=1 says to display the group select frame.
<?HOME_LINK> navheader.chnk
navheader.chnk
Returns the HREF value for a link going to the collection/group home.
<?INCLUDE_BOOKBAG_LINK> navheader.chnk
Used to filter in/out HTML markup for a link to the "view bookbag" link.
<?INCLUDE_BOOKBAG_SEARCH_LINKS> bbaglist.tpl
Used to insert or exclude HTML markup for optional search links on book bag contents and/or email forms.
<?INCLUDE_COLL_LIST_WITH_CHECKBOXES> search.tpl
Used in search.tpl
to filter in/out HTML markup containing the current colletions for the selected group.
<?INCLUDE_COLL_SPECIFIC_CONTENT> id="collspecinlinehelp" bbagsearch.tpl
navheader.chnk
Used to include or exclude navigation link code for features that are available only for certain collections.
<?INCLUDE_DETAIL_DISPLAY_ITEMS> reslist.tpl
Used to include or exclude HTML markup for navigation elements specific to the results item details display.
<?INCLUDE_GO_TO_XCOLL> navheader.chnk
Used to include or exclude HTML markup for link going to the multiple collection search.
<?INCLUDE_GROUPS_SELECTION_NAV> search.tpl
Used to include or exclude HTML links for selecting alternative groups in a mult-collection search interface.
<?INCLUDE_OUTLINE_MENU?> outline.tpl
Used to include or exclude HTML links for navigating among the first two section levels of the current finding aid.
<?INCLUDE_RETURN_TO_RESULTS> reslist.tpl
text.tpl
Returns a link to the current results list from a header, text, or pageviewer display.
<?INCLUDE_SEARCH_TAB> navheader.chnk
Used to filter in/out HTML markup for the "Search" navigation tab.
<?INCLUDE_SHORT_DISPLAY_ITEMS> reslist.tpl
Used to include or exclude HTML markup for elements (I.e., sorting) specific to the short results display
<?ITEM_TITLE?> outline.tpl
Returns the title of the current finding aid to the "standard" and full text view display.
<?JS_PATH> filename="[value]" bbagsearch.tpl
browsecolls.tpl
outline.tpl
reslist.tpl
search.tpl
searchhistory.tpl
text.tpl
bbagsearch.tpl
browsecolls.tpl
search.tpl
searchhistory.tpl
Invoking the fallback mechanism, resolves to an appropriate path to a named js file.
<?JS_REGION_ARRAYS> bbagsearch.tpl
search.tpl
Used in multiple search forms to provide Javascript code for implementing the collection selecting functionality.
<?NAV_TAB_STYLE_OVERRIDES> bbagsearch.tpl
browsecolls.tpl
search.tpl
searchhistory.tpl
text.tpl
Returns a <LINK> element with path to a stylesheet containing appropriate style declarations for the current navigation context (i.e., which tab is highlighted?).
<?NUMBER_OF_COLLECTIONS> home.tpl
Previously used in search forms to indicate the number of collections currently being searched.
<?OP2_SELECT> class="[value]" bbagbooleansearchform.chnk
booleansearchform.chnk
Returns a form <SELECT> element named op2, for designating the boolean operator value between input values q1 and q2.
<?OP3_SELECT> class="[value]" bbagbooleansearchform.chnk
booleansearchform.chnk
Returns a form <SELECT> element named op3, for designating the boolean operator value between input values q2 and q3.
<?ORG_INFO> type="[text|link]" footer.chnk
footernolist.chnk
If type="text" returns the text of the orgainization info link. If type="link" provides the HREF value for the link
<?OTHER_VIEW_LINKS?> outline.tpl
Used to insert links to other views of the current finding aid (E.g., "search terms in context," "standard view," "full text," "add to bookbag")
<?OUTLINE_MENU?> outline.tpl
Inserts a columnar list of navigation links to all first and second level sections of the current finding aid.
<?PAGETYPE> bbagsearch.tpl
search.tpl
Provides the current page type, as a string, to a search template. The value is utilized by a javascript function.
<?PREV_NEXT_ITEM_LINKS> reslist.tpl
Used to insert HREF URL code for the previous and next item when displaying results details for a particular item.
<?PRINTABLE_VERSION_LINK?> outline.tpl
Previous to release 11, this provided an HREF URL for an HTML link to the fulltext version of a finding aid in the navigation margin of the outline view.
<?Q1_INPUT> size="[value]" class="[value]" bbagbooleansearchform.chnk
booleansearchform.chnk
bbagsimplesearchform.chnk
simplesearchform.chnk
Used to insert an INPUT box, q1, into a search form for the first query term.
<?Q2_INPUT> size="[value]" class="[value]" bbagbooleansearchform.chnk
booleansearchform.chnk
Used to insert an INPUT box, q2, into a search form for the second query term.
<?Q3_INPUT> size="[value]" class="[value]" bbagbooleansearchform.chnk
booleansearchform.chnk
Used to insert an INPUT box, q3, into a search form for the third query term.
<?REFINE_SEARCH_LINK> reslist.tpl
Returns a link to a results display to return to a search form to refine the search.
<?REGION_SEARCH_SELECT> class="[value]" bbagbooleansearchform.chnk
bbagsimplesearchform.chnk
booleansearchform.chnk
simplesearchform.chnk
Returns a form <SELECT> element named rgn for designating the field to apply qn fields to in boolean searches
<?RESULTS> reslist.tpl
Inserts detailed results listings within table <TR> and <TD> tags
<?RESULTS?> outline.tpl
Inserts detailed results listings within table <TR> and <TD> tags
<?RETURN_TO_RESULTS> reslist.tpl
Used to insert an HTML link back to results listings from the pageviewer.
<?RE_AUTH_LINK> home.tpl
navheader.chnk
Provides the HREF URL for the "Authorized user login" link from any page.
<?SCRIPT_NAME> cginame="[value]" bbagbooleansearchform.chnk
bbagsimplesearchform.chnk
home.tpl
reslist.tpl
search.tpl
bbaglist.tpl
Used to insert a relevant script name into a collection-specific URL path.
<?SEARCH_HISTORY_LINK> bbaglist.tpl
navheader.chnk
Provides the HREF URL for the "history" page link in the main or footer navigation bar.
<?SEARCH_HISTORY_TABLE> searchhistory.tpl
Returns the list of recent searches in table markup.
<?SEARCH_IN_NATURAL_LANGUAGE> reslist.tpl
Returns the currently query string to a search summary display atop the results list.
<?SEARCH_QUALIFIER> reslist.tpl
Used to add an appended qualifier to the search summary statement of a results list indicating that the search was restricted to either a bookbag or a specific text.
<?SEARCH_RESTRICTION> search.tpl
Returns HTML markup containing the bibliographic info of an item currently being searched.
<?SEARCH_TYPE> search.tpl
Returns the current search type value for the hidden variable "type" in search form templates.
<?SEARCH_TYPE_TEXT> bbagsearch.tpl
search.tpl
searchhistory.tpl
Returns the current search type value for the search page header.
<?SGML_RESULTS> text.tpl
Returns the item text in HTML markup in text view.
<?SIMPLE_SEARCH_LINK> bbaglist.tpl
booleansearchform.chnk
navheader.chnk
Provides the HREF attribute value for the "basic" search .
<?SLICE_NAVIGATION_LINKS> occ="[1|2]" reslist.tpl
Used to insert the links navigating between the current page of search results and other pages of results.
<?SORT_SELECT> onchange="[Jscall]" reslist.tpl
Inserts a form select element providing options for sorting results.
<?TITLE> mode="complex" bbaglist.tpl
bbaglist.tpl
bbagsearch.tpl
browsecolls.tpl
outline.tpl
reslist.tpl
search.tpl
searchhistory.tpl
text.tpl
viewtextnote.tpl
Used to insert the collection title logo as an HTML graphic or text string within <A> tags linking to the collection home page.
<?VIEW_TEXT_LINK> viewtextnote.tpl
Appears in a warning notice before linking to the full length of a given text. The PI returns the HREF URL to the link.
<?XCOLL_TOTALS> reslist.tpl
Returns the number of matches and number of matched regions to a results list summary statement.