| Both sides previous revisionPrevious revision | |
| configuration:openurls [2023/10/18 13:12] – [Constructing OpenURLs] demiankatz | configuration:openurls [2023/10/18 13:13] (current) – demiankatz |
|---|
| ====== OpenURLs ====== | ====== OpenURLs ====== |
| |
| VuFind uses [[https://en.wikipedia.org/wiki/OpenURL|OpenURLs]] in two ways: | VuFind® uses [[https://en.wikipedia.org/wiki/OpenURL|OpenURLs]] in two ways: |
| |
| * To embed [[https://en.wikipedia.org/wiki/COinS|COinS]] citations. | * To embed [[https://en.wikipedia.org/wiki/COinS|COinS]] citations. |
| ===== Constructing OpenURLs ===== | ===== Constructing OpenURLs ===== |
| |
| VuFind's OpenURL construction logic is controlled by [[development:plugins:record_drivers|record drivers]], so it is possible to build different OpenURLs in different contexts. | VuFind®'s OpenURL construction logic is controlled by [[development:plugins:record_drivers|record drivers]], so it is possible to build different OpenURLs in different contexts. |
| |
| ===== Configuring Link Resolvers ===== | ===== Configuring Link Resolvers ===== |
| |
| See the [OpenURL] section of [[.files:config.ini]] for the available settings for interacting with link resolvers. VuFind can operate in a simple mode where OpenURLs are linked to an external link resolver, and it also supports an "embedded" mode for certain resolvers in which resolver results can be embedded directly into the VuFind results. To support embedded mode for a new resolver, you can implement a custom [[development:plugins:link_resolver_drivers|link resolver driver]]. | See the [OpenURL] section of [[.files:config.ini]] for the available settings for interacting with link resolvers. VuFind® can operate in a simple mode where OpenURLs are linked to an external link resolver, and it also supports an "embedded" mode for certain resolvers in which resolver results can be embedded directly into the VuFind® results. To support embedded mode for a new resolver, you can implement a custom [[development:plugins:link_resolver_drivers|link resolver driver]]. |
| |
| ===== Configuring OpenURL Visibility ===== | ===== Configuring OpenURL Visibility ===== |
| Sometimes it is only appropriate to display OpenURL links under specific circumstances. | Sometimes it is only appropriate to display OpenURL links under specific circumstances. |
| |
| There is a [[.files:config.ini]] setting to control which areas of VuFind display OpenURL links. | There is a [[.files:config.ini]] setting to control which areas of VuFind® display OpenURL links. |
| |
| Custom [[development:plugins:record_drivers|record driver]] code can be used to control whether or not specific types of records provide OpenURLs. | Custom [[development:plugins:record_drivers|record driver]] code can be used to control whether or not specific types of records provide OpenURLs. |
| ==== Defining OpenURL Rules ==== | ==== Defining OpenURL Rules ==== |
| |
| //Starting with VuFind 2.5, there is also a JSON-based configuration file to set criteria for OpenURL visibility based on record attributes, allowing more configurability with less need for code customization.// | //Starting with VuFind® 2.5, there is also a JSON-based configuration file to set criteria for OpenURL visibility based on record attributes, allowing more configurability with less need for code customization.// |
| |
| If you want to define that OpenURLs are only enabled for certain records you can do so by adding rules to ''$VUFIND_LOCAL_DIR/config/vufind/OpenUrlRules.json'' in [[http://www.w3schools.com/json/json_syntax.asp|json format]]. | If you want to define that OpenURLs are only enabled for certain records you can do so by adding rules to ''$VUFIND_LOCAL_DIR/config/vufind/OpenUrlRules.json'' in [[http://www.w3schools.com/json/json_syntax.asp|json format]]. |
