Merge branch 'housebound' into 'master'
authorChris Cormack <chris@bigballofwax.co.nz>
Wed, 10 Oct 2018 22:14:57 +0000 (22:14 +0000)
committerChris Cormack <chris@bigballofwax.co.nz>
Wed, 10 Oct 2018 22:14:57 +0000 (22:14 +0000)
Fixed images in housebound section

See merge request koha-community/koha-manual!183

15 files changed:
.gitlab-ci.yml
source/ILL_requests.rst
source/images.rst
source/images/ILLrequests/.gitkeep [new file with mode: 0644]
source/images/ILLrequests/Confirmrequeststaff.PNG [new file with mode: 0644]
source/images/ILLrequests/CreateILLstaff1.PNG [new file with mode: 0644]
source/images/ILLrequests/CreateILLstaff2.PNG [new file with mode: 0644]
source/images/ILLrequests/ILLformpickerstaff.PNG [new file with mode: 0644]
source/images/tools/stockrotation/sr_catalog_view.png [new file with mode: 0644]
source/images/tools/stockrotation/sr_edit_rota.png [new file with mode: 0644]
source/images/tools/stockrotation/sr_manage_items.png [new file with mode: 0644]
source/images/tools/stockrotation/sr_manage_stages.png [new file with mode: 0644]
source/images/tools/stockrotation/sr_summary.png [new file with mode: 0644]
source/opac.rst
source/tools.rst

index 27df8e2..403bf99 100644 (file)
@@ -1,7 +1,3 @@
-cache:
-  paths:
-    - build/
-
 before_script:
   # Install ssh-agent if not already installed, it is required by Docker.
   # (change apt-get to yum if you use a CentOS-based image)
@@ -38,6 +34,12 @@ image: debian:unstable
 #  - master
 
 production:
+    artifacts:
+       paths:
+        - build/en/html
+    cache:
+       paths:
+        - build/en/html
     stage: deploy
     script:
     - DEBIAN_FRONTEND=noninteractive apt-get install -y python3-sphinx  python3-sphinxcontrib.spelling make rsync
index 022958c..1656e35 100644 (file)
@@ -29,51 +29,65 @@ Create ILL requests
 
 -  *Get there:* More > ILL requests
 
-|image|
+|image1381|
 
 -  Choose ‘New ILL request’ and then Freeform.
 
-**Note:** 
+    **Note**
 The images shown here are for the FreeFrom backend only.
 
-|image|
+|image1382|
 
 -  Enter a Type: Book, Article, Journal, Other.
+
 -  In the next two sections enter as much as information as you can including chapter/article/part if applicable.
 
-|image|
+|image1383|
 
 -  Add custom fields, for example if you wished to add a note.
+
 -  Under the borrower options enter the library branch you would like the request to be sent to.
 
 Click on ‘Create’ and you will be shown a Request details summary page.  Click on the ‘Confirm request’ button and you will see the following confirmation message:
 
-|image|
+|image1384|
 
 Click ‘Confirm request’ again.  From the main ILL requests screen you can see all of your ILL requests and their status.  Alternatively you can click on ‘View requests’ at any time. The request will have the status ‘New request’. 
 
 .. _managing-ILL-requests-label:
 
 Managing ILL requests
-----------------------
+------------------------
 
 Click on the ‘Manage request’ button in the final column. Depending on the current status of the request you may see some or all of the following buttons:
 
--  Edit request - you can edit the borrowernumber, biblionumber, branch and can add notes.
--  Confirm request - place the request with a document supply service using a backend such as BLDSS.
--  Place request with partners -  place the request via email with a :ref:`partner library <place-request-with-partners-label>`
--  Delete - fully delete the request.  Details of deleted requests are not retained in Koha.
--  Revert request – following a status of ‘Requested’ or ‘Requested from partners’ library staff can cancel the request from the external source.  The status reverts to ‘New’
--  Mark completed - used when the ILL request has been fulfilled. 
+-  Edit request
+
+   -  you can edit the borrowernumber, biblionumber, branch and can add notes.
+-  Confirm request
+
+   -  place the request with a document supply service using a backend such as BLDSS.
+-  Place request with partners
+
+   -  place the request via email with a :ref:`partner library <place-request-with-partners-label>`
+-  Delete
 
-The full list of ILL statuses are:
+   -  fully delete the request.  Details of deleted requests are not retained in Koha.
+-  Revert request
 
--  New request
--  Requested
--  Requested from partners 
--  Request reverted 
--  Cancellation requested – a patron has requested cancellation from the OPAC.
--  Completed
+   -  following a status of ‘Requested’ or ‘Requested from partners’ library staff can cancel the request from the external source.  The status reverts to ‘New’
+-  Mark completed
+
+   -  used when the ILL request has been fulfilled. 
+
+-  The full list of ILL statuses are:
+
+   -  New request
+   -  Requested
+   -  Requested from partners 
+   -  Request reverted 
+   -  Cancellation requested – a patron has requested cancellation from the OPAC.
+   -  Completed
 
 .. _place-request-with-partners-label:
 
