Update tools.rst
[kohadocs.git] / source / tools.rst
index 7dc0ae3..163d1db 100644 (file)
@@ -19,7 +19,7 @@ Patrons and Circulation
 Patron lists
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
--  *Get there:* More > Tools > Patrons and Circulation > Patron lists
+-  *Get there:* More > Tools > Patrons and circulation > Patron lists
 
 Patron lists are a way to store a group of patrons for easy modification
 via the :ref:`batch patron modification tool <batch-patron-modification-label>` or
@@ -47,6 +47,9 @@ menu.
 Enter the patron's name or cardnumber in the search box and click on the
 right result to add the patron.
 
+Alternatively, you can click on the 'Enter multiple card numbers' link and 
+scan (or type in) barcodes in the box.
+
 |image249|
 
 Once you have all of the patrons you would like to add you can click the
@@ -291,9 +294,9 @@ If you have a style you'd like applied to all slips you can point the
 notices, using the :ref:`NoticeCSS` preference to define a
 stylesheet.
 
-You will also want to review the :ref:`Notices & Slips Field
-Guide <field-guide-for-notices-&-slips-label>` for more information on formatting these
-notices.
+You will also want to review the `Customising Notices and Slips
+<https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_ 
+wiki page for more information on formatting these notices.
 
 .. _adding-notices-&-slips-label:
 
@@ -311,8 +314,8 @@ To add a new notice or slip
    -  **Important**
 
           Not all notices can be branch specific for more information
-          review the :ref:`Notices & Slips Field
-          Guide <field-guide-for-notices-&-slips-label>` in this manual.
+          review the `Customising Notices and Slips <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_ 
+          wiki page.
 
 -  Choose the module this notice is related to
 
@@ -370,9 +373,8 @@ To add a new notice or slip
 
       -  **Note**
 
-             Review the :ref:`Notices & Slip Field
-             Guide <field-guide-for-notices-&-slips-label>` for info on what fields can
-             be used here.
+             Review the `Customising Notices and Slips <https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_ 
+             wiki page for more information.
 
       -  **Important**
 
@@ -412,6 +414,30 @@ To add a new notice or slip
              slips or notice you can enter data in the Other name or
              Initials field for each patron and use that value instead.
 
+   -  The system preference :ref:`TranslateNotices` will add tabs for each
+      installed language to the notices editor. The notice defined in the
+      'Default' tab will be used if there is no preferred language set
+      for a patron.
+
+      |image1335|
+      
+.. _preview-notice-templates-label:
+
+Preview notice templates
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For some notices it is possible to preview the notice template showing how
+it would look to a specified patron for a particular item or record.
+
+If a notice template is previewable the notice template header will contain a
+field to enter preview data
+
+|image1342|
+
+Fill in the necessary information for the template then click the Preview button
+below the message body. The preview dialog will indicate if there are any problems
+generating the notice template preview.
+
 .. _overdue-notice-markup-label:
 
 Overdue Notice Markup
@@ -419,8 +445,9 @@ Overdue Notice Markup
 
 When creating your overdue notices there are two tags in addition to the
 various database fields that you can use in your notices. You will also
-want to review the :ref:`Notices & Slips Field Guide <field-guide-for-notices-&-slips-label>`
-for information on formatting item information in these notices.
+want to review the `Customising Notices and Slips
+<https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_ 
+wiki page for information on formatting item information in these notices.
 
     **Important**
 
@@ -456,21 +483,92 @@ Among the default notices are notices for several common actions within
 Koha. All of these notices can be customized by altering their text via
 the Notices & Slips tool and their style using the
 :ref:`NoticeCSS` preference to define a stylesheet. You will
-also want to review the :ref:`Notices & Slips Field
-Guide <field-guide-for-notices-&-slips-label>` for information on formatting item
+also want to review the `Customising Notices and Slips
+<https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips>`_ 
+wiki page for information on formatting item
 information in these notices. Here are some of what those notices do:
 
+-  ACCEPTED
+
+   -  This notice is sent when a patron's suggestion is accepted.
+
+   -  *Note:* If you don't want to send this notice, just delete it.
+
 -  ACCTDETAILS
 
    -  Sent to patrons when their account is set up if the
       :ref:`AutoEmailOPACUser <autoemailopacuser-label>` preference is set to
       'Send'
 
