Docs: Update several chapters for web client
authorRemington Steed <rjs7@calvin.edu>
Fri, 20 Apr 2018 16:09:55 +0000 (12:09 -0400)
committerRemington Steed <rjs7@calvin.edu>
Fri, 20 Apr 2018 17:56:37 +0000 (13:56 -0400)
  - User and Group Permissions
    - One new screenshot
    - Minor line reformatting
  - SMS Text Messaging
    - Update screenshots and alt text
    - Correction/clarification to some instructions
  - Barcode Completion
    - Replace composite screenshot with separate updated screenshots
    - Reformat headings to accommodate new screenshots
    - Update other screenshots
    - Slight rewording (change "actor" to "patron", "asset" to "copy")
    - Remove release date and reference to previous name of feature

Signed-off-by: Remington Steed <rjs7@calvin.edu>
15 files changed:
docs/admin/SMS_messaging.adoc
docs/admin/lsa-barcode_completion.adoc
docs/admin/permissions.adoc
docs/media/Barcode_Check_In.png [new file with mode: 0644]
docs/media/Barcode_Checkout_Item_Barcode.png [new file with mode: 0644]
docs/media/Barcode_Checkout_Patron_Barcode.png [new file with mode: 0644]
docs/media/Barcode_Item_Status.png [new file with mode: 0644]
docs/media/Barcode_OPAC_Staff_Place_Hold.png [new file with mode: 0644]
docs/media/SMS_Text_Messaging1.png [new file with mode: 0644]
docs/media/SMS_Text_Messaging2.png [new file with mode: 0644]
docs/media/SMS_Text_Messaging5.png [new file with mode: 0644]
docs/media/SMS_Text_Messaging6.png [new file with mode: 0644]
docs/media/lsa-barcode_completion_fields.png
docs/media/lsa-barcode_completion_multiple.png
docs/media/permissions_1a.png [new file with mode: 0644]

index cbbe073..181c188 100644 (file)
@@ -16,13 +16,14 @@ Enable Text Messages
 . Select the setting, *Enable features that send SMS text messages.*
 . Set the value to *True,* and click *Update Setting.*
 
-image::media/SMS_Text_Messaging1.jpg[SMS_Text_Messaging1]
+image::media/SMS_Text_Messaging1.png[Library Setting to enable SMS]
 
 Authenticate Patrons
 ^^^^^^^^^^^^^^^^^^^^
 
-By default, you must be logged into your OPAC account to send a text message from Evergreen.  However, if you disable this setting, you can text message copy information without having 
-to login to your OPAC account.
+By default, you must be logged into your OPAC account to send a text message
+from Evergreen.  However, if you turn on this setting, you can text message copy
+information without having to login to your OPAC account.
 
 To disable the patron login requirement:
 
@@ -30,7 +31,7 @@ To disable the patron login requirement:
 . Select the setting, *Disable auth requirement for texting call numbers*.
 . Set the value to *True,* and click *Update Setting.*
 
-image::media/SMS_Text_Messaging2.jpg[SMS_Text_Messaging2]
+image::media/SMS_Text_Messaging2.png[Library Setting to disable SMS auth/login requirement]
 
 Configure SMS Carriers
 ^^^^^^^^^^^^^^^^^^^^^^
@@ -61,11 +62,14 @@ To configure the text of the SMS text message:
 . Click *Administration* -> *Local Administration* ->  *Notifications/Action Triggers.*
 . Create a new A/T and template, or use or modify an existing template.  For example, a default template, "Hold Ready for Pickup SMS Notification," notifies users that the hold is ready for pickup.  
 +
-image::media/SMS_Text_Messaging5.jpg[SMS_Text_Messaging5]
+image::media/SMS_Text_Messaging5.png[SMS Notification Triggers list]
 +
