From ec97182746839a1a31bcba3f02edc14e7604929f Mon Sep 17 00:00:00 2001 From: Jane Sandberg Date: Sun, 2 Apr 2017 10:38:01 -0700 Subject: [PATCH] Docs: replacing XUL client docs with Browser client docs Signed-off-by: Jane Sandberg --- docs/cataloging/copy-buckets_web_client.txt | 4 +- .../circulation_patron_records_web_client.txt | 46 +++--- docs/root.txt | 155 ++---------------- 3 files changed, 37 insertions(+), 168 deletions(-) diff --git a/docs/cataloging/copy-buckets_web_client.txt b/docs/cataloging/copy-buckets_web_client.txt index c845fae5e2..8b5be72919 100755 --- a/docs/cataloging/copy-buckets_web_client.txt +++ b/docs/cataloging/copy-buckets_web_client.txt @@ -1,5 +1,5 @@ -Section X - Copy Buckets ------------------------- +Copy Buckets +------------ Copy buckets are containers copy records can be put into to easily perform batch actions on. Copies stay in buckets until they are removed. diff --git a/docs/circulation/circulation_patron_records_web_client.txt b/docs/circulation/circulation_patron_records_web_client.txt index 1ce510be35..747f5928c5 100644 --- a/docs/circulation/circulation_patron_records_web_client.txt +++ b/docs/circulation/circulation_patron_records_web_client.txt @@ -1,7 +1,7 @@ Circulation - Patron Record --------------------------- -[[searching_patrons_wc]] +[[searching_patrons]] Searching Patrons ~~~~~~~~~~~~~~~~~ @@ -128,14 +128,14 @@ image::media/patron_self_registration2.jpg[Patron Self-Registration form] . Fill in the necessary patron information for your library, and click *Save* to create the permanent patron account. -[[updating_patron_information_wc]] +[[updating_patron_information]] Updating Patron Information ~~~~~~~~~~~~~~~~~~~~~~~~~~~ indexterm:[patrons, updating] Retrieve the patron record as described in the section -<>. +<>. Click on _Edit_ from the options that display at the top of the patron record. @@ -165,7 +165,7 @@ stating that the ``Patron account is EXPIRED.'' image::media/circulation_patron_records-11_web_client.png[circulation_patron_records 11] Open the patron record in edit mode as described in the section -<>. +<>. Navigate to the information field labeled _Privilege Expiration Date_. Enter a new date in this box. When you place your cursor in the _Patron Expiration Date @@ -185,10 +185,10 @@ Lost Library Cards indexterm:[library cards, replacing] Retrieve the patron record as described in the section -<>. +<>. Open the patron record in edit mode as described in the section -<>. +<>. Next to the _Barcode_ field, select the _Replace Barcode_ button. @@ -200,9 +200,8 @@ pane. If a patron’s barcode is mistakenly replaced, the old barcode may be reinstated. Retrieve the patron record as described in the section -<>. Open the patron record in -edit mode as described in the section <>. +<>. Open the patron record in +edit mode as described in the section <>. Select the _See All_ button next to the _Replace Barcode_ button. This will display the current and past barcodes associated with this account. @@ -226,10 +225,10 @@ indexterm:[patrons, passwords] A patron’s password may be reset from the OPAC or through the staff client. To reset the password from the staff client, retrieve the patron record as -described in the section <>. +described in the section <>. Open the patron record in edit mode as described in the section -<>. +<>. Select the _Reset Password_ button next to the _Password_ field. @@ -275,10 +274,10 @@ indexterm:[patrons, barring] A patron may be barred from circulation activities. To bar a patron, retrieve the patron record as described in the section -<>. +<>. Open the patron record in edit mode as described in the section -<>. +<>. Check the box for _Barred_ in the patron account. @@ -320,21 +319,21 @@ patrons, but staff may be given permissions to override blocks. Staff-Generated Messages ~~~~~~~~~~~~~~~~~~~~~~~~ -[[staff_generated_messages_wc]] +[[staff_generated_messages]] indexterm:[patrons, messages] There are several types of messages available for staff to leave notes on patron records. *Patron Notes*: These notes are added via _Other_ -> _Notes_ in the patron record. These notes can be viewable by staff only or shared with the patron. Staff initials can be required. (See the section <> for more.) -*Patron Alerts*: This type of alert is added via _Edit_ button in the patron record. There is currently no way to require staff initials for this type of alert. (See the section <> for more.) +*Patron Alerts*: This type of alert is added via _Edit_ button in the patron record. There is currently no way to require staff initials for this type of alert. (See the section <> for more.) *Staff-Generated Penalties/Messages*: These messages are added via the _Messages_ button in the patron record. They can be a note, alert or block. Staff initials can be required. (See the section <> for more.) Patron Alerts ~~~~~~~~~~~~~~ -[[circulation_patron_alerts_wc]] +[[circulation_patron_alerts]] indexterm:[patrons, Alerts] When an account has an alert on it, a Stop sign is displayed when the record is @@ -358,10 +357,10 @@ been renewed), the message will disappear automatically. *Staff-generated alerts*: Must be added and removed manually. To add an alert to a patron account, retrieve the patron record as described -in the section <>. +in the section <>. Open the patron record in edit mode as described in the section -<>. +<>. Enter the alert text in the Alert Message field. @@ -370,10 +369,10 @@ image::media/circulation_patron_records-20.png[circulation_patron_records 20] _Save_ the record. The screen will refresh and the alert will display. To remove the alert, retrieve the patron record as described in the section -<>. +<>. Open the patron record in edit mode as described in the section -<>. +<>. Delete the alert text in the _Alert Message_ field. @@ -385,6 +384,9 @@ the account. Patron Notes ~~~~~~~~~~~~ +[[circulation_patron_notes]] +indexterm:[patrons, Notes] + Notes are strictly communicative and may be made visible to the patron via their account on the OPAC. In the OPAC, these notes display on the account summary screen in the OPAC. @@ -392,10 +394,10 @@ screen in the OPAC. image::media/circulation_patron_records-23_web_client.png[circulation_patron_records 23] To insert or remove a note, retrieve the patron record as described in the -section <>. +section <>. Open the patron record in edit mode as described in the section -<>. +<>. Use the Other menu to navigate to _Notes_. diff --git a/docs/root.txt b/docs/root.txt index f516acd14e..7cbf040986 100644 --- a/docs/root.txt +++ b/docs/root.txt @@ -166,30 +166,21 @@ include::admin/apache_rewrite_tricks.txt[] include::admin/apache_access_handler.txt[] -Using the Staff Client -====================== +Using the Browser Staff Client +============================== Introduction ------------ -This part of the documentation deals with general Staff Client usage including +This part of the documentation deals with general Browser Client usage including logging in, navigation and shortcuts. +For information about the XUL client, consult the http://docs.evergreen-ils.org/2.11/[Evergreen 2.11 documentation]. -include::admin/staff_client-login.txt[] - -include::admin/staff_client-button_bar_toolbar.txt[] - -include::admin/staff_client-sticky_settings.txt[] - -include::admin/staff_client-tab_buttons.txt[] - -include::admin/staff_client-double_clicking.txt[] - -include::admin/staff_client-patron_border.txt[] +include::admin/web_client-login.txt[] -include::admin/staff_client-sorting_columns.txt[] +include::admin/web_client-browser-tab-shortcuts.txt[] include::admin/staff_client-column_picker.txt[] @@ -207,8 +198,6 @@ include::admin/workstation_admin_receipt_template_editor.txt[] // Return to normal title levels. :leveloffset: 0 -include::admin/workstation_admin_customizable_toolbar.txt[] - System Administration From the Staff Client =========================================== @@ -317,11 +306,10 @@ include::acquisitions/purchase_requests_management.txt[] Cataloging ========== -Introduction ------------- +include::cataloging/cataloging_web_client.txt[] + +include::cataloging/copy-buckets_web_client.txt[] -Cataloguers should use this part for understanding the cataloguing procedures -used in Evergreen. include::cataloging/MARC_Editor.txt[] @@ -384,13 +372,13 @@ Introduction Use this section for understanding the circulation procedures in the Evergreen system. -include::circulation/circulating_items.txt[] +include::circulation/circulating_items_web_client.txt[] include::circulation/holds.txt[] include::circulation/booking.txt[] -include::circulation/circulation_patron_records.txt[] +include::circulation/circulation_patron_records_web_client.txt[] include::circulation/triggered_events.txt[] @@ -436,127 +424,6 @@ include::reports/reporter_template_enhancements.txt[] include::reports/reporter_export_usingpgAdmin.txt[] -Web Client Preview -================== - -Introduction ------------- - -The Evergreen Web Staff Client is in the early stages of development and is -being provided as a "preview" version beginning in Evergreen version 2.7. If -you are an early adopter, thank you! Please keep in mind: - - . *We want your feedback!* Please report any errors, bugs, strange behavior, -etc. using https://bugs.launchpad.net/evergreen/[Launchpad]. And please send -requested features or design improvements to the -mailto:open-ils-dev@list.georgialibraries.org[Evergreen Developers email list]. - - . *It is changing rapidly.* Features are being added in "sprints" grouped by -workflow. Read the -http://evergreen-ils.org/dokuwiki/doku.php?id=dev:browser_staff:dev_sprints[development -wiki page] and watch the -http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general -email list] for updates. (However, these changes will only appear on your client -when your version of Evergreen is upgraded. Ask your server administrator for -details.) - - . *The design may change significantly.* Initially, it will follow the design -of the current XUL-based staff client. But the browser framework provides more -flexibility for design choices. Also, Evergreen hired an -http://lima-julia.tumblr.com/EG-style-guide[intern] from December 2014 through -March 2015 to create a -http://evergreen-ils.org/documentation/previews/proposed_style_guide.html[User -Interface Style Guide]. Watch http://evergreen-ils.org/communicate/irc/[IRC] and the -http://libmail.georgialibraries.org/mailman/listinfo/open-ils-general[general -email list] to follow the progress. - -The following rationale was published in the Release Notes for Evergreen 2.7: -==== -The 2.7 release will contain a preview of web client circulation features. -Circulation is the first step in moving all staff functions from the existing -XULRunner-based client to a web application that will be based on AngularJS. - -Evergreen is moving away from the existing client because XULRunner no longer -supports features critical to the Evergreen software, including remote XUL, -multi-part streaming, and XML JavaScript. The new web client is expected to show -some speed improvements, to provide comprehensive support for -internationalization/localization, to provide good support for assistive -technologies, to be easier to customize locally, and to be more mobile friendly. - -The intent of the preview is to make it easier for end users at Evergreen sites -to try the new client, become familiar with its features, and to discover/report -bugs that are found. Instructions to implement the web client can be found in -the code in Open-ILS/web/js/ui/default/staff/README.install. These will be -revised and moved to the full README for 2.7.1. -==== - -Evergreen 2.9 includes the following improvements to the web client preview: -==== -The web staff client now includes additional functionality to support -cataloging and item maintenance, including: - -- a new MARC editor -- the service backing the authority headings chooser now has the ability - to filter the browse by subject thesaurus -- Z39.50 search and record import -- improvements to copy and record bucket functionality -- embedding the link checker interface -- embedding the MARC batch import/export interface -- the web staff volume/copy editor - -Nearly all of the cataloging functionality available in the XUL staff client is -now present in the web staff client with the exception of printing spine -labels. Nonetheless, the web staff client remains a preview and is not -recommended for production use. -==== - - -Using the Web Client --------------------- - -Introduction -~~~~~~~~~~~~ -This part of the documentation deals with general client usage including -logging in, navigation and shortcuts. - -// Push titles down one level. -:leveloffset: 1 - -include::admin/web_client-login.txt[] - -include::admin/web_client-browser-tab-shortcuts.txt[] - -// Return to normal title levels. -:leveloffset: 0 - -Circulation ------------ -Use this section for understanding the circulation procedures in the Evergreen system. - -// Push titles down one level. -:leveloffset: 1 - -include::circulation/circulating_items_web_client.txt[] - -include::circulation/circulation_patron_records_web_client.txt[] - -// Return to normal title levels. -:leveloffset: 0 - -Cataloging ----------- - -// Push titles down one level. -:leveloffset: 1 - -include::cataloging/cataloging_web_client.txt[] - -include::cataloging/copy-buckets_web_client.txt[] - -// Return to normal title levels. -:leveloffset: 0 - - Using the Public Access Catalog =============================== -- 2.43.2