@@ -83,7 +97,9 @@ Place request with partners
 If you have a network of partner libraries which permit ILL requests you can manage this through Koha.  First you need to create your partner library accounts:
 
 -  You will need to set up a :ref:`patron category <patron-categories-label>` with the code ILLLIBS.
+
 -  You will need to create a patron account with this category for each partner library.  
+
 -  Each library must have an email address as this will be the mechanism for sending the inter-library loan request.
 
 You can now use the 'Place request with partners' option when processing requests. 
index 1af64a3..f701ee1 100644 (file)
 .. |image1377| image:: images/serials/editselectedserials.png
 .. |image1378| image:: images/serials/editbatch.png
 .. |image1379| image:: images/serials/addmarcfield.png
-.. |image1380| image:: images/serials/showfieldsmarc.png
\ No newline at end of file
+.. |image1380| image:: images/serials/showfieldsmarc.png
+.. |image1381| image:: images/tools/stockrotation/sr_summary.png
+.. |image1382| image:: images/tools/stockrotation/sr_edit_rota.png
+.. |image1383| image:: images/tools/stockrotation/sr_manage_stages.png
+.. |image1384| image:: images/tools/stockrotation/sr_manage_items.png
+.. |image1385| image:: images/tools/stockrotation/sr_catalog_view.png
+.. |image1386| image:: images/ILLrequests/ILLformpickerstaff.png
+.. |image1387| image:: images/ILLrequests/CreateILLstaff1.png
+.. |image1388| image:: images/ILLrequests/CreateILLstaff2.png
+.. |image1389| image:: images/ILLrequests/Confirmrequeststaff.png
diff --git a/source/images/ILLrequests/.gitkeep b/source/images/ILLrequests/.gitkeep
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/source/images/ILLrequests/Confirmrequeststaff.PNG b/source/images/ILLrequests/Confirmrequeststaff.PNG
new file mode 100644 (file)
index 0000000..7ba9eda
Binary files /dev/null and b/source/images/ILLrequests/Confirmrequeststaff.PNG differ
diff --git a/source/images/ILLrequests/CreateILLstaff1.PNG b/source/images/ILLrequests/CreateILLstaff1.PNG
new file mode 100644 (file)
index 0000000..a34863c
Binary files /dev/null and b/source/images/ILLrequests/CreateILLstaff1.PNG differ
diff --git a/source/images/ILLrequests/CreateILLstaff2.PNG b/source/images/ILLrequests/CreateILLstaff2.PNG
new file mode 100644 (file)
index 0000000..6c28f81
Binary files /dev/null and b/source/images/ILLrequests/CreateILLstaff2.PNG differ
diff --git a/source/images/ILLrequests/ILLformpickerstaff.PNG b/source/images/ILLrequests/ILLformpickerstaff.PNG
new file mode 100644 (file)
index 0000000..7c3a59b
Binary files /dev/null and b/source/images/ILLrequests/ILLformpickerstaff.PNG differ
diff --git a/source/images/tools/stockrotation/sr_catalog_view.png b/source/images/tools/stockrotation/sr_catalog_view.png
new file mode 100644 (file)
index 0000000..80db553
Binary files /dev/null and b/source/images/tools/stockrotation/sr_catalog_view.png differ
diff --git a/source/images/tools/stockrotation/sr_edit_rota.png b/source/images/tools/stockrotation/sr_edit_rota.png
new file mode 100644 (file)
index 0000000..87e4f19
Binary files /dev/null and b/source/images/tools/stockrotation/sr_edit_rota.png differ
diff --git a/source/images/tools/stockrotation/sr_manage_items.png b/source/images/tools/stockrotation/sr_manage_items.png
new file mode 100644 (file)
index 0000000..3a81e2f
Binary files /dev/null and b/source/images/tools/stockrotation/sr_manage_items.png differ
diff --git a/source/images/tools/stockrotation/sr_manage_stages.png b/source/images/tools/stockrotation/sr_manage_stages.png
new file mode 100644 (file)
index 0000000..6b48fe7
Binary files /dev/null and b/source/images/tools/stockrotation/sr_manage_stages.png differ
diff --git a/source/images/tools/stockrotation/sr_summary.png b/source/images/tools/stockrotation/sr_summary.png
new file mode 100644 (file)
index 0000000..0e823e1
Binary files /dev/null and b/source/images/tools/stockrotation/sr_summary.png differ
index eea3f01..74844c6 100644 (file)
@@ -1220,19 +1220,16 @@ And will receive confirmation of their request.
 
 |image1032|
 
