Interlibrary Loan Request Forms
Command links: /ill[x], where x=b, c, d, g, j, p, or t
HTML documents:
| /illb | illbook.html |
| /illc | illchapter.html |
| /illd | illdissert.html |
| /illg | illgov.html |
| /illj | illjournal.html |
| /illp | illconf.html |
| /illt | illreport.html |
NOTE
The HTML for the ILL forms can be identical. The <!--{illreqform}--> token reads the system's ILL Options settings and displays the appropriate prompts depending on the type of request, i.e., depending on the name of the file.
| <!--{toplogo}--> | The system replaces this token with the <HTML> and <BODY> tags that begin an HTML page and the value of the TOPLOGO Web option. This must be the first line in the ill*.html files. |
| <!--{patron}--> | The system replaces this token with the patron identification message. |
| <!--{startover}--> | The system replaces this token with a Start Over button. Clicking this button takes the user to the URL defined in the XSTARTOVER Web option. |
| <!--{homebtn}--> | The system replaces this token with an Another ILL Request button. Clicking this button takes the user to the URL defined in the ILL_HOME Web option. |
| <!--{iferrmsg}--> | If this token is present and there is an error, the system interprets tokens and markup between this token and its closing <!--{xif}--> token. |
| <!--{iferrmsgisPIN}--> | If this token is present and there is an error, the checks if patron record does not have a PIN. If the patron record does not have a PIN, the system interprets tokens and markup between this token and the <!--{else}--> token. |
| <!--{newpinmsg}--> | The system replaces this token with the value of the NEWPIN_MSG Web option. |
| <!--{else}--> | If the error condition is not related to the previous tokens and markup, the system interprets the tokens and markup between this token and its closing <!--{xif}--> token. |
| <!--{errmsg}--> | The system replaces this token with any error messages that explain why a request was not submitted when the form reloads. For example: Request was not submitted: There is a problem with your library record. Please see a librarian. |
| <!--{xif}--> | Closes the <!--{iferrmsgisPIN}--> block |
| <!--{xif}--> | Closes the <!--{iferrmsg}--> block |
| <!--{heading}--> | The system replaces this token with a system-defined text prompt for ILL requests. Contact Innovative to change the display generated by this token. |
| <!--{illreqform}--> | (Required unless you are using advanced customization) The system replaces this token with the input form exactly as the system-generated screen would have done. This token is generic to the /ill forms and the system displays prompts appropriate to the material type indicated by the screen link. If this token is not used, you must have an <!--{illform}--> token on this form in order to properly submit ILL requests. |
| <!--{illBlink}--> | The system replaces this token with a links to book material types. If book material types are not valid on this system, the system does not display a link. |
| <!--{illClink}--> | The system replaces this token with a links to chapter material types. If chapter material types are not valid on this system, the system does not display a link. |
| <!--{illDlink}--> | The system replaces this token with a links to dissertation material types. If dissertation material types are not valid on this system, the system does not display a link. |
| <!--{illGlink}--> | The system replaces this token with a links to government material types. If government material types are not valid on this system, the system does not display a link. |
| <!--{illJlink}--> | The system replaces this token with a links to journal material types. If journal material types are not valid on this system, the system does not display a link. |
| <!--{illPlink}--> | The system replaces this token with a links to conference material types. If conference material types are not valid on this system, the system does not display a link. |
| <!--{illTlink}--> | The system replaces this token with a links to report material types. If report material types are not valid on this system, the system does not display a link. |
| <!--{botlogo}--> | The system replaces this token with the value of the in the BOTLOGO Web option and inserts the </BODY> and </HTML> tags that finish an HTML page. This must be the last line in the ill*.html files. |
For advanced customization of the form, the <!--{illreqform}--> token can be replaced by the following tokens:
| <form method=post> | This HTML tag begins the HTML form and is required. |
| <TABLE> | The <!--{illform}--> token requires <TABLE> tags for formatting |
| <!--{illform}--> | (Required if the <!--{illreqform}--> is not used) The system replaces this token with the form inputs appropriate to the material type for the /illx form, based on the ILL Options file. This token is required in advanced customization to properly submit the ILL request. |
| </TABLE> | |
| <!--{illcopyright}--> | The system replaces this token with the copyright message defined on the system in the ILL Options file |
| <!--{sublib}--> | The system replaces this token with a Search the Library Catalog For This Item button |
| <!--{ifneedpatronname}--> | If this token is present, the system checks if patron name is used in patron verification. If so, the system interprets tokens and markup between this token and its closing <!--{xif}--> token. |
| <!--{nameexample}--> | The system replaces this token with the value of the Example for name prompt option listed as part of the Patron self-identification prompts & examples OPAC option. |
| <!--{nameprompt}--> | The system replaces this token with the value of the Prompt for name option listed as part of the Patron self-identification prompts & examples OPAC option. |
| <!--{name}--> | The system replaces this token with the input for the patron name. |
| <!--{xif}--> | Closes the <!--{ifneedpatronname}--> block |
| <!--{email}--> | If the ILL_CONF_EMAIL is defined, the system replaces this token with a prompt for the user's email address. |
| <!--{ifneedpatronverify}--> | If this token is present, the system checks if numeric fields (barcode, PIN) are used for verification on the system. If so, the system interprets tokens and markup between this token and its closing <!--{xif}--> token. |
| <!--{barcodeexample}--> | The system replaces this token with the value of the Example for patron ID option listed as part of the Patron self-identification prompts & examples OPAC option. |
| <!--{barcodeprompt}--> | The system replaces this token with the value of the Prompt for patron ID option listed as part of the Patron self-identification prompts & examples OPAC option. |
| <!--{barcode}--> | The system replaces this token with the input for the patron barcode or ID number. |
| <!--{ifneedspin}--> | If this token is present, the system checks if PIN validation is required. If so, the system interprets tokens and markup between this token and its closing <!--{xif}--> token. |
| <!--{iferrmsgisPIN}--> | If this token is present, the system checks if patron record does not have a PIN. If there is not a PIN associated with the patron record, the system interprets tokens and markup between this token and its closing <!--{xif}--> token. |
| <!--{newpinmsg}--> | The system replaces this token with the value of the NEWPIN_MSG Web option. |
| <!--{pin1prompt}--> |
The system replaces this token with the value of the NEWPIN1_PROMPT Web option. If this option is not defined, the system replaces this token with the following message: Please enter your PIN |
| <!--{pin1}--> | The system replaces this token with the first input box for the new PIN. |
| <!--{pin2prompt}--> |
The system replaces this token with the value of the NEWPIN2_PROMPT Web option. If this option is not defined, the system replaces this token with the following message: Enter your PIN again |
| <!--{pin2}--> | The system replaces this token with the second input box for the new PIN. |
| <!--{else}--> | If this token is present and a PIN is needed for verification and patron record has a PIN, the system interprets tokens and markup between this token and the closing <!--{xif}--> token. |
| <!--{pininstructions}--> | The system replaces this token with the Example for PIN option listed as part of the Patron self-identification prompts & examples OPAC option. |
| <!--{pinprompt}--> | The system replaces this token with the Prompt for PIN option listed as part of the Patron self-identification prompts & examples OPAC option |
| <!--{pin}--> | The system replaces this token with the input for the patron's PIN. |
| <!--{xif}--> | Closes the <!--{iferrmsgisPIN}--> block |
| <!--{xif}--> | Closes the <!--{ifneedspin}--> block |
| <!--{xif}--> | Closes the <!--{ifneedpatronverify}--> block |
| <!--{ifextpat}--> | If this token is present and the External Patron Verification option has an entry for the port serving this file, the system interprets tokens and markup between this token and its closing <!--{xif}--> token. |
| <!--{extpatid}--> | The system replaces this token with the External Patron Verification ID text box. |
| <!--{extpatpw}--> | The system replaces this token with the External Patron Verification password text box. |
| <!--{xif}--> | Closes the block. |
| <!--{ifalternate_id}--> | If this token is present, and the HAS_ALTERNATE_ID Web option is set to true, the system interprets the tokens and displays the content between this token and its closing <!--{xif}--> token |
| <!--{user_name}--> | The system replaces this token with the textbox prompt for the patron's alternate ID. This input accepts a maximum of 25 characters. |
| <!--{xif}--> | Closes the <!--{ifalternate_id}--> block. |
| <!--{subill}--> | The system replaces this token with a Submit button. |
| <!--{illscope}--> | If this token is present, the system retains the scope of the search session when the ill form is loaded. The form will not work on scoped systems without this token. |
| </form> | This HTML tag closes the HTML form and is required. |
You can create separate custom forms for each combination of language, scope, and patron type by using the following naming convention:
illbook_LANG_s#_p#.html
illchapter_LANG_s#_p#.html
illdissert_LANG_s#_p#.html
illgov_LANG_s#_p#.html
illjournal_LANG_s#_p#.html
illconf_LANG_s#_p#.html
illreport_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 current examples of these forms, see the appropriate example set in WebPAC Example Sets and Photoshop Files on CSDirect.