About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

VuFind Documentation

Site Tools

You are here: start » development » plugins » ils_drivers
Trace:
Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:plugins:ils_drivers

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
development:plugins:ils_drivers [2021/08/26 11:56] – Add and update help text settings, fix available fields in updateFields emaijaladevelopment:plugins:ils_drivers [2021/10/06 14:02] – demiankatz
Line 174: Line 174:
       * itemLimit (optional, deprecated) - This setting was used here in VuFind 6.0.x; it was moved to Holdings (see above) with release 6.1, but is still supported here for backward compatibility.       * itemLimit (optional, deprecated) - This setting was used here in VuFind 6.0.x; it was moved to Holdings (see above) with release 6.1, but is still supported here for backward compatibility.
       * helpText - A generic help text displayed on the hold request form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped.       * helpText - A generic help text displayed on the hold request form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped.
-      * helpText[lng] - A language-specific help text displayed on the hold request form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped. +      * helpText[*] - (From VuFind 8.0) A default help text displayed on the hold request form if not overridden. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. 
-      * updateHelpText - (From VuFind 8.0) A generic help text displayed on the hold update form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped. +      * helpText[lng] - A language-specific help text displayed on the hold request form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. 
-      * updateHelpText[lng] - (From VuFind 8.0) A language-specific help text displayed on the hold update form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped.+      * updateHelpText[*] - (From VuFind 8.0) A default help text displayed on the hold update form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. 
 +      * updateHelpText[lng] - (From VuFind 8.0) A language-specific help text displayed on the hold update form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped.
       * updateFields (optional) - (From VuFind 8.0) A colon-separated list of form fields to include in the update holds form; may include "frozen", "frozenThrough", "startDate", "requiredByDate" and "pickUpLocation".  Note that all parameters activated here must be processed by the updateHolds method.       * updateFields (optional) - (From VuFind 8.0) A colon-separated list of form fields to include in the update holds form; may include "frozen", "frozenThrough", "startDate", "requiredByDate" and "pickUpLocation".  Note that all parameters activated here must be processed by the updateHolds method.
    
Line 187: Line 188:
       * defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days:months:years (e.g. 0:1:0 will set a "not required after" date of 1 month from the current date).       * defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days:months:years (e.g. 0:1:0 will set a "not required after" date of 1 month from the current date).
         * This only applies if extraFields includes "requiredByDate."         * This only applies if extraFields includes "requiredByDate."
-      * helpText - A generic help text displayed on the request form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped. +      * helpText - A generic help text displayed on the request form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. 
-      * helpText[lng] - A language-specific help text displayed on the request form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped.+      * helpText[*] - (From VuFind 8.0) A default help text displayed on the request form if not overridden. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. 
 +      * helpText[lng] - A language-specific help text displayed on the request form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped.
  
     * Array keys used for input of "ILLRequests" (from v2.3)     * Array keys used for input of "ILLRequests" (from v2.3)
Line 195: Line 197:
       * defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days:months:years (e.g. 0:1:0 will set a "not required after" date of 1 month from the current date).       * defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days:months:years (e.g. 0:1:0 will set a "not required after" date of 1 month from the current date).
         * This only applies if extraFields includes "requiredByDate."         * This only applies if extraFields includes "requiredByDate."
-      * helpText - A generic help text displayed on the request form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped. +      * helpText - A generic help text displayed on the request form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. 
-      * helpText[lng] - A language-specific help text displayed on the request form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped.+      * helpText[*] - (From VuFind 8.0) A default help text displayed on the request form if not overridden. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. 
 +      * helpText[lng] - A language-specific help text displayed on the request form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped.
  
     * Array keys used for input of "changePassword" (from v2.4)     * Array keys used for input of "changePassword" (from v2.4)
Line 730: Line 733:
   * [[http://blog.library.villanova.edu/libtech/2011/06/02/expanded-ils-functionality-in-vufind/|Expanded ILS Functionality in VuFind]] -- Blog post providing an overview of how the driver's hold/recall/renewal functionality works.   * [[http://blog.library.villanova.edu/libtech/2011/06/02/expanded-ils-functionality-in-vufind/|Expanded ILS Functionality in VuFind]] -- Blog post providing an overview of how the driver's hold/recall/renewal functionality works.
   * [[configuration:ils:troubleshooting|ILS Driver Troubleshooting]]   * [[configuration:ils:troubleshooting|ILS Driver Troubleshooting]]
 +
 +===== Related Video =====
 +
 +See [[videos:ils_drivers_1|ILS Drivers, Part 1]] for further discussion of ILS drivers.
 ---- struct data ---- ---- struct data ----
 ---- ----
  
development/plugins/ils_drivers.txt · Last modified: 2024/06/13 08:01 by twagener