-.. _purchase-suggestions-label:
+.. _my-interlibrary-loan-requests-label:
 
-My interlibrary loan requests
+My Interlibrary Loan Requests
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If your library has the :ref:`ILLModule` preference set to ‘Enable’ patrons will have the option to make ILL requests when logged in to their OPAC account.  From here they can view their existing requests and place new ones.
 
 |image1373|
 
-Placing a new interlibrary loan request
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Click on ‘Create a new request’ and choose a request form. 
+To place a new interlibrary loan request click on ‘Create a new request’ and choose a request form. 
 
 |image1374|
 
@@ -1252,9 +1249,6 @@ Click on 'Create' to submit your request to the library for processing.
 
 Your submitted request will be listed with a status of ‘New request’.  Once processed the status will be updated to ‘Requested’.
 
-Editing requests
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
 Click on ‘View’ to make changes or cancel your request.
 
 You cannot edit the form details but you can add a note to request a modification and then click on ‘Submit modifications’ at the bottom of the screen.  Your modification will be sent to the library for processing. 
index 41ffe92..e388f74 100644 (file)
@@ -1677,6 +1677,115 @@ collection, also letting them know where the item needs to be sent.
 
 |image292|
 
+.. _patrons-stock_rotation
+
+Stock Rotation
+~~~~~~~~~~~~~~
+
+The stock rotation tool allows library staff to create rotation plans and add 
+items to them. A cronjob is then used to cycle these items round the specified 
+libraries on the rotation plan, moving them to the next stage after the 
+prescribed period of time has passed at the current stage. Email notices may be
+used to provide the library branches with a list of items to be put in-transit 
+to the next branch and if an item is found to be on loan at the time that it 
+should be transfered then an alert will be displayed when it is next returned.
+
+From the stock rotation tool page you can add new rotation plans and see a 
+summary of your currently configured rotation plans. You can then edit plan 
+details, activate and deactivate plans and manage stages and items on a given 
+rotation plan.
+
+|image1381|
+
+This tool utilises a cron job that must be configured to run on a daily basis.
+
+Editing rota details
+^^^^^^^^^^^^^^^^^^^^
+
+|image1382|
+
+Name: A clear name or code to identify the rota
+
+Cyclical: Denotes whether items remain (No) at the last library on the rotation
+plan upon reaching the end of the rota or whether they continue (Yes) to rotate,
+returning back to the first library on the rotation plan once they have
+completed their alloted time at the last library, indefinitely until manually
+removed from the rota.
+
+Active: Denotes whether a rota is active and as such whether items on it are
+rotating. It also governs whether items may be added to and removed from the
+rota.  A rota may be switched between active and inactive at any time allowing
+for rota maintanence.
+
+Description: One may optionally add an expanded description of the rota for
+display in summary views.
+
+
+Managing rota stages
+^^^^^^^^^^^^^^^^^^^^
+
+|image1383|
+
+Stages may be edited, added, removed and re-ordered at any time from this page.
+
+Library: The library the item will be at during this stage
+
+Duration: The amount of time the item should stage at this stage
+
+
+Managing rota items - Tool view
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+|image1384|
+
+Items can be added to a rota individually (by barcode) or in bulk (via the
+upload of a line delimited barcode file) on this page.
+
+You will also be presented with a summary of all items on the rota with their
+current location and you have the options to immediately progress items, mark
+items as 'in demand' and remove an item from rotation.
+
+In demand: If an item is marked as 'in demand' then the duration the item will
+stay at it's current stage will be doubled compared to what is set in the
+rota. This is often used for items that are found to be unexpectedly popular at
+a particular library.
+
+Managing rota items - Catalog view
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+|image1385|
+
+Rotating items may also be managed from the catalog view: When stock rotation is
+enabled a new menu tab 'Rota' will appear on a catalog records detail view.
+
+All attached items will appear in the summary view with their current status in
+relation to rotas and the option to mark items as 'in demand' or immediately
+progress them.  You can also remove items from rotation and add items to rotas
+here too.
+
+Managing rotation notices
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Stock rotation can send email notices to branch libraries to aid in selecting
+the items due for rotation. Branch 'Reply-to' addresses will be used in
+preference to 'Email' addresses for the notice recipients.
+
+The contents of the notices can be customised in the normal manor through the
+notices tool and the relevant notice has the code SR_SLIP.
+
+Permissions
+^^^^^^^^^^^
+
+The stock rotation tool uses two distinct permissions:
+
+manage_rotas:
+  this governs a users ability to create, update and delete a rota.
+
+manate_rota_items:
+  this governs a users ability to add, remove and progress
+items on a rota.
+
+
 .. _catalog-label:
 
 Catalog