[open-ils-commits] [GIT] Evergreen ILS branch master updated. 85925d73cad641275b826280968113be561ab8a3
Evergreen Git
git at git.evergreen-ils.org
Sun Sep 17 11:23:57 EDT 2017
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Evergreen ILS".
The branch, master has been updated
via 85925d73cad641275b826280968113be561ab8a3 (commit)
via 1e74a150a546f13a0d7b1fb77f1769d34eb0478d (commit)
from 420cea901181bd84413826774fa81c180852340a (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 85925d73cad641275b826280968113be561ab8a3
Merge: 1e74a15 420cea9
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date: Sun Sep 17 08:23:50 2017 -0700
Merge branch 'master' of git.evergreen-ils.org:Evergreen
commit 1e74a150a546f13a0d7b1fb77f1769d34eb0478d
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date: Sun Sep 17 08:23:33 2017 -0700
Docs reorg: splitting self-check documentation into appropriate manuals
Signed-off-by: Jane Sandberg <sandbej at linnbenton.edu>
diff --git a/docs/admin/audio_alerts.adoc b/docs/admin/audio_alerts.adoc
new file mode 100644
index 0000000..3dd6a9c
--- /dev/null
+++ b/docs/admin/audio_alerts.adoc
@@ -0,0 +1,38 @@
+Managing audio alerts
+---------------------
+
+Globally silencing sounds
+~~~~~~~~~~~~~~~~~~~~~~~~~
+indexterm:[audio alerts,silencing]
+indexterm:[nosound.wav]
+
+The file `nosound.wav` can be used
+to globally disable audio alerts for a specific event on an Evergreen system.
+
+For example, to silence the alert that sounds after a successful patron search:
+
+[source, bash]
+------------------------------------------------------------------------------
+mkdir -p /openils/var/web/audio/notifications/success/patron/
+cd /openils/var/web/audio/notifications/success/patron/
+ln -s ../../nosound.wav by_search.wav
+------------------------------------------------------------------------------
+
+
+Self-check interface
+~~~~~~~~~~~~~~~~~~~~
+indexterm:[audio alerts,self check interface]
+indexterm:[self check interface,audio alerts]
+indexterm:[audio_config.tt2]
+
+Sounds may play at certain events in the self check interface. These
+events are defined in the `templates/circ/selfcheck/audio_config.tt2`
+template. To use the default sounds, you could run the following command
+from your Evergreen server as the *root* user (assuming that
+`/openils/` is your install prefix):
+
+[source, bash]
+------------------------------------------------------------------------------
+cp -r /openils/var/web/xul/server/skin/media/audio /openils/var/web/.
+------------------------------------------------------------------------------
+
diff --git a/docs/circulation/self_check.adoc b/docs/circulation/self_check.adoc
index ba96354..9fcbd97 100644
--- a/docs/circulation/self_check.adoc
+++ b/docs/circulation/self_check.adoc
@@ -20,47 +20,6 @@ check station, a staff member must initialize the interface by logging in.
image::media/self-check-admin-login.png[Self Check Admin Login]
-Setting library hours of operation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-When the self check prints a receipt, the default template includes the
-library's hours of operation in the receipt. If the library has no configured
-hours of operation, the attempt to print a receipt fails and the browser hangs.
-
-Configuring self check behavior
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Several library settings control the behavior of the self check:
-
-* *Audio Alerts*: Plays sounds when events occur in the self check. These
- events are defined in the `templates/circ/selfcheck/audio_config.tt2`
- template. To use the default sounds, you could run the following command
- from your Evergreen server as the *root* user (assuming that
- `/openils/` is your install prefix):
-+
-[source, bash]
-------------------------------------------------------------------------------
-cp -r /openils/var/web/xul/server/skin/media/audio /openils/var/web/.
-------------------------------------------------------------------------------
-+
-* *Block copy checkout status*: Prevent the staff user's permission override
- from enabling patrons to check out items that they would not normally be able
- to check out, such as the "On reservation shelf" status. The status IDs are
- found in the `config.copy_status` database table.
-* *Patron Login Timeout*: Automatically logs the patron out of the self check
- after a certain period of inactivity. *NOT CURRENTLY SUPPORTED*
-* *Pop-up alert for errors*: In addition to displaying an alert message on the
- screen, this setting raises patron awareness of possible problems by raising
- an alert box that the patron must dismiss before they can check out another
- item.
-* *Require Patron Password*: By default, users can enter either their user name
- or barcode, without having to enter their password, to access their account.
- This setting requires patrons to enter their password for additional
- security.
-* *Workstation Required*: If set, the URL must either include a
- `?ws=[workstation]` parameter, where _[workstation]_ is the name of a
- registered Evergreen workstation, or the staff member must register a new
- workstation when they login. The workstation parameter ensures that check outs
- are recorded as occurring at the correct library.
-
Basic Check Out
---------------
diff --git a/docs/circulation/self_check_configuration.adoc b/docs/circulation/self_check_configuration.adoc
new file mode 100644
index 0000000..670248d
--- /dev/null
+++ b/docs/circulation/self_check_configuration.adoc
@@ -0,0 +1,56 @@
+Self checkout
+=============
+
+Introduction
+------------
+
+Evergreen includes a self check interface designed for libraries that simply
+want to record item circulation without worrying about security mechanisms like
+magnetic strips or RFID tags.
+
+Initializing the self check
+---------------------------
+The self check interface runs in a web browser. Before patrons can use the self
+check station, a staff member must initialize the interface by logging in.
+
+. Open your self check interface page in a web browser. By default, the URL is
+ `https://[hostname]/eg/circ/selfcheck/main`, where _[hostname]_
+ represents the host name of your Evergreen web server.
+. Log in with a staff account with circulation permissions.
+
+image::media/self-check-admin-login.png[Self Check Admin Login]
+
+Setting library hours of operation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+When the self check prints a receipt, the default template includes the
+library's hours of operation in the receipt. If the library has no configured
+hours of operation, the attempt to print a receipt fails and the browser hangs.
+
+Configuring self check behavior
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Several library settings control the behavior of the self check:
+
+* *Block copy checkout status*: Prevent the staff user's permission override
+ from enabling patrons to check out items that they would not normally be able
+ to check out, such as the "On reservation shelf" status. The status IDs are
+ found in the `config.copy_status` database table.
+* *Patron Login Timeout*: Automatically logs the patron out of the self check
+ after a certain period of inactivity. *NOT CURRENTLY SUPPORTED*
+* *Pop-up alert for errors*: In addition to displaying an alert message on the
+ screen, this setting raises patron awareness of possible problems by raising
+ an alert box that the patron must dismiss before they can check out another
+ item.
+* *Require Patron Password*: By default, users can enter either their user name
+ or barcode, without having to enter their password, to access their account.
+ This setting requires patrons to enter their password for additional
+ security.
+* *Workstation Required*: If set, the URL must either include a
+ `?ws=[workstation]` parameter, where _[workstation]_ is the name of a
+ registered Evergreen workstation, or the staff member must register a new
+ workstation when they login. The workstation parameter ensures that check outs
+ are recorded as occurring at the correct library.
+
+Using the self check
+--------------------
+
+See the circulation manual for documentation about using the self check interface.
diff --git a/docs/root_circulation.adoc b/docs/root_circulation.adoc
index 1305fe9..d43eefd 100644
--- a/docs/root_circulation.adoc
+++ b/docs/root_circulation.adoc
@@ -58,6 +58,7 @@ include::opac/using_the_public_access_catalog.adoc[]
:leveloffset: 0
+include::circulation/self_check.adoc[]
diff --git a/docs/root_command_line_admin.adoc b/docs/root_command_line_admin.adoc
index 9eca3d7..24a284b 100644
--- a/docs/root_command_line_admin.adoc
+++ b/docs/root_command_line_admin.adoc
@@ -103,8 +103,9 @@ include::admin_initial_setup/designing_your_catalog.adoc[]
:leveloffset: 0
-include::opac/new_skin_customizations.adoc[]
+include::admin/audio_alerts.adoc[]
+include::opac/new_skin_customizations.adoc[]
include::shared/attributions.adoc[]
diff --git a/docs/root_staff_client_admin.adoc b/docs/root_staff_client_admin.adoc
index 1f2a251..7d06b38 100644
--- a/docs/root_staff_client_admin.adoc
+++ b/docs/root_staff_client_admin.adoc
@@ -99,8 +99,6 @@ include::admin/hold_driven_recalls.adoc[]
include::admin/copy_statuses.adoc[]
-include::circulation/self_check.adoc[]
-
Circulating uncataloged materials
@@ -172,6 +170,7 @@ Negative balances
This section needs to be written
+
Circulation timesavers and workflows
------------------------------------
@@ -226,10 +225,12 @@ Need to extract this from the offline circulation documentation
include::admin/workstation_admin_receipt_template_editor.adoc[]
-Self-check administration
--------------------------
+:leveloffset: 1
+
+include::circulation/self_check_configuration.adoc[]
+
+:leveloffset: 0
-Need to extract this from the self-check documentation
// Patron UX
Patron User Experience Administration
-----------------------------------------------------------------------
Summary of changes:
docs/admin/audio_alerts.adoc | 38 ++++++++++++++++
docs/circulation/self_check.adoc | 41 -----------------
docs/circulation/self_check_configuration.adoc | 56 ++++++++++++++++++++++++
docs/root_circulation.adoc | 1 +
docs/root_command_line_admin.adoc | 3 +-
docs/root_staff_client_admin.adoc | 11 +++--
6 files changed, 103 insertions(+), 47 deletions(-)
create mode 100644 docs/admin/audio_alerts.adoc
create mode 100644 docs/circulation/self_check_configuration.adoc
hooks/post-receive
--
Evergreen ILS
More information about the open-ils-commits
mailing list