--  ACQCLAIM (Acquisition Claim)
+   -  *Important:* The notice will only be sent correctly if a username,
+      password and email address is added to the patron record before
+      saving it for the first time.
+      The notice can't be resend or triggered again after the patron account
+      has been created.
+
+-  ACQCLAIM (Acquisition claim)
+
+   -  Used for claiming orders in the aquisitions module
+
+   -  ACQCLAIM is the code of the sample notice, but it's possible to define
+      several notices choosing any code. Only the module 'Claim
+      aquisition' will be taken into account. All notices with this module
+      will appear in the pull down on the late orders page.
+
+   -  *Get there:* More > Acquisitions > Late orders
+
+   -  This notice is sent if several criteria are met:
+
+      #. The staff patron triggering the email has a valid email address.
+
+      #. The vendor contact marked as 'Contact about late orders?' has 
+         a valid email address.
+
+-  ACQORDER (Acquisition order)
 
-   -  Used in the claim acquisition module
+   -  Used in the acquisitions module to send order information to the vendor
 
-   -  *Get there:* More > Acquisitions > Late issues
+   -  The notice is triggered manually from the basket summary page using
+      the 'Email order' button in the toolbar.
+
+   -  This notice is sent if several criteria are met:
+
+      #. The staff patron triggering the email has a valid email address.
+
+      #. The vendor contact marked as 'Primary acquisitions contact' and
+         'Contact when ordering' has a valid email address.
+
+-  ACQ_NOTIF_ON_RECEIV
+
+   -  Used in the acquisition module to inform patrons on receiving orders
+      they have been added to. 
+
+-  AR\_CANCELED
+
+   -  This notice is sent to the patron when an article request is cancelled
+      by staff.
+
+-  AR\_COMPLETED
+
+   -  This notice is sent to the patron when an article request is marked
+      as completed by staff.
+
+-  AR\_PENDING
+
+   -  This notice is sent to the patron when an article request has been
+      made in order to confirm the request.
+
+-  AR\_PROCESSING
+
+   -  This notice is sent to the patron when an article request is marked
+      as being processed by staff.
+
+-  AVAILABLE
+
+   -  This notice is sent to the patron who made a suggestion, when the
+      order created from the suggestion is received.
+
+   -  *Note:* If you don't want to send this notice, just delete it.
 
 -  CHECKIN
 
@@ -508,6 +606,17 @@ information in these notices. Here are some of what those notices do:
          -  *Get there:*\ Staff Client > Patron Record >
             :ref:`Notices`
 
+-  DISCHARGE
+
+  -  This notice is used to generate a PDF to document a successful
+     discharge request
+
+  -  The PDF can either be downloaded by the patron from their patron
+     account or from the staff interface when discharging a patron
+
+  -  The discharge feature is controlled by the :ref:`useDischarge`
+     system preference.
+
 -  DUE
 
    -  This notice is sent as the 'Item due' for an item is due
@@ -579,15 +688,32 @@ information in these notices. Here are some of what those notices do:
       :ref:`MembershipExpiryDaysNotice` set
       and the :ref:`related cron job <notify-patrons-of-expiration-label>` set.
 
--  ODUE (Overdue Notice)
+-  ODUE (Overdue notice)
 
-   -  This notice is used to send Overdue Notices to Patrons
+   -  This notice is used to send Overdue Notices to patrons
 
-   -  See a `Sample Overdue Notice <#samplenotice>`__
+   -  ODUE is the code of the sample notice, but it's possible to use
+      any code and define multiple different messages for different
+      patron categories and notice levels
 
    -  Requires that you set :ref:`Overdue Notice/Status
       Triggers <overdue-notice/status-triggers-label>`
 
+-  ORDERED
+
+   -  This notice is sent to the patron who made a suggestion, when the
+      'from a suggestion' option is used to create an order from it.
+
+   -  Note: If you don't want to send this notice, just delete it.
+
+-  PASSWORD_RESET
+
+   -  This notice is sent when a patron requests a new password from the
+      OPAC in order to validate the email address.
+
+   -  The password reset feature is controlled by the :ref:`OpacResetPassword`
+      system preference.
+
 -  PREDUE
 
    -  This notice is sent as the 'Advanced notice' for an item is due
