Koha/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/enhanced_content.pref
Nick Clemens 96adab7af8 Bug 22030: Use preference to determine username sent to overdrive
Overdrive configuration generally defaults to cardnumber, however, they
have confirmed that some libraries use usernames. We need to allow for
both scenarios.

To test:
1 - Have an OverDrive account setup with SIP authentication
    Note: You can apply for a testing account at developer.overdrive.com
    and setup an environment
2 - Fill in all your OverDrive system preferences
3 - Test with a patron whose username is their cardnumber
4 - Confirm their overdrive account tab on opac loads
5 - Change the username to be another value like "borked_wont_work"
6 - Note the overdrive account tab won't load
7 - Apply patch, update database, not new system preference
OverDriveUsername (default to 'cardnumber)
8 - Note the OD account loads successfully
9 - Change the system preference to 'user name' - the account load fails

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
2019-01-08 13:59:46 +00:00

453 lines
17 KiB
Text
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Enhanced Content:
Adlibris:
-
- <strong>NOTE:</strong> Using resources such as external images might leak sensitive data to third parties.
-
- pref: AdlibrisCoversEnabled
default: 0
choices:
no: "Don't show"
yes: "Show"
- cover images in OPAC results and detail listing from Swedish retailer <a href="https://www.adlibris.com/se">Adlibris</a>.
-
- Use base URL:
- pref: AdlibrisCoversURL
class: url
default: "http://www.adlibris.com/se/organisationer/showimagesafe.aspx"
- for the <a href="https://www.adlibris.com/se">Adlibris</a> cover service.
All:
-
- <strong>NOTE:</strong> you can only choose one source of cover images from below, otherwise Koha will show the images from all sources selected.
-
- pref: FRBRizeEditions
default: 0
choices:
yes: Show
no: "Don't show"
- other editions of an item on the staff client (if found by one of the services below).
-
- pref: OPACFRBRizeEditions
default: 0
choices:
yes: Show
no: "Don't show"
- other editions of an item on the OPAC.
Amazon:
-
- Use Amazon data from its
- pref: AmazonLocale
choices:
US: American
CA: Canadian
DE: German
FR: French
IN: Indian
JP: Japanese
UK: British
- website.
-
- Put the associate tag
- pref: AmazonAssocTag
- on links to Amazon. This can net your library referral fees if a patron decides to buy an item.
-
- pref: AmazonCoverImages
default: 1
choices:
yes: Show
no: "Don't show"
- cover images from Amazon on search results and item detail pages on the staff interface.
-
- pref: OPACAmazonCoverImages
default: 1
choices:
yes: Show
no: "Don't show"
- cover images from Amazon on search results and item detail pages on the OPAC.
Babelthèque:
-
- pref: Babeltheque
choices:
yes: Do
no: "Don't"
- include information (such as reviews and citations) from Babelthèque in item detail pages on the OPAC.
-
- pref: Babeltheque_url_js
- Defined the url for the Babeltheque javascript file (eg. http://www.babeltheque.com/bw_XX.js)
-
- pref: Babeltheque_url_update
- Defined the url for the Babeltheque update periodically (eq. http://www.babeltheque.com/.../file.csv.bz2).
Baker and Taylor:
-
- pref: BakerTaylorEnabled
choices:
yes: Add
no: "Don't add"
- Baker and Taylor links and cover images to the OPAC and staff client. This requires that you have entered in a username and password (which can be seen in image links).
-
- 'Baker and Taylor "My Library Bookstore" links should be accessed at <code>https://'
- pref: BakerTaylorBookstoreURL
class: url
- <em>isbn</em></code> (this should be filled in with something like <code>ocls.mylibrarybookstore.com/MLB/actions/searchHandler.do?nextPage=bookDetails&amp;parentNum=10923&amp;key=</code>). Leave it blank to disable these links.
-
- Access Baker and Taylor using username
- pref: BakerTaylorUsername
class: password
- and password
- pref: BakerTaylorPassword
class: password
- .
Novelist Select:
-
- pref: NovelistSelectEnabled
choices:
yes: Add
no: "Don't add"
- Novelist Select content to the OPAC (requires that you have entered in a user profile and password, which can be seen in image links).
-
- Display Novelist Select content
- pref: NovelistSelectView
choices:
tab: in an OPAC tab
above: above the holdings table
below: below the holdings table
right: under the Save Record dropdown, on the right
- .
-
- Access Novelist Select using user profile
- pref: NovelistSelectProfile
- on the opac
-
- Access Novelist Select using user profile
- pref: NovelistSelectStaffProfile
- on the staff client
-
- Access Novelist Select using password
- pref: NovelistSelectPassword
class: password
- .
-
- pref: NovelistSelectStaffEnabled
choices:
yes: Add
no: "Don't add"
- Novelist Select content to the Staff client (requires that you have entered in a user profile and password, which can be seen in image links).
-
- Display Novelist Select staff content
- pref: NovelistSelectStaffView
choices:
tab: in a tab
above: above the holdings table
below: below the holdings table
- .
Google:
-
- pref: GoogleJackets
choices:
yes: Add
no: "Don't add"
- cover images from Google Books to search results and item detail pages on the OPAC.
Open Library:
-
- pref: OpenLibraryCovers
choices:
yes: Add
no: "Don't add"
- cover images from Open Library to search results and item detail pages on the OPAC.
-
- pref: OpenLibrarySearch
choices:
yes: Show
no: "Don't show"
- search results from Open Library on the OPAC.
Library Thing:
# Awkward syntax below, due to quoting conflicts
-
- pref: ThingISBN
choices:
yes: Use
no: "Don't use"
- the ThingISBN service to show other editions of a title (when either FRBRizeEditions or OPACFRBRizeEditions is on). This is separate from Library Thing for Libraries.
-
- pref: LibraryThingForLibrariesEnabled
choices:
yes: Show
no: "Don't show"
- "reviews, similar items, and tags from Library Thing for Libraries on item detail pages on the OPAC. If you've enabled this, you need to "
- <a href="https://www.librarything.com/forlibraries/">sign up</a>, then enter in your ID below.
-
- Access Library Thing for Libraries using the customer ID
- pref: LibraryThingForLibrariesID
- .
-
- Show Library Thing for Libraries content
- pref: LibraryThingForLibrariesTabbedView
choices:
yes: in tabs.
no: in line with the bibliographic information.
IDreamLibraries:
-
- pref: IDreamBooksReviews
choices:
yes: Add
no: "Don't add"
- a tab on the OPAC details with book reviews from critics aggregated by <a href='https://idreambooks.com/'>IDreamBooks.com</a>.
-
- pref: IDreamBooksReadometer
choices:
yes: Add
no: "Don't add"
- a "Readometer" that summarizes the reviews gathered by <a href='https://idreambooks.com/'>IDreamBooks.com</a> to the OPAC details page.
-
- pref: IDreamBooksResults
choices:
yes: Add
no: "Don't add"
- the rating from <a href='https://idreambooks.com/'>IDreamBooks.com</a> to OPAC search results.
Syndetics:
-
- pref: SyndeticsEnabled
choices:
yes: Use
no: "Don't use"
- content from Syndetics. Note that this requires that you have signed up for the service and entered in your client code below.
-
- Use the client code
- pref: SyndeticsClientCode
- to access Syndetics.
-
- pref: SyndeticsCoverImages
choices:
yes: Show
no: "Don't show"
- cover images from Syndetics on search results and item detail pages on the OPAC in a
- pref: SyndeticsCoverImageSize
choices:
MC: medium
LC: large
- size.
-
- pref: SyndeticsAuthorNotes
choices:
yes: Show
no: "Don't show"
- notes about the author of a title from Syndetics on item detail pages on the OPAC.
-
- pref: SyndeticsAwards
choices:
yes: Show
no: "Don't show"
- information from Syndetics about the awards a title has won on item detail pages on the OPAC.
-
- pref: SyndeticsEditions
choices:
yes: Show
no: "Don't show"
- information about other editions of a title from Syndetics on item detail pages on the OPAC (when OPACFRBRizeEditions is on).
-
- pref: SyndeticsExcerpt
choices:
yes: Show
no: "Don't show"
- excerpts from of a title from Syndetics on item detail pages on the OPAC.
-
- pref: SyndeticsReviews
choices:
yes: Show
no: "Don't show"
- reviews of a title from Syndetics on item detail pages on the OPAC.
-
- pref: SyndeticsSeries
choices:
yes: Show
no: "Don't show"
- "information on other books in a title's series from Syndetics on item detail pages on the OPAC."
-
- pref: SyndeticsSummary
choices:
yes: Show
no: "Don't show"
- a summary of a title from Syndetics on item detail pages on the OPAC.
-
- pref: SyndeticsTOC
choices:
yes: Show
no: "Don't show"
- the table of contents of a title from Syndetics on item detail pages on the OPAC.
Tagging:
-
- pref: TagsEnabled
choices:
yes: Allow
no: "Don't allow"
- patrons and staff to put tags on items.
-
- pref: TagsModeration
choices:
yes: Require
no: "Don't require"
- that tags submitted by patrons be reviewed by a staff member before being shown.
-
- Show
- pref: TagsShowOnList
class: integer
- tags on search results on the OPAC.
-
- pref: TagsInputOnList
choices:
yes: Allow
no: "Don't allow"
- patrons to input tags on search results on the OPAC.
-
- Show
- pref: TagsShowOnDetail
class: integer
- tags on item detail pages on the OPAC.
-
- pref: TagsInputOnDetail
choices:
yes: Allow
no: "Don't allow"
- patrons to input tags on item detail pages on the OPAC.
-
- Allow tags in the dictionary of the ispell executable
- pref: TagsExternalDictionary
class: file
- on the server to be approved without moderation.
Local Cover Images:
-
- pref: LocalCoverImages
choices:
yes: Display
no: "Don't display"
- local cover images on intranet search and details pages.
-
- pref: OPACLocalCoverImages
choices:
yes: Display
no: "Don't display"
- local cover images on OPAC search and details pages.
-
- pref: AllowMultipleCovers
choices:
yes: Allow
no: "Don't allow"
- multiple images to be attached to each bibliographic record.
HTML5 Media:
-
- Show a tab with a HTML5 media player for files catalogued in field 856
- pref: HTML5MediaEnabled
choices:
not: "not at all."
opac: "in the OPAC."
staff: "in the staff client."
both: "in OPAC and staff client."
-
- Media file extensions
- pref: HTML5MediaExtensions
class: multi
- (separated with |).
-
- pref: HTML5MediaYouTube
choices:
yes: "Embed"
no: "Don't embed"
- YouTube links as videos.
Plugins:
-
- pref: UseKohaPlugins
choices:
yes: Enable
no: "Don't enable"
- the ability to use Koha Plugins. Note, the plugin system must also be enabled in the Koha configuration file to be fully enabled.
OverDrive:
-
- Include OverDrive availability information with the client key
- pref: OverDriveClientKey
- and client secret
- pref: OverDriveClientSecret
- .
-
- "Authenticate using OverDrive website id #"
- pref: OverDriveWebsiteID
- .
-
- "Authenticate using OverDrive Authname"
- pref: OverDriveAuthName
- "(will be used as fallback if individual branch authname not set <a href=\"/cgi-bin/koha/admin/overdrive.pl\">here</a>)."
-
- "Show items from the OverDrive catalog of library #"
- pref: OverDriveLibraryID
- .
-
- pref: OverDriveCirculation
choices:
yes: Enable
no: "Don't enable"
- users to access their OverDrive circulation history, and circulate items.<br />
- Overdrive uses the patron's
- pref: OverDriveUsername
choices:
cardnumber: cardnumber
userid: user name
- for user access to OverDrive. <br />
- A password is
- pref: OverDrivePasswordRequired
choices:
yes: Required
no: Not required
- for user access to OverDrive. <br />
- If you enable access you must have a SIP connection registered with
- OverDrive for patron authentication against Koha
RecordedBooks:
-
- Include RecordedBooks availability information with the client secret
- pref: RecordedBooksClientSecret
- .
-
- Show items from the RecordedBooks catalog of library ID
- pref: RecordedBooksLibraryID
- .
-
- RecordedBooks domain
- pref: RecordedBooksDomain
Coce Cover images cache:
-
- pref: Coce
choices:
yes: Enable
no: "Don't enable"
- a Coce image cache service.
-
- Coce server URL
- pref: CoceHost
class: url
-
- Use the following providers to fetch the covers
- pref: CoceProviders
multiple:
aws: Amazon Web Services
gb: Google Books
ol: Open Library
Manual:
-
- Location of the Koha manual
- pref: KohaManualBaseURL
- You can specify the location of the Koha manual to use. By default it is https://koha-community.org/manual/
- If starts with '/', the value of staffClientBaseURL will be used as a prefix.
- Note that it will be suffixed by the version / the language / the format (/17.11/en/html)
-
- Language of the online manual
- pref: KohaManualLanguage
choices:
en: English
ar: Arabic
cs: Czech
de: German
es: Spanish
fr: French
it: Italian
pt_BR: Portuguese Brazil
tr: Turkish
zh_TW: Chinese Taiwan
- It will be used as a fallback value if the language used by the interface does not have an online manual version.