-. You can use the  default template, or you can edit the template and add content specific to your library.  Click the hyperlinked name to view and/or edit the hold notice.
-
-image::media/SMS_Text_Messaging6.jpg[SMS_Text_Messaging6]
+. You can use the  default template, or you can edit the template and add
+content specific to your library.  Click the hyperlinked name to edit the
+Event Environment and Event Parameters.  Or double-click the row to edit the
+hold notice.
++
+image::media/SMS_Text_Messaging6.png[Hold Ready SMS Trigger Event Definition]
 
 Receiving Holds Notices via Text Message
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
index 4915e96..88af0b9 100644 (file)
@@ -5,13 +5,12 @@ indexterm:[Barcode Completion,Lazy Circ]
 
 The Barcode Completion feature gives users the ability to only enter the 
 unique part of patron and item barcodes.  This can significantly reduce the 
-amount of typing required for manual barcode input.  This feature was also 
-known as *Lazy Circ* at one point.
+amount of typing required for manual barcode input.
 
 This feature can also be used if there is a difference between what the 
 barcode scanner outputs and what is stored in the database, as long as the 
 barcode that is stored has more characters then what the scanner is 
-outputting. Barcode Completion is additive only, you cannot use it match a 
+outputting. Barcode Completion is additive only; you cannot use it to match a
 stored barcode that has less characters than what is entered. For example, if 
 your barcode scanners previously output *a123123b* and now exclude the prefix 
 and suffix, you could match both formats using Barcode Completion rules.
@@ -20,8 +19,6 @@ Because this feature adds an extra database search for each enabled rule to
 the process of looking up a barcode, it can add extra delays to the check-out 
 process.  Please test in your environment before using in production.
 
-*Released:* 2.2 - June 2012
-
 Scoping and Permissions
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -39,26 +36,44 @@ Access Points
 The admin interface for Barcode Completion is located under *Administration* 
 -> *Local Administration* -> *Barcode Completion*.
 
-image::media/lsa-barcode_completion_admin.png[Barcode Completion Admin]
+image::media/lsa-barcode_completion_admin.png[Barcode Completion Admin List]
 
 The barcode completion functionality is available at the following interfaces.
 
-.For Actors (Users) Barcodes
- * Lookup Patron by Barcode/Check Out.
- * Optionally during check out if library setting "Load patron from Checkout" 
-is set. (Automatically detects if an actor/user barcode is scanned during 
-check out, and starts a new check out session using that user.)
- * OPAC's Staff Client Place Hold.
+Check Out Step 1: Lookup Patron by Barcode
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+image::media/Barcode_Checkout_Patron_Barcode.png[Patron Barcode Lookup for Checking Out]
+
+Check Out Step 2: Scanning Item Barcodes
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+image::media/Barcode_Checkout_Item_Barcode.png[Item Barcode at Check Out]
+
+Staff Client Place Hold from Catalog
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+image::media/Barcode_OPAC_Staff_Place_Hold.png[Patron Barcode Lookup for Staff Placing Hold]
  
-.For Assets (Copy) Barcodes
- * Check Out.
- * Check In.
- * Item Status / Search for copies by Barcode / Show Item Status by Barcode.
+Check In
+^^^^^^^^
+
+image::media/Barcode_Check_In.png[Item Barcode at Check In]
+
+Item Status
+^^^^^^^^^^^
+
+image::media/Barcode_Item_Status.png[Item Barcode at Item Status screen]
+
+
+NOTE: Barcode completion is also available during check out if library
+setting "Load patron from Checkout" is set.
+(Automatically detects if an actor/user barcode is scanned during
+check out, and starts a new check out session using that user.)
 
 NOTE: Barcode Completion does not work in the 
  *Search for Patron [by Name]* interface. 
 
-image::media/lsa-barcode_completion_accesspoints.png[Barcode Completion Access Points]
 
 Multiple Matches
 ~~~~~~~~~~~~~~~~
index 054c8cc..586dd11 100644 (file)
@@ -1,8 +1,7 @@
 User and Group Permissions
 --------------------------
 