@@ -623,6 +749,12 @@ information in these notices. Here are some of what those notices do:
          -  *Get there:*\ Staff Client > Patron Record >
             :ref:`Notices`
 
+-  REJECTED
+
+   -  This notice is sent when a patron's suggestion is rejected.
+
+   -  Note: If you don't want to send this notice, just delete it.
+
 -  RENEWAL
 
    -  This notice is sent as the 'Check out' notice for all items that
@@ -644,17 +776,24 @@ information in these notices. Here are some of what those notices do:
          -  *Get there:*\ Staff Client > Patron Record >
             :ref:`Notices`
 
--  RLIST (Routing List)
+-  SERIAL_ALERT (New serial issue)
 
-   -  Used in the serials module to notify patrons/staff of new issues
-      of a serial
+   -  Notice used in the serials module to notify patrons/staff
+      of new issues of a serial. SERIAL_ALERT (RLIST in older verisons)
+      is provided as a sample notice, but the notice code can be chosen
+      freely as only the module is taken into account. Multiple notices
+      can also be managed.
 
       -  *Get there:* More > Serials > :ref:`New
          Subscription <add-a-subscription-label>`
 
-   -  You have the option to select the 'Routing List' notice when
-      creating a new subscription (Choose from the 'Patron notification'
-      drop down).
+   -  You have the option to select the notice used to inform the patron
+      about a received serial issue for a subscription. Choose from the
+      'Patron notification' drop down.
+
+   -  If a notice has been selected for a subscription, patrons can
+      subscribe to the email notification from the subscription tab
+      in the detail view in the OPAC.
 
    -  **Note**
 
@@ -694,6 +833,15 @@ the Notices & Slips tool and their style using the
 :ref:`SlipCSS` preference to define a stylesheet. Here is what
 those slips are used for:
 
+-  AR\_SLIP
+
+   -  Used to print a slip for an article request
+
+   -  The slip or receipt can be printed manually when managing article
+      requests from the staff interface.
+
+   -  *Get there:* Circulation > Article requests > Actions > Print slip
+
 -  ISSUEQSLIP
 
    -  Used to print the quick slip in circulation
@@ -711,7 +859,15 @@ those slips are used for:
 
    -  Used to print a holds slip
 
-   -  The holds slip is generated when a hold is confirmed
+   -  The holds slip is generated when a hold is confirmed and set to 
+      waiting.
+
+-  OVERDUE\_SLIP
+
+   -  Used to print an overdues slip
+
+   -  The overdues slip can be generated manually using the 'print' menu
+      in the patron account in staff. It will show all items overdue.
 
 -  TRANSFERSLIP
 
@@ -777,13 +933,6 @@ items
    Tech service <talkingtechitivaphonenotification-label>`), Print and SMS
    (if you have set your :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>`).
 
-   -  **Note**
-
-          The Feed option is not yet a feature in Koha, it is there for
-          future development.
-
--  See a `Sample Overdue Notice <#samplenotice>`__
-
 .. _patron-card-creator-label:
 
 Patron Card Creator
@@ -1093,7 +1242,7 @@ be processed in this batch.
 
 |image1225|
 
-After choosing the 'Add item(s)' button the Patron Search window pops
+After choosing the 'Add patron(s)' button the Patron Search window pops
 up.
 
 |image1226|
@@ -1189,7 +1338,7 @@ side of the page.
 To delete one or multiple of these images, click the checkbox to the
 right of each image you want to delete and click the 'Delete' button.
 
-.. _patrons-(anonymize,-bulk-delete)-label:
+.. _patrons-anonymize-bulk-delete-label:
 
 Patrons (anonymize, bulk-delete)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1823,16 +1972,18 @@ authority records' tab.
 
 -  Click 'Export authority records'
 
-.. _inventory-label:
+.. _inventory-tool-label:
 
 Inventory
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 -  *Get there:* More > Tools > Catalog > Inventory
 
-Koha's Inventory Tool can be used in one of three ways:
+Koha's Inventory tool can be used in one of three ways:
 1. By printing out a shelf list that you can then mark items off on;
+
 2. By uploading a text file of barcodes gathered by a portable scanner;
