From 1716acfe6fdf0dbfb66b3e0e1d875ad1c7de34aa Mon Sep 17 00:00:00 2001 From: Jane Sandberg Date: Fri, 8 Sep 2017 10:02:35 -0700 Subject: [PATCH 1/1] Docs reorg: adding a circulation manual Signed-off-by: Jane Sandberg --- docs/admin/web_client-login.adoc | 8 ++- .../{holds.adoc => advanced_holds.adoc} | 70 ------------------- docs/circulation/basic_holds.adoc | 64 +++++++++++++++++ ...circulation_patron_records_web_client.adoc | 6 +- docs/circulation/offline_mode.adoc | 3 + docs/circulation/triggered_events.adoc | 3 + docs/opac/tpac_meta_record_holds.adoc | 2 +- docs/root.adoc | 9 ++- docs/root_circulation.adoc | 64 +++++++++++++++++ docs/shared/about_evergreen.adoc | 26 +++++++ docs/shared/about_this_documentation.adoc | 14 ++++ docs/{ => shared}/attributions.adoc | 0 docs/shared/end_matter.adoc | 36 ++++++++++ 13 files changed, 226 insertions(+), 79 deletions(-) rename docs/circulation/{holds.adoc => advanced_holds.adoc} (85%) create mode 100644 docs/circulation/basic_holds.adoc create mode 100644 docs/root_circulation.adoc create mode 100644 docs/shared/about_evergreen.adoc create mode 100644 docs/shared/about_this_documentation.adoc rename docs/{ => shared}/attributions.adoc (100%) create mode 100644 docs/shared/end_matter.adoc diff --git a/docs/admin/web_client-login.adoc b/docs/admin/web_client-login.adoc index ae1075ee71..c464a0db60 100644 --- a/docs/admin/web_client-login.adoc +++ b/docs/admin/web_client-login.adoc @@ -1,8 +1,10 @@ Logging into Evergreen ----------------------- +Basic Login +~~~~~~~~~~~ + indexterm:[staff client, logging in] -indexterm:[SSL certificate] . The default URL to log into the client is _https://localhost/eg/staff/login_ . Enter your _Username_ and _Password_. @@ -11,8 +13,8 @@ indexterm:[SSL certificate] Although workstation registration is not required in the web client, it is highly recommended that you register the workstation for all web client features to work correctly. If you have not yet registered a workstation, you need to log -in with the workstation field unset and then follow instructions to -<>. +in with the workstation field unset, then answer the prompts to register and use +a new workstation. [[browser_defaults]] Setting Browser Defaults for Web Client diff --git a/docs/circulation/holds.adoc b/docs/circulation/advanced_holds.adoc similarity index 85% rename from docs/circulation/holds.adoc rename to docs/circulation/advanced_holds.adoc index f573d4642b..bd770bb530 100644 --- a/docs/circulation/holds.adoc +++ b/docs/circulation/advanced_holds.adoc @@ -1,73 +1,3 @@ - -Holds Management ----------------- - -Placing Holds -~~~~~~~~~~~~~ - -Holds can be placed by staff in the _Staff Client_ and by patrons in the OPAC. In this chapter we demonstrate placing holds in the _Staff Client_. - -Holds Levels -~~~~~~~~~~~~ - -Evergreen has different levels of holds. Library staff can place holds at all levels, while patrons can only place title-level holds, and parts-level holds. The chart below summarizes the levels of holds. - -|============================== -|*Hold level* |*Abbreviation* |*When to use* |*How to use* |*Who can use* |*Hold tied to* -|Title |T |Patron wants first available copy of a title | Staff or patron click on _Place Hold_ next to title. | Patron or staff | Holdings attached to a single MARC (title) record -|Parts |P |Patron wants a particular part of title (e.g. volume or disk number) | Staff or patron selects part on the create/edit hold screen when setting holds notification options. |Patron or staff |Holdings with identical parts attached to a single MARC (title) record. -|Volume |V |Patron or staff want any title associated with a particular call number | In the staff client, click on _Volume Hold_ under _Holdable?_ |Staff only |Holdings attached to a single call number (volume) -|Copy |C |Patron or staff want a specific copy of an item |In the staff client, click on _Copy Hold_ under _Holdable?_ |Staff only |A specific copy (barcode) -|=============================== - - -Title Level Hold -~~~~~~~~~~~~~~~~ - -[TIP] -==================== -A default hold expiration date will be displayed if the library has set up a default holds expiration period in their library settings. Uncaptured holds will not be targeted after the expiration date. - -If you select the _Suspend this Hold_ checkbox, the hold will be suspended and not be captured until you activate it. -==================== - -. To place a title level hold, retrieve the title record on the catalog and click the _Place Hold_ link beside the title on the search results list, or click the _Place Hold_ link on the title summary screen. -+ -image::media/holds_title_searchresults.png[Search Results with Place Hold link] -+ -. Scan or type patron's barcode into the _Place hold for patron by -barcode_ box, or choose _Place this hold for me_. -. If this title contains multiple parts, you can specify which part to -request. If you do not select a part, the hold will target any of the -other copies on this record, that is, those with no parts attached. -Those copies are usually the complete set, containing all the parts. -. Edit patron hold notification and expiration date fields as required. -Be sure to choose a valid _Pickup location_. -. Click _Submit_. -+ -image::media/holds_title_options.png[Place Holds screen with Basic Options] -+ -. A confirmation screen appears with the message "Hold was successfully placed". -+ -image::media/holds_title_success.png[Place Holds confirmation screen] - -*Advanced Hold Options* - -Clicking the *Advanced Hold Options* link will take you into the -metarecord level hold feature, where you can select multiple formats -and/or languages, if available. - -Selecting multiple formats will not place all of these formats on hold. -For example, selecting CD Audiobook and Book implies that either the CD -format or the book format is the acceptable format to fill the hold. If -no format is selected, then any of the available formats may be used to -fill the hold. The same holds true for selecting multiple languages. - -image::media/holds_title_options_adv.png[Place Hold screen with Advanced Options] - -See also the section on placing <<_tpac_metarecord_search_and_metarecord_level_holds, -Metarecord Holds>>. - Parts Level Hold ~~~~~~~~~~~~~~~~ diff --git a/docs/circulation/basic_holds.adoc b/docs/circulation/basic_holds.adoc new file mode 100644 index 0000000000..bf50b8a316 --- /dev/null +++ b/docs/circulation/basic_holds.adoc @@ -0,0 +1,64 @@ + +Placing Holds +~~~~~~~~~~~~~ + +Holds can be placed by staff in the _Staff Client_ and by patrons in the OPAC. In this chapter we demonstrate placing holds in the _Staff Client_. + +Holds Levels +~~~~~~~~~~~~ + +Evergreen has different levels of holds. Library staff can place holds at all levels, while patrons can only place title-level holds, and parts-level holds. The chart below summarizes the levels of holds. + +|============================== +|*Hold level* |*Abbreviation* |*When to use* |*How to use* |*Who can use* |*Hold tied to* +|Title |T |Patron wants first available copy of a title | Staff or patron click on _Place Hold_ next to title. | Patron or staff | Holdings attached to a single MARC (title) record +|Parts |P |Patron wants a particular part of title (e.g. volume or disk number) | Staff or patron selects part on the create/edit hold screen when setting holds notification options. |Patron or staff |Holdings with identical parts attached to a single MARC (title) record. +|Volume |V |Patron or staff want any title associated with a particular call number | In the staff client, click on _Volume Hold_ under _Holdable?_ |Staff only |Holdings attached to a single call number (volume) +|Copy |C |Patron or staff want a specific copy of an item |In the staff client, click on _Copy Hold_ under _Holdable?_ |Staff only |A specific copy (barcode) +|=============================== + + +Title Level Hold +~~~~~~~~~~~~~~~~ + +[TIP] +==================== +A default hold expiration date will be displayed if the library has set up a default holds expiration period in their library settings. Uncaptured holds will not be targeted after the expiration date. + +If you select the _Suspend this Hold_ checkbox, the hold will be suspended and not be captured until you activate it. +==================== + +. To place a title level hold, retrieve the title record on the catalog and click the _Place Hold_ link beside the title on the search results list, or click the _Place Hold_ link on the title summary screen. ++ +image::media/holds_title_searchresults.png[Search Results with Place Hold link] ++ +. Scan or type patron's barcode into the _Place hold for patron by +barcode_ box, or choose _Place this hold for me_. +. If this title contains multiple parts, you can specify which part to +request. If you do not select a part, the hold will target any of the +other copies on this record, that is, those with no parts attached. +Those copies are usually the complete set, containing all the parts. +. Edit patron hold notification and expiration date fields as required. +Be sure to choose a valid _Pickup location_. +. Click _Submit_. ++ +image::media/holds_title_options.png[Place Holds screen with Basic Options] ++ +. A confirmation screen appears with the message "Hold was successfully placed". ++ +image::media/holds_title_success.png[Place Holds confirmation screen] + +*Advanced Hold Options* + +Clicking the *Advanced Hold Options* link will take you into the +metarecord level hold feature, where you can select multiple formats +and/or languages, if available. + +Selecting multiple formats will not place all of these formats on hold. +For example, selecting CD Audiobook and Book implies that either the CD +format or the book format is the acceptable format to fill the hold. If +no format is selected, then any of the available formats may be used to +fill the hold. The same holds true for selecting multiple languages. + +image::media/holds_title_options_adv.png[Place Hold screen with Advanced Options] + diff --git a/docs/circulation/circulation_patron_records_web_client.adoc b/docs/circulation/circulation_patron_records_web_client.adoc index 747f5928c5..0b8a6ade4b 100644 --- a/docs/circulation/circulation_patron_records_web_client.adoc +++ b/docs/circulation/circulation_patron_records_web_client.adoc @@ -407,9 +407,9 @@ Select the _Add New Note_ button. A _Create a new note_ window displays. [TIP] ================================================ -To add a box in the _Add Note_ window for staff initials and require their -entry, see the "Require staff initials..." settings in the -<<_library_settings_editor,Library Settings Editor>> section. +Your system administrator can add a box in the _Add Note_ window for staff initials and +require those initials to be entered. They can do so using the "Require staff initials..." +settings in the Library Settings Editor. ================================================ Enter note information. diff --git a/docs/circulation/offline_mode.adoc b/docs/circulation/offline_mode.adoc index 9b18907e24..3036a0b823 100644 --- a/docs/circulation/offline_mode.adoc +++ b/docs/circulation/offline_mode.adoc @@ -1,6 +1,9 @@ Offline Transactions ==================== +Introduction +------------ + Evergreen's 'Standalone Interface' / 'Offline Interface' is designed to log transactions during network outage, which can be uploaded and processed once network operations are restored. diff --git a/docs/circulation/triggered_events.adoc b/docs/circulation/triggered_events.adoc index 05781690d4..c4959ab9c6 100644 --- a/docs/circulation/triggered_events.adoc +++ b/docs/circulation/triggered_events.adoc @@ -1,6 +1,9 @@ Triggered Events and Notices ---------------------------- +Introduction +~~~~~~~~~~~~ + Improvements to the Triggered Events interface enables you to easily filter, sort, and print triggered events from the patron's account or an item's details. This feature is especially useful when tracking notice completion from a diff --git a/docs/opac/tpac_meta_record_holds.adoc b/docs/opac/tpac_meta_record_holds.adoc index 09fb0881f1..45680c5c60 100644 --- a/docs/opac/tpac_meta_record_holds.adoc +++ b/docs/opac/tpac_meta_record_holds.adoc @@ -16,7 +16,7 @@ image::media/advsrchpg_1.jpg[] [TIP] Administrators can also configure the catalog to default to a *Group Formats and -Editions* search by enabling the <> on +Editions* search by enabling the relevant config.tt2 setting on the server. Setting this option will pre-select the checkbox on the Advanced Search and Search Result Pages. Users can remove the checkmark, but new searches will revert to the default search behavior. diff --git a/docs/root.adoc b/docs/root.adoc index 7b7ae1af61..5c36a061fd 100644 --- a/docs/root.adoc +++ b/docs/root.adoc @@ -380,7 +380,12 @@ system. include::circulation/circulating_items_web_client.adoc[] -include::circulation/holds.adoc[] +Holds Management +---------------- + +include::circulation/basic_holds.adoc[] + +include::circulation/advanced_holds.adoc[] include::circulation/booking.adoc[] @@ -505,7 +510,7 @@ include::development/data_unapi.adoc[] // Return to normal title levels. :leveloffset: 0 -include::attributions.adoc[] +include::shared/attributions.adoc[] include::licensing.adoc[] diff --git a/docs/root_circulation.adoc b/docs/root_circulation.adoc new file mode 100644 index 0000000000..058739a853 --- /dev/null +++ b/docs/root_circulation.adoc @@ -0,0 +1,64 @@ +Using Evergreen's Circulation Module +==================================== +Documentation Interest Group +:doctype: book +:toc: +:numbered: + +Introduction +============ + +include::shared/about_this_documentation.adoc[] + +This guide to Evergreen is intended to meet the needs of library workers +who provide circulation services. +It is organized into Parts, Chapters, and Sections addressing key +aspects of the software. + +Copies of this guide can be accessed in PDF and HTML formats from http://docs.evergreen-ils.org/. + +include::shared/about_evergreen.adoc[] + +:leveloffset: -1 + +include::admin/web_client-login.adoc[] + +include::circulation/circulation_patron_records_web_client.adoc[] + +include::circulation/circulating_items_web_client.adoc[] + +:leveloffset: 0 + +Holds Management +================ + +:leveloffset: -1 + +include::circulation/basic_holds.adoc[] + +:leveloffset: 0 + +include::opac/tpac_meta_record_holds.adoc[] + +:leveloffset: -1 + +include::circulation/advanced_holds.adoc[] + +:leveloffset: 0 + +include::circulation/offline_mode.adoc[] + +:leveloffset: -1 + +include::circulation/booking.adoc[] + +include::circulation/triggered_events.adoc[] + +:leveloffset: 0 + + + +include::shared/attributions.adoc[] + +include::shared/end_matter.adoc[] + diff --git a/docs/shared/about_evergreen.adoc b/docs/shared/about_evergreen.adoc new file mode 100644 index 0000000000..1d3944828a --- /dev/null +++ b/docs/shared/about_evergreen.adoc @@ -0,0 +1,26 @@ +About Evergreen +--------------- + +Evergreen is an open source library automation software designed to meet the +needs of the very smallest to the very largest libraries and consortia. Through +its staff interface, it facilitates the management, cataloging, and circulation +of library materials, and through its online public access interface it helps +patrons find those materials. + +The Evergreen software is freely licensed under the GNU General Public License, +meaning that it is free to download, use, view, modify, and share. It has an +active development and user community, as well as several companies offering +migration, support, hosting, and development services. + +The community's development requirements state that Evergreen must be: + +* Stable, even under extreme load. +* Robust, and capable of handling a high volume of transactions and simultaneous users. +* Flexible, to accommodate the varied needs of libraries. +* Secure, to protect our patrons’ privacy and data. +* User-friendly, to facilitate patron and staff use of the system. + +Evergreen, which first launched in 2006 now powers over 544 libraries of every +type – public, academic, special, school, and even tribal and home libraries – +in over a dozen countries worldwide. + diff --git a/docs/shared/about_this_documentation.adoc b/docs/shared/about_this_documentation.adoc new file mode 100644 index 0000000000..6b33cba6bb --- /dev/null +++ b/docs/shared/about_this_documentation.adoc @@ -0,0 +1,14 @@ +About This Documentation +------------------------ + +This guide was produced by the Evergreen Documentation Interest Group (DIG), +consisting of numerous volunteers from many different organizations. The DIG +has drawn together, edited, and supplemented pre-existing documentation +contributed by libraries and consortia running Evergreen that were kind enough +to release their documentation into the creative commons. Please see the +<> section for a full list of authors and +contributing organizations. Just like the software it describes, this guide is +a work in progress, continually revised to meet the needs of its users, so if +you find errors or omissions, please let us know, by contacting the DIG +facilitators at docs@evergreen-ils.org. + diff --git a/docs/attributions.adoc b/docs/shared/attributions.adoc similarity index 100% rename from docs/attributions.adoc rename to docs/shared/attributions.adoc diff --git a/docs/shared/end_matter.adoc b/docs/shared/end_matter.adoc new file mode 100644 index 0000000000..4da392a2da --- /dev/null +++ b/docs/shared/end_matter.adoc @@ -0,0 +1,36 @@ +[appendix] +Admonitions +=========== + +* Note + +image::media/note.png[] + +* warning + +image::media/warning.png[] + +* caution + +image::media/caution.png[] + +* tip + +image::media/tip.png[] + +[[licensing]] +[appendix] +Licensing +========= + +image::media/ccbysa.png["CC-BY-SA",link="http://creativecommons.org/licenses/by-sa/3.0/"] + +This work is licensed under a +link:http://creativecommons.org/licenses/by-sa/3.0/[Creative +Commons Attribution-ShareAlike 3.0 Unported License]. + + +[index] +Index +===== + -- 2.43.2