-It is essential to understand how user and group permissions can be used to
-allow 
+It is essential to understand how user and group permissions can be used to allow
 staff to fulfill their roles while ensuring that they only have access to the
 appropriate level.
 
@@ -20,14 +19,14 @@ Staff Accounts
 
 New staff accounts are created in much the same way as patron accounts, using
 _Circulation -> Register Patron_ or *Shift+F1*. Select one of the staff
-profiles 
-from the _Profile Group_ drop-down menu.
+profiles from the _Profile Group_ drop-down menu.
+
+image::media/permissions_1a.png[Permission Group dropdown in patron account]
 
 Each new staff account must be assigned a _Working Location_ which determines
-its 
-access level in staff client interfaces.
+its access level in staff client interfaces.
 
-. To assign a working location open the newly created staff account using *F1* 
+. To assign a working location, open the newly created staff account using *F1*
 (retrieve patron) or *F4* (patron search).
 . Select _Other -> User Permission Editor_
 +
diff --git a/docs/media/Barcode_Check_In.png b/docs/media/Barcode_Check_In.png
new file mode 100644 (file)
index 0000000..454cc41
Binary files /dev/null and b/docs/media/Barcode_Check_In.png differ
diff --git a/docs/media/Barcode_Checkout_Item_Barcode.png b/docs/media/Barcode_Checkout_Item_Barcode.png
new file mode 100644 (file)
index 0000000..bf2592e
Binary files /dev/null and b/docs/media/Barcode_Checkout_Item_Barcode.png differ
diff --git a/docs/media/Barcode_Checkout_Patron_Barcode.png b/docs/media/Barcode_Checkout_Patron_Barcode.png
new file mode 100644 (file)
index 0000000..6710a71
Binary files /dev/null and b/docs/media/Barcode_Checkout_Patron_Barcode.png differ
diff --git a/docs/media/Barcode_Item_Status.png b/docs/media/Barcode_Item_Status.png
new file mode 100644 (file)
index 0000000..59e2e45
Binary files /dev/null and b/docs/media/Barcode_Item_Status.png differ
diff --git a/docs/media/Barcode_OPAC_Staff_Place_Hold.png b/docs/media/Barcode_OPAC_Staff_Place_Hold.png
new file mode 100644 (file)
index 0000000..116eaa5
Binary files /dev/null and b/docs/media/Barcode_OPAC_Staff_Place_Hold.png differ
diff --git a/docs/media/SMS_Text_Messaging1.png b/docs/media/SMS_Text_Messaging1.png
new file mode 100644 (file)
index 0000000..06fa12c
Binary files /dev/null and b/docs/media/SMS_Text_Messaging1.png differ
diff --git a/docs/media/SMS_Text_Messaging2.png b/docs/media/SMS_Text_Messaging2.png
new file mode 100644 (file)
index 0000000..b0ed58d
Binary files /dev/null and b/docs/media/SMS_Text_Messaging2.png differ
diff --git a/docs/media/SMS_Text_Messaging5.png b/docs/media/SMS_Text_Messaging5.png
new file mode 100644 (file)
index 0000000..295a5c4
Binary files /dev/null and b/docs/media/SMS_Text_Messaging5.png differ
diff --git a/docs/media/SMS_Text_Messaging6.png b/docs/media/SMS_Text_Messaging6.png
new file mode 100644 (file)
index 0000000..5e153b1
Binary files /dev/null and b/docs/media/SMS_Text_Messaging6.png differ
index bb0e2e6..651f414 100644 (file)
Binary files a/docs/media/lsa-barcode_completion_fields.png and b/docs/media/lsa-barcode_completion_fields.png differ
index 0d50c2c..071d050 100644 (file)
Binary files a/docs/media/lsa-barcode_completion_multiple.png and b/docs/media/lsa-barcode_completion_multiple.png differ
diff --git a/docs/media/permissions_1a.png b/docs/media/permissions_1a.png
new file mode 100644 (file)
index 0000000..9b3f811
Binary files /dev/null and b/docs/media/permissions_1a.png differ