+
 3. By comparing a text file of barcodes gathered by a portable scanner to a
    generated shelf list.
 
@@ -1847,8 +1998,10 @@ All parameters are optional, but if none are selected, the resulting list
 might be quite large.
 
 - Library: choose the branch you want to check, as well as if that branch
-  is the home library or the current of the items.
+  is the home library or the current holding library of the items.
+
 - Shelving location (items.location) is: you can filter by location.
+
 - Item callnumber between ... and ...: you can also limit the list to a specific
   range of callnumbers.
 
@@ -1859,6 +2012,7 @@ only the 'for loan' status as the other items probably won't be on the shelves.
 
 - Last inventory date: enter a date here to skip items that have been marked
   as seen recently.
+
 - Skip items on loan: check this box to filter out loaned items from the list.
 
 - Export to CSV file: check this box to generate a CSV file for altering in an
@@ -1877,15 +2031,17 @@ the three buttons to continue:
 
 - Mark seen and quit: updates the 'last seen' date of the checked items to
   today and returns to the previous screen.
+
 - Mark seen and continue: updates the 'last seen' date of the checked items to
   today and shows the next page of the list.
+
 - Continue without marking: doesn't update any of the items on this page
   and shows the next page of the list.
 
 If you have a portable scanner (or a laptop and USB scanner) you can
 walk through the library with the scanner in hand and scan barcodes as
-you come across them (on a laptop, scan the barcodes into a text file). Once finished you can then upload the text
-file generated by the scanner to Koha.
+you come across them (on a laptop, scan the barcodes into a text file). Once 
+finished you can then upload the text file generated by the scanner to Koha.
 
 |image317|
 
@@ -1898,27 +2054,33 @@ items scanned during inventory' before clicking 'Submit'.
 
 Alternatively, you can combine the two methods to automatically compare a list
 of scanned barcodes with a generated list. First, upload you barcode file and
-choose the date you want to appear in the items' 'last seen' field. Then, check
-the 'Compare barcodes list to results'. Choose the filters (library, shelving
-location, callnumbers or statuses) to generate a list with which to compare
-your barcodes. Click on 'Submit'.
+choose the date you want to appear in the items' 'last seen' field. The 'Compare 
+barcodes list to results' checkbox should automatically be checked. If you do 
+not want the scanned items to be automatically checked-in if they are checked-out, 
+make sure you check the 'Do not check in items scanned during inventory' checkbox. 
+Choose the filters (library, shelving location, callnumbers or statuses) to generate a 
+list with which to compare your barcodes. Click on 'Submit'.
 
-  **Note**
+    **Note**
 
-  Depending on the number of barcodes you are comparing, this may take a few
-  minutes. It is not recommended to compare lists of more than 1000 barcodes as
-  this may cause a session timeout.
+    Depending on the number of barcodes you are comparing, this may take a few
+    minutes. It is not recommended to compare lists of more than 1000 barcodes as
+    this may cause a session timeout.
 
 Once Koha has finished comparing the barcodes file to the generated list, it
 will return the number of items updated and a list of problematic items.
 
 - Missing (not scanned): the item is in the generated list but not in the
   barcodes file.
+
 - Found in wrong place: the item is in the barcodes list, but not in the
   generated list.
+
 - Still checked out: the item is checked out, but is in the generated list. It
   was not automatically checked in.
+
 - Barcode not found: the barcode doesn't exist.
+
 - Item withdrawn: the item has 'withdrawn' status, but it is in the barcodes
   file.
 
@@ -3241,13 +3403,25 @@ uploaded you will be presented with a confirmation.
 
 .. _search-files-label:
 
-Search Files
+Search files
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 All uploaded files are searchable from below the upload form. Using the
 form you can search any part of the filename and/or the Hashvalue.Search
 uploaded files
 
-You will be presened with the results of your search.
+You will be presented with the results of your search.
 
 |image1245|
+
+Access files
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  *Get there:* More > Tools > Additional Tools > Access files
+
+This option allows access to files stored on the server from the staff interface.
+The directories where the files are stored need to be defined in the koha-conf.xml
+file. In order to be able to access the tool, a staff patron requires the superlibrarian
+or access_files patron permission
+
+|image1340|
\ No newline at end of file