Merge branch 'manual18.05.x' into 'master'
[kohadocs.git] / source / systempreferences.rst
index 6c4e808..d01b6c7 100644 (file)
@@ -49,7 +49,7 @@ follow they will all read USD for U.S. Dollars.
     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.
@@ -1242,10 +1242,10 @@ Description:
 -  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.
 
@@ -2606,6 +2606,28 @@ Description:
 
 -  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
@@ -2828,6 +2850,74 @@ Values:
 
 -  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
@@ -4663,6 +4753,57 @@ Values:
 -  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:
 
@@ -6746,6 +6887,52 @@ Description:
    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
@@ -7725,7 +7912,7 @@ opaclanguagesdisplay
 
 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:
 
@@ -8549,7 +8736,13 @@ Values:
 
    -  **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
 
@@ -8558,6 +8751,10 @@ Values:
           :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
@@ -8566,7 +8763,12 @@ Values:
 
    -  **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:
 
@@ -8592,8 +8794,8 @@ Default:
 
     |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:
 
@@ -9746,7 +9948,7 @@ OpacItemLocation
 
 Default: call number only
 
-Asks: Show \_\_\_\_ for items on the OPAC search results.
+Asks: Show \_\_\_ for items on the OPAC search results.
 
 Values:
 
@@ -11287,12 +11489,6 @@ Description:
     (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
@@ -11420,15 +11616,25 @@ Values:
 
 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**
 
@@ -11614,7 +11820,7 @@ intranetreadinghistory
 
 Default: Allow
 
-Asks: \_\_\_ staff to access a patron's checkout history.
+Asks: \_\_\_ staff to access a patron's checkout and hold history.
 
     **Important**
 
@@ -11745,10 +11951,25 @@ and fields specified here. If applicable, the guarantor form will be shown
 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
@@ -11804,6 +12025,10 @@ SMSSendDriver, SMSSendUsername, and SMSSendPassword
 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
@@ -11922,6 +12147,33 @@ Values:
 -  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:
 
@@ -12358,7 +12610,7 @@ defaultSortField Default: author
 defaultSortOrder Default: ascending
 
 Asks: By default, sort search results in the staff client by \_\_\_,
-\_\_\_\_
+\_\_\_
 
 Description:
 
@@ -12583,7 +12835,7 @@ OPACItemsResultsDisplay
 
 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:
@@ -13011,14 +13263,24 @@ Values:
 
    -  **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|
 
@@ -13028,7 +13290,12 @@ Values:
 
    -  **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:
 
@@ -13039,9 +13306,7 @@ 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|
 
@@ -13252,7 +13517,16 @@ Description:
 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: