have search terms highlighted in results you set the
OpacHighlightedWords preference to 'Highlight' then edit the
koha-http.conf for the library that wants this turned off by adding
- 'SetEnv OVERRIDE\_SYSPREF\_OpacHighlightedWords "0"^. After
+ 'SetEnv OVERRIDE\_SYSPREF\_OpacHighlightedWords "0"'. After
restarting the web server that one library will no longer see
highlighted terms. Consult with your system administrator for more
information.
Acquisitions
----------------------------
-*Get there:* More > Administration > Global System Preferences >
+*Get there:* More > Administration > Global system preferences >
Acquisitions
.. _acquisitions-policy-label:
public_note: 975$z
loc: 975$c
+.. _purgesuggestionsolderthan-label:
+
+PurgeSuggestionsOlderThan
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Asks: Keep accepted or rejected purchase suggestions for a period of \_\_\_ days.
+
+ **Important**
+
+ WARNING - Leave this field empty if you don't want to activate this automatic feature.
+
+Description:
+
+- Enter the number of days after which you want to automatically
+ delete accepted or rejected purchase suggestions.
+
+- For example: [30] Sets purgation of suggestions for those older than 30 days.
+
+ **Note**
+
+ This system preference is used when the cronjob purge_suggestions.pl is
+ active and called without a specific number of days.
+
+
.. _uniqueitemfields-label:
UniqueItemFields
barcode can be created in acquisitions which will cause errors later
when checking items in and out.
+.. _useacqframeworkforbibliorecords-label:
+
+UseACQFrameworkForBiblioRecords
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't use
+
+Asks: \_\_\_ the framework 'ACQ' for bibliographic records fields
+
+Values:
+
+- Don't use
+
+- Use
+
+Description:
+
+- This system preference allows you to use the ACQ framework to customize
+ the bibliographic record fields that are shown when ordering from acquisitions
+
.. _printing-label:
Printing
casLogout
^^^^^^^^^^^^^^^^^^^^^^^^^^
-Default: Don't logout
+Asks: Logout of CAS when logging out of Koha: \_\_\_
+
+Default: No
+
+Values:
-Asks: \_\_\_ of CAS when logging out of Koha.
+- No
+
+- Yes
+
+Description:
+
+- CAS single logout means that a user gets logged out not only from the CAS
+ server but also from all visited CAS client applications when logged out
+ in one of them or after reaching a timeout.
+
+ **Note**
+
+ The CAS server has to be set up to allow single logout for this to take
+ effect, otherwise the behavior will remain unchanged
.. _casserverurl-label:
Description:
- This preference controls the default value in the branch pull down
- found at the top of the :ref:`Circulation and Fine
- Rules`.
+ found at the top of the :ref:`Circulation and fines rules`.
.. _defaulttologgedinlibrarynoticesslips-label:
Description:
- This preference allows the system administrator to determine if users
- will be able to set and see an item type icon
+ will be able to set and see an item type icon in
the catalog on both the OPAC and the Staff Client. The images will
display in both the OPAC and the Staff Client/Intranet. If images of
item types are disabled, text labels for item types will still appear
- Set IP address range in the library administration area
- - *Get there:* More > Administration > Basic Parameters > :ref:`Libraries & Groups`
+ - *Get there:* More > Administration > Basic Parameters > :ref:`Libraries <libraries-label>`
Values:
- Used when merging authorities.
- Controls how the indicators of linked authority records affect the
- corresponding biblio indicators. Currently, the default valueis fine-tuned
+ corresponding biblio indicators. Currently, the default value is fine-tuned
for MARC21 and copies the authority indicators for UNIMARC.
-- For example,a MARC21 field 100 in a biblio record should pick its first
+- For example, a MARC21 field 100 in a biblio record should pick its first
indicator from the linked authority record. The second indicator is not
controlled by the authority. This report supports such MARC conventions.
ISBD
^^^^^^^^^^^^^^^^^^^^
-Default: See :ref:`ISBD view configuration
+Default: See `ISBD view configuration
<https://wiki.koha-community.org/wiki/ISBD_view_configuration>` on the wiki.
Asks: Use the following as the ISBD template:
new menu options to the staff cataloging detail pages to allow that
to happen.
+.. _enableadvancedcatalogingeditor-label:
+
+EnableAdvancedCatalogingEditor
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Default: Don't enable
+
+Asks: \_\_\_ the advanced cataloging editor.
+
+Description:
+
+- This preference will allow you to choose between a basic editor and a
+ advanced editor for cataloging.
+
+ **Note**
+
+ This feature does not currently include any support for
+ UNIMARC or NORMARC fixed fields.
+
.. _record-structure-label:
Record Structure
-.. _article-requests-label:
+.. _article-requests-sysprefs-label:
Article Requests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- This preference controls whether or not article requests are allowed to be placed by patrons in the OPAC.
+.. _articlerequestslinkcontrol-label:
+
+ArticleRequestsLinkControl
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Use algorithm to show or hide
+
+Asks: \_\_\_ article request link on search results.
+
+Values:
+
+- Always show
+
+- Use algorithm to show or hide
+
+Description:
+
+- On the OPAC results page, either always show the 'Request article' link
+ or check the branch, patron and item type combination to determine
+ whether or not an article can be requested from this particular record
+ before displaying the link.
+
.. _articlerequestsmandatoryfields-label:
ArticleRequestsMandatoryFields
- Cumulate
+.. _hidepersonalpatrondetailoncirculation-label:
+
+HidePersonalPatronDetailOnCirculation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't
+
+Asks: \_\_\_ hide patrons phone number, email address, street address
+and city in the circulation page
+
+Values:
+
+- Don't
+
+- Do
+
+Description:
+
+- This preference controls the display of the patron's phone number,
+ email address, and physical address from the left side of the screen
+ (under their picture, if they have one).
+
+- Set to 'Do' these informations will only be visible on the patron's
+ detail page.
+
+.. _holdsautofill-label:
+
+HoldsAutoFill
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't
+
+Asks: \_\_\_ automatically fill holds instead of asking the librarian.
+
+Values:
+
+- Do
+
+- Don't
+
+Description:
+
+- If set to 'Do', the holds confirmation pop-up will not appear upon checking
+ in a reserved item.
+
+.. _holdsautofillprintslip-label:
+
+HoldsAutoFillPrintSlip
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't
+
+Asks: \_\_\_ automatically display the holds slip dialog for auto-filled holds.
+
+Values:
+
+- Do
+
+- Don't
+
+Description:
+
+- If set to 'Do', the holds slip print pop-up will appear automatically
+ upon checking in a reserved item.
+
+- :ref:`HoldsAutoFill` must be set to 'do' for this preference to have any
+ effect.
+
.. _updatenotforloanstatusoncheckin-label:
UpdateNotForLoanStatusOnCheckin
- If this preference is set to "Allow" then staff all will be presented
with an option to checkout more items to a patron than are normally
- allowed in the :ref:`Circulation and Fine Rules`. If
+ allowed in the :ref:`Circulation and fines rules`. If
this preference is set to "Don't allow" then no staff member will be
able to check out more than the circulation limit.
MarkLostItemsAsReturned
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Default: Mark
+Default: Disable
Asks: \_\_\_ items as returned when flagged as lost.
Values:
-- Do not mark
+- [Select All]
+
+- From the batch item modification tool
+
+- From the items tab of the catalog module
+
+- From the longoverdue cronjob
-- Mark
+- When cataloging an item
Description:
-- This preference lets you decide if an item marked as lost is automatically returned from the user's file or not.
+- The library can choose which of these actions or all of these actions, does an
+item gets automatically returned from the patron's account or not.
+
.. _maxoutstanding-label:
Description:
- This preference allows you to control how the 'No renewal before"
- option in the :ref:`Circulation and fine rules <circulation-and-fine-rules-label>`
+ option in the :ref:`Circulation and fines rules`
administration area.
.. _noticebcc-label:
The holds will become unsuspended the date after that entered by the
patron.
+.. _canmarkholdstopullaslost-label:
+
+CanMarkHoldsToPullAsLost
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Do not allow to mark items as lost
+
+Asks: \_\_\_ from the 'Holds to pull' screen
+
+Values:
+
+- Allow to mark items as lost
+
+- Allow to mark items as lost and notify the patron
+
+- Do not allow to mark items as lot
+
+Description:
+
+- This preference lets you choose whether the staff can mark items
+ as lost directly from the 'Holds to pull' list if they can't
+ find the item on the shelf.
+
.. _canreservefromotherbranches-label:
canreservefromotherbranches
- Allow
- Don't allow
+
+.. _holdssplitqueue-label:
+
+HoldsSplitQueue
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: nothing
+
+Asks: In the staff client, split the holds queue into separate tables by \_\_\_
+
+Values:
+
+- pickup library
+
+- pickup library & itemtype
+
+- hold itemtype
+
+- nothing
+
+Description:
+
+- This feature allows to separate holds by pickup library or itemtype in the
+ holds page of a record (not in the global holds queue found on the circuation
+ page).
+
+- When using the up and down arrows, the priorities will be changed only in
+ in the group the holds belongs to.
+
+.. _holdssplitqueuenumbering-label:
+
+HoldsSplitQueueNumbering
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: the actual priority, which may be out of order
+
+Asks: If the holds queue is split, show librarians \_\_\_
+
+Values:
+
+- the actual priority, which may be out of order
+
+- 'virtual' priorities, where each group is numbered separately
+
+Description:
+
+- This system preference is only effective if :ref:`HoldsSplitQueue` is set to
+ any value except 'nothing'.
+
+- This system preference controls the priority numbering on the holds page
+ of a record (not in the global holds queue found on the circulation page).
.. _localholdspriority,-localholdsprioritypatroncontrol,-localholdspriorityitemcontrol-label:
Asks: Patron categories not affected by :ref:`OPACHoldsIfAvailableAtPickup`
\_\_\_ (list of patron categories separated with a pipe ^|^)
+Description:
+
+- Patron category codes listed here separated by a pipe ^|^ are unaffected by
+ :ref:`OPACHoldsIfAvailableAtPickup`.
+
.. _reservescontrolbranch-label:
ReservesControlBranch
go. When that system preference set to "Transfer", branch transfers
are created, so the holds may be cancelled.
+.. _updateitemwhenlostfromholdlist-label:
+
+UpdateItemWhenLostFromHoldList
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Asks: Update item's values when marked as lost from the hold to pull screen.
+
+Description:
+
+- This is a list of values to update an item when it is marked as lost from
+ the holds to pull screen. For example, write "itemlost: 1" to set the items.
+ itemlost value to 1 when the item is marked as lost. This will use the authorized
+ value 1 from the LOST authorized value list.
+
.. _housebound-module-label:
Housebound module
Description:
- Enabling this system preference allows staff to scan a patron barcode instead
- of an item barcode in the checkout box to switch patron files.
+ of an item barcode in the checkout box to switch patron records.
.. _circautocompl-label:
allowed to return items through your self check machines. By default
Koha's self check interface is simply for checking items out.
-.. _autoselfcheckallowed,-autoselfcheckid-&-autoselfcheckpass-label:
+.. _autoselfcheckallowed-autoselfcheckid-&-autoselfcheckpass-label:
AutoSelfCheckAllowed, AutoSelfCheckID & AutoSelfCheckPass
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Enabling this preference will allow access to the :ref:`self
checkout <self-checkout-label>` module in Koha.
+Self Checkin
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. _selfcheckinmainuserblock-label:
+
+SelfCheckInMainUserBlock
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Asks: Include the following HTML on the self check-in screen
+
+Description:
+
+- HTML entered in this field will appear in the center of the main page
+ of your self checkin screen
+
+.. _selfscheckinmodule-label:
+
+SelfCheckInModule
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't enable
+
+Asks: \_\_\_ the standalone self check-in module (available at:
+/cgi-bin/koha/sci/sci-main.pl
+
+Values:
+
+- Don't enable
+
+- Enable
+
+Description:
+
+- This system preference will activate (or deactivate) the self check-
+ in module
+
+.. _selfcheckintimeout-label:
+
+SelfCheckInTimeout
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: 120
+
+Asks: Reset the current self check-in screen after \_\_\_ seconds
+
+Description:
+
+- Enter the number of seconds after which you want the self check-in
+ screen to refresh and go back to the main page (for example, if a
+ patron forgot to log out).
+
+.. _selfcheckinusercss-label:
+
+SelfCheckInUserCSS
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Asks: Include the following CSS on all the self check-in screens
+
+Description:
+
+- The CSS code entered here will override any CSS on the self check-in
+ screens
+
+.. _selfcheckinuserjs-label:
+
+SelfCheckInUserJS
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Asks: Include the following JavaScript on all the self check-in screens
+
+Description:
+
+- The JavaScript entered here will override any other JavaScript on
+ the self check-in screens
+
+
.. _enhanced-content-label:
Enhanced Content
cover images to bib records and display them on the detail page and
search results in the OPAC.
+.. _manual-sysprefs-label:
+
+Manual
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. _kohamanualbaseurl-label:
+
+KohaManualBaseURL
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: https://koha-community.org/manual/
+
+Asks: Location of the Koha manual \_\_\_
+
+Description:
+
+- You can specify the location of the Koha manual to use. This is the
+ URL that will be used for the help pages when you click 'Help' at
+ the top right corner of the page.
+
+- By default, the Koha manual is used, but you can use this system
+ preference to substitute for your own help pages.
+
+- If the URL starts with '/', the value of :ref:`staffClientBaseURL`
+ will be used as a prefix.
+
+- Note that it will be suffixed by the version / the language / the
+ format (/17.11/en/html)
+
+.. _kohamanuallanguage-label:
+
+KohaManualLanguage
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: English
+
+Asks: Language of the online manual \ad\_\_\_
+
+Description:
+
+- By default, the language of the Koha interface will be used
+ as the manual language. However, if the manual is not translated
+ in that language, this system preference specifies the fallback
+ language.
+
+
.. _novelist-select-label:
Novelist Select
- under the Save Record dropdown on the right
-.. _oclc-label:
-
-OCLC
-~~~~~~~~~~~~~~~~~~~~~
-
-.. _oclcaffiliateid-label:
-
-OCLCAffiliateID
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Asks: Use the OCLC affiliate ID \_\_\_ to access the xISBN service.
-
-Description:
-
-- This setting is only applicable if the library has an OCLC Affiliate
- ID. This allows WorldCat searching in the OPAC via the XISBN
- programming interface. Simply enter the library's OCLC Affiliate ID
- in the box provided. Please note that using this data is only
- necessary if :ref:`FRBRizeEditions` and/or
- :ref:`OPACFRBRizeEditions` and :ref:`XISBN`
- settings are enabled. For more information on this service please
- visit the OCLC website:
- http://www.worldcat.org/affiliate/default.jsp.
-
- **Important**
-
- Unless you have signed up for an ID with OCLC, you are limited to
- 1000 requests per day. Available at:
- http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
-
-.. _xisbn-label:
-
-XISBN
-^^^^^^^^^^^^^^^^^^
-
-Default: Don't use
-
-Asks: \_\_\_ the OCLC xISBN service to show other editions of a title
-
-Description:
-
-- Set to 'Use' to display an "Editions" tab on the item's detail page.
- Editions are listed, complete with cover art and bibliographic
- information. The feed comes from OCLC's xISBN web service. The feed
- limit for non-commercial sites is 1000 requests per day.
-
-Values:
-
-- Don't use
-
-- Use
-
- **Important**
-
- Requires :ref:`FRBRizeEditions` and/or
- :ref:`OPACFRBRizeEditions` set to 'show'
-
-.. _xisbndailylimit-label:
-
-XISBNDailyLimit
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Default: 999
-
-Asks: Only use the xISBN service \_\_\_ times a day.
-
- **Important**
-
- Unless you have signed up for an ID with OCLC, you are limited to
- 1000 requests per day. Available at:
- http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
-
.. _open-library-label:
Open Library
Default: Don't allow
-Asks: \_\_\_ patrons to select their language on the OPAC.
+Asks: \_\_\_ patrons to change the language they see on the OPAC.
Values:
- Allow
-.. _labs-label:
-
-Labs
----------------------
-
-*Get there:* More > Administration > Global System Preferences > Labs
-
-The preferences in this section are for experimental features that need
-additional testing and debugging.
-
-.. _enableadvancedcatalogingeditor-label:
-
-EnableAdvancedCatalogingEditor
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Default: Don't enable
-
-Asks: \_\_\_ the advanced cataloging editor.
-
-Description:
-
-- This preference will allow you to choose between a basic editor and a
- advanced editor for cataloging.
-
- **Important**
-
- This feature is currently experimental, and may have bugs that cause
- corruption of records. It also does not include any support for
- UNIMARC or NORMARC fixed fields. Please help us test it and report
- any bugs, but do so at your own risk.
-
.. _local-use-label:
Local Use
- Log
+ **Note**
+
+ Enabling this preference allows the tracking of cardnumber changes for patrons
+
.. _cataloguinglog-label:
CataloguingLog
OPAC
---------------------
-*Get there:* More > Administration > Global System Preferences > OPAC
+*Get there:* More > Administration > Global system preferences > OPAC
.. _advanced-search-options-label:
-Advanced Search Options
+Advanced search options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. _opacadvsearchmoreoptions-label:
OpacAdvSearchMoreOptions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Default: Select All
+Default: Select all
Asks: Show search options for the expanded view \_\_\_
- Show
*Get there:* More > Administration > :ref:`Authorized
-Values <authorized-values-label>`
+values <authorized-values-label>`
.. _bibliodefaultview-label:
**Note**
- See the :ref:`XSLT material type icons <_material-type-cataloging-guide-label>`
+ See the :ref:`XSLT material type icons <material-type-cataloging-guide-label>`
for more information on these icons.
.. _googleindictransliteration-label:
|image64|
-.. _nologininstructions-label:
-
-NoLoginInstructions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Asks: Show the following HTML on the OPAC login form when a patron is
-not logged in:
-
-Description:
-
-- This preference allows you to override the default text seen on the
- log in page in the Koha OPAC. The default HTML is:
-
- ::
-
- <h5>Don't have a password yet?</h5>
- <p> If you don't have a password yet, stop by the circulation desk the next time you're in the library. We'll happily set one up for you.</p>
- <h5>Don't have a library card?</h5>
- <p> If you don't have a library card, stop by your local library to sign up.</p>
-
- Any HTML in this box will replace the above text below the log in
- box.
-
- |image1189|
-
.. _opacadditionalstylesheet-label:
OpacAdditionalStylesheet
HTML format. This is static information and any updates must be
entered manually.
-Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
+Learn more in the :ref:`OPAC editable regions <editable-opac-regions-label>` section.
.. _opaccustomsearch-label:
- **Important**
- Not implemented yet
+ Both :ref:`OPACXSLTDetailsDisplay` and
+ :ref:`OPACXSLTResultsDisplay` need to
+ have values in order for this preference to work.
+
+ - **Important**
+
+ This is only implemented for MARC21 and NORMARC.
- Detail page only
:ref:`OPACXSLTDetailsDisplay` needs to
have a value in it for this preference to work.
+ - **Important**
+
+ This is only implemented for MARC21 and NORMARC.
+
|image70|
- Neither details or results page
- **Important**
- Not yet implemented
+ :ref:`OPACXSLTResultsDisplay` needs to
+ have a value in it for this preference to work.
+
+ - **Important**
+
+ This is only implemented for MARC21 and NORMARC.
Description:
|image1192|
-Asks: List export options that should be available from OPAC detail page
-: \_\_\_
+Asks: Select export options that should be available from OPAC detail
+page: \_\_\_
Description:
Description:
-- This preference has no use right now, as Koha has only one theme, but
- if your library has a custom theme it will show here as an option.
- The purpose of this preference is to provide a way to choose to what
+- The purpose of this preference is to provide a way to choose to what
theme to fallback on when you have a partial theme in place.
.. _opacfavicon-label:
Edit ^:ref:`LibraryName`^ if you'd like to edit the
contents of the <title> tag
-Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
+Learn more in the :ref:`OPAC editable regions <editable-opac-regions-label>` section.
.. _opachighlightedwords-&-nothighlightedwords-label:
- Defines where the shelving location should be displayed, under the
home library, the holding library, or both, or in a separate column.
+.. _opaclogininstructions-label:
+
+OpacLoginInstructions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Asks: Show the following HTML on the OPAC login form when a patron is not logged in:
+
+Description:
+
+- HTML entered in this field will appear under the login form on the main page
+ of your OPAC, when the user is not logged in
+
+|image1344|
+
+Learn more in the :ref:`OPAC editable regions <editable-opac-regions-label>` section.
+
+
.. _opacmaintenance-label:
OpacMaintenance
|image77|
-Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
+Learn more in the :ref:`OPAC editable regions <editable-opac-regions-label>` section.
.. _opacmaxitemstodisplay-label:
OPACMySummaryHTML
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Asks: Include a "Links" column on the "my summary" tab when a user is
+Asks: Include a "Links" column on the "your summary" tab when a user is
logged in to the OPAC, with the following HTML (leave blank to disable).
Description:
- In this preference you can enter HTML that will appear on the
- 'Checked Out' tab on the 'My Summary' section when logged in to the
+ 'Checked Out' tab on the 'your summary' section when logged in to the
OPAC. The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR}
will be replaced with information from the displayed record. This can
be used to enter in 'share' links for social networks or generate
- This preference will display text above the patron's summary and
below the welcome message when the patron logs in to the OPAC and
- view their 'my summary' tab.
+ view their 'your summary' tab.
|image1193|
|image79|
-Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
+Learn more in the :ref:`OPAC editable regions <editable-opac-regions-label>` section.
.. _opacnavbottom-label:
and patron account on the OPAC, after :ref:`OpacNav`, and before
patron account links if available:
-Description: When a patron is logged in to their account they see a
-series of tabs to access their account information.
-:ref:`OpacNav` appears above this list of tabs and OpacNavBottom
-will appear below them. When not on the patron account pages the HTML in
-OpacNavBottom will just appear right below :ref:`OpacNav`.
+Description:
+
+- When a patron is logged in to their account they see a
+ series of tabs to access their account information.
+ :ref:`OpacNav` appears above this list of tabs and OpacNavBottom
+ will appear below them. When not on the patron account pages the HTML in
+ OpacNavBottom will just appear right below :ref:`OpacNav`.
|image80|
Asks: Show the following HTML in the right hand column of the main page
under the main login form.
-Description: HTML entered in this preference will appear on the right
-hand side of the OPAC under the log in form. If the log in form is not
-visible this content will move up on the right column.
+Description:
+
+- HTML entered in this preference will appear on the right
+ hand side of the OPAC under the log in form. If the log in form is not
+ visible this content will move up on the right column.
|image81|
Description:
- If you're :ref:`allowing patrons to make purchase
- suggestions <suggestion-label>` then they will see the 'my
+ suggestions <suggestion-label>` then they will see the 'your purchase
suggestions' tab when logged in. This tab shows the patron the
librarian who approved or rejected the purchase suggestion. This
preference controls if the patron sees the librarian's name or not.
Description:
- This preference allows the user to temporarily save a list of items
- found on the catalog. By using the Book Bag, or Cart, the user can
+ found on the catalog. By using the book bag, or cart, the user can
print out or email a list of items found. The user does not need to
be logged in. This list is temporary and will be emptied, or cleared,
at the end of the session.
**Important**
- run the :ref:`Authorities Browser Cron Job <authorities-browser-label>` to
+ run the :ref:`authorities browser cron job <authorities-browser-label>` to
create the browser list
.. _opacbrowseresults-label:
**Important**
- run the :ref:`Authorities Browser Cron Job <authorities-browser-label>` to
+ run the :ref:`authorities browser cron job <authorities-browser-label>` to
create the browser list
.. _opacfinestab-label:
Default: Allow
-Asks: \_\_\_ patrons to access the Fines tab on the My Account page on
+Asks: \_\_\_ patrons to access the Fines tab on the 'your summary' page on
the OPAC.
Values:
OPACISBD
^^^^^^^^^^^^^^^^^^^^^^^^
-Default: See :ref:`ISBD view configuration
+Default: See `ISBD view configuration
<https://wiki.koha-community.org/wiki/ISBD_view_configuration>` on the wiki.
Asks: Use the following as the OPAC ISBD template:
Default: call number only
-Asks: Show \_\_\_\_ for items on the OPAC search results.
+Asks: Show \_\_\_ for items on the OPAC search results.
Values:
- This feature will allow you to enter a series of quotes that will
then show on the OPAC homepage in random order. To add/edit quotes,
- visit the :ref:`Quote of the Day Editor <quote-of-the-day-(qotd)-editor-label>` under Tools.
+ visit the :ref:`Quote of the Day editor <quote-of-the-day-(qotd)-editor-label>` under Tools.
.. _requestonopac-label:
EnablePayPalOpacPayments & PayPalSandboxMode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-EnablePayPalOpacPayments Default: Don't all
+EnablePayPalOpacPayments Default: Don't allow
PayPalSandboxMode Default: Sandbox
Description
- This preference controls what the patron will see on their PayPal
- account/Bank account for this charge.
+ account/bank account for this charge.
.. _paypalpwd-label:
Description:
- The default privacy setting for each patron category can be set in
- the :ref:`Patrons Categories <patron-categories-label>` area. If you set this
+ the :ref:`patrons categories <patron-categories-label>` area. If you set this
preference to 'allow' then patrons can change that for themselves via
the OPAC.
Enabling this will make it so that patrons can view their
circulation history in the OPAC unless you have
- :ref:`OPACPrivacy` set to 'Allow.^
+ :ref:`OPACPrivacy` set to 'Allow'.
**Important**
Description:
-- You can enter individual IPS as a comma separated list (ex:
+- You can enter individual IPs as a comma separated list (ex:
'127.0.0,127.0.1') or just the beginning of the IP range allowed (ex:
'127.0.^)
Description:
- Setting this preference to 'Allow' will provide a link on the OPAC to
- register for a new account. Using the other :ref:`Self
- Registration <self-registration-label>` system preferences you
+ register for a new account. Using the other :ref:`self
+ registration <self-registration-label>` system preferences you
can control how this preference will function.
|image103|
(or both) is set, a button labeled "Quick add new patron" will be displayed
in the "Patrons" toolbar.
- **Note**
-
- If either :ref:`PatronQuickAddFields` or :ref:`BorrowerMandatoryField`
- (or both) is set, a button labeled "Quick add new patron" will be displayed
- in the "Patrons" toolbar.
-
.. _borrowerrelationship-label:
borrowerRelationship
:ref:`BorrowerMandatoryField` list, the
minimum length, if not specified here, defaults to one.
-.. _checkdigit-label:
-
-checkdigit
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Default: Don't
-
-Asks: \_\_\_ check and construct borrower card numbers in the Katipo
-style.
-
-Values:
-
-- Do
-
-- Don't
-
- **Important**
-
- This overrides :ref:`autoMemberNum` if on.
-
.. _checkprevcheckout-label:
CheckPrevCheckout
Description:
-When the value of this system preference is set to 'do', Koha will look at the
-patron's circulation history to see if they have checked this item out before.
-An alert will show up on the screen indicating that patron has indeed checked
-this item out. Staff will be prompted to allow the checkout to occur.
-If the vaulue is set to 'don't', Koha will not check the patron's circulation
-history. When the value is set to 'Unless overridden, do', this will check the
-patron's circulation history even if there are fines, fees, and/or holds on the
-patron's account. Lastly, if the value is set to 'Unless overridden, don't',
-Koha will not check circulation history regardless of fines, fees, and/or holds.
+- When the value of this system preference is set to 'do', Koha will look at the
+ patron's circulation history to see if they have checked this item out before.
+ An alert will show up on the screen indicating that patron has indeed checked
+ this item out. Staff will be prompted to allow the checkout to occur.
+
+ |image1390|
+
+- If the value is set to 'do not', Koha will not check the patron's circulation
+ history.
+
+- When the value is set to 'Unless overridden, do', this will check the
+ patron's circulation history unless the patron's :ref:`personal setting
+ <add-a-new-patron>` or the :ref:`patron category setting <adding-a-patron-category>`
+ specifically say not to.
+
+- Lastly, if the value is set to 'Unless overridden, do not',
+ Koha will not check circulation history unless the patron's :ref:`personal
+ setting <add-a-new-patron>` or the :ref:`patron category setting <adding-a-
+ patron-category>` specifically say to check.
**Note**
Default: Allow
-Asks: \_\_\_ staff to access a patron's checkout history.
+Asks: \_\_\_ staff to access a patron's checkout and hold history.
**Important**
Reading history is still stored, regardless of staff being allowed
access or not unless the patron has chosen to have their history
- anonymized via their :ref:`privacy page <my-privacy-label>`.
+ anonymized via their :ref:`privacy page <your-privacy-label>`.
.. _maxfine-label:
as well, individual fields in that form will be ignored.
**Note**
+
+ See the :ref:`database schema (borrowers table) <http://schema.koha-
+ community.org/>`_ to know the field names.
+
+ **Note**
If either :ref:`PatronQuickAddFields` or :ref:`BorrowerMandatoryField`
(or both) is set, a button labeled "Quick add new patron" will be displayed
in the "Patrons" toolbar.
+ **Note**
+
+ It is possible to add custom :ref:`patron attributes <patron-attribute-types-
+ label>` in the quick add form with the following syntax: patron_attr_N
+ (for example patron_attr_2). The N refers to the id of the attribute and
+ requires a bit of guesswork (normally it will be the order in which you
+ entered them in the :ref:`patron attribute types section of the administration
+ module <patron-attribute-types-label>`).
+
+
.. _patronsperpage-label:
PatronsPerPage
- This preference will let you define how many patrons to show on
patron search results pages.
+ProtectSuperLibrarianPrivileges
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Allow only superlibrarians
+
+Asks: \_\_\_ to access/change superlibrarian privileges. Note: A permitted user
+ needs to have the 'permissions' flag (if no superlibrarian)
+
+Values:
+
+- Allow all permitted users
+
+- Allow only superlibrarians
+
.. _requirestrongpassword-label:
RequireStrongPassword
Asks: Use the SMS::Send:: \_\_\_ driver to send SMS messages. Define a
username/login \_\_\_ and a password \_\_\_.
+ **Note**
+
+ This may not work with all providers.
+
**Important**
Please refer to your national laws concerning the sending of bulk
- Do
- Don't
+
+.. _useemailreceipts-label:
+
+UseEmailReceipts
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Don't send
+
+Asks: \_\_\_ email receipts to patrons for payments and writeoffs.
+
+Values:
+
+- Don't send
+
+- Send
+
+Description:
+
+- If set to 'Send', Koha will send emails to the patrons for each
+ payment or writeoff done in their account.
+
+ **Note**
+
+ - The letters used are ACCOUNT\_PAYMENT and ACCOUNT\_WRITEOFF
+
+ - You can edit them in the :ref:`Notices and slips<notices-&-slips-label>`
+ tool.
.. _usedischarge-label:
- Enable
+Description:
+
+- Enabling this system preference makes a button appear in the intranet search
+ results page to browse the selected records.
.. _enablesearchhistory-label:
defaultSortOrder Default: ascending
Asks: By default, sort search results in the staff client by \_\_\_,
-\_\_\_\_
+\_\_\_
Description:
Default: Don't show
-Asks: \_\_\_ an item's branch, location and call number in OPAC search
+Asks: \_\_\_ an item's library, location and call number in OPAC search results.
results.
Values:
.. _staff-client-label:
-Staff Client
+Staff client
------------------------------
-*Get there:* More > Administration > Global System Preferences > Staff
-Client
+*Get there:* More > Administration > Global system preferences > Staff
+client
.. _staffappearance-label:
- **Important**
- Not implemented yet
+ Both :ref:`XSLTDetailsDisplay` and
+ :ref:`XSLTResultsDisplay` need to
+ have values in order for this preference to work.
+
+ - **Important**
+
+ This is only implemented for MARC21.
- Detail page only
- **Important**
- :ref:`XSLTDetailsDisplay` needs to be on
- for this preference to work.
+ :ref:`XSLTDetailsDisplay` needs to
+ have a value in it for this preference to work.
+
+ - **Important**
+
+ This is only implemented for MARC21 and UNIMARC.
|image113|
- **Important**
- Not yet implemented
+ :ref:`XSLTResultsDisplay` needs to
+ have a value in it for this preference to work.
+
+ - **Important**
+
+ This is only implemented for MARC21 and NORMARC.
Description:
the field. When all of the requirements are met, an image file will
be displayed instead of the standard link text. Clicking on the image
will open it in the same way as clicking on the link text. When you
- click on the image it should open to full size, in the current window
- or in a new window depending on the value in the system pref
- :ref:`OPACURLOpenInNewWindow`.
+ click on the image it should open to full size, in the current window.
|image114|
**Note**
- See the :ref:`XSLT material type icons <_material-type-cataloging-guide-label>`
+ See the :ref:`XSLT material type icons <material-type-cataloging-guide-label>`
for more information on these icons.
.. _intranet\_includes-label:
Description:
- This preference is used to set the background color and style of the
- Staff Client. The value is a .css file. The system administrator
+ staff client. The value is a .css file. The system administrator
should determine which file is appropriate. Enter just a filename, a
full local path or a complete URL starting with http:// (if the file
lives on a remote server). Please note that if you just enter a
IntranetFavicon
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Asks: Use the image at \_\_\_ for the Staff Client's favicon.
+Asks: Use the image at \_\_\_ for the staff client's favicon.
**Important**
Description:
- This preference allows the administrator to enter JavaScript or
- JQuery that will be embedded across all pages of the Staff Client.
+ JQuery that will be embedded across all pages of the staff client.
Administrators may use this preference to customize some of the
interactive sections of Koha, customizing the text for the login
prompts, for example. Sample JQuery scripts used by Koha libraries
staffClientBaseURL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Asks: The staff client is located at http:// \_\_\_
+Asks: The staff client is located at \_\_\_
+
+ **Important**
+
+ This should be a complete URL, starting with http:// or https://.
+ Do not include a trailing slash in the URL.
+
+ **Note**
+
+ This must be filled in correctly for CAS, svc, and load_testing to work.
.. _stafflangselectormode-label:
- top
+.. _stafflogininstructions-label:
+
+StaffLoginInstructions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Asks: Show the following HTML on the staff client login page
+
+Description:
+
+- HTML entered in this field will appear above the login form
+ of your staff client
+
+|image1345|
+
.. _template-label:
template
.. _web-services-label:
-Web Services
+Web services
-----------------------------------
-*Get there:* More > Administration > Global System Preferences > Web
-Services
+*Get there:* More > Administration > Global system preferences > Web
+services
.. _ils-di-label:
ILS-DI:AuthorizedIPs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Asks: \_\_\_ allowed IPs to use the ILS-DI services
+Asks: Allow IP addresses \_\_\_ to use the ILS-DI services (when enabled).
+
+ **Note**
+
+ Separate the IP addresses with commas and without spaces.
+ For example: 15.78.193.62,197.85.10.1
+
+ **Important**
+
+ Leave the field blank to allow any IP address.
.. _idref-pref-label:
harvest the entire records while the ListIdentifier is an abbreviated
form of ListRecords, retrieving only headers rather than records.
+.. _rest-api-prefs-label:
+
+REST API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. _restdefaultpagesize-label:
+
+RESTdefaultPageSize
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: 20
+
+Asks: Set the default number of results returned by the REST API endpoints
+to \_\_\_ per page.
+
+Description:
+
+- This preference lets you choose the number of results per page you want
+
+.. _restoauth2clientcredentials-label:
+
+RESTOAuth2ClientCredentials
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: Disable
+
+Asks: \_\_\_ the OAuth2 client credentials grant for the REST API.
+
+ **Note**
+
+ Requires Net::OAuth2::AuthorizationServer installed.
+
+ **Important**
+
+ This system preference is experimental.
+
.. _reporting-label:
Reporting
projects / kohadocs.git / blobdiff