LP#1848524: Docs: Adding recent docs changes to the antora version
authorJane Sandberg <sandbej@linnbenton.edu>
Tue, 31 Dec 2019 15:50:09 +0000 (07:50 -0800)
committerGalen Charlton <gmc@equinoxinitiative.org>
Fri, 4 Sep 2020 20:38:31 +0000 (16:38 -0400)
Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>

16 files changed:
docs-antora/modules/admin/assets/images/worklog.png [new file with mode: 0644]
docs-antora/modules/admin/pages/lsa-work_log.adoc
docs-antora/modules/admin_initial_setup/assets/images/carousel1.png [new file with mode: 0644]
docs-antora/modules/admin_initial_setup/assets/images/carousel2.png [new file with mode: 0644]
docs-antora/modules/admin_initial_setup/assets/images/carousel3.png [new file with mode: 0644]
docs-antora/modules/admin_initial_setup/assets/images/carousel4.png [new file with mode: 0644]
docs-antora/modules/admin_initial_setup/assets/images/carousel5.png [new file with mode: 0644]
docs-antora/modules/admin_initial_setup/assets/images/carousel6.png [new file with mode: 0644]
docs-antora/modules/admin_initial_setup/assets/images/carousel7.png [new file with mode: 0644]
docs-antora/modules/admin_initial_setup/assets/images/carousel8.png [new file with mode: 0644]
docs-antora/modules/admin_initial_setup/nav.adoc
docs-antora/modules/admin_initial_setup/pages/carousels.adoc [new file with mode: 0644]
docs-antora/modules/appendix/nav.adoc
docs-antora/modules/appendix/pages/glossary.adoc [new file with mode: 0644]
docs-antora/modules/cataloging/nav.adoc
docs-antora/modules/cataloging/pages/item_status.adoc

diff --git a/docs-antora/modules/admin/assets/images/worklog.png b/docs-antora/modules/admin/assets/images/worklog.png
new file mode 100644 (file)
index 0000000..22a1f1b
Binary files /dev/null and b/docs-antora/modules/admin/assets/images/worklog.png differ
index e0cd587..c13b2f7 100644 (file)
@@ -1,24 +1,19 @@
 Work Log
 -------- 
+indexterm:[Work Log]
+indexterm:[staff client, Work Log]
+indexterm:[workstation, Work Log]
+
 
 === Expanding the Work Log ===
 
-In versions of Evergreen prior to 2.3, the work log recorded check ins,
-checkouts, patron registration, patron editing, and renewals.  In version 2.3,
-the work log also records holds that have been placed and payments that have
-been received.
+The Work Log records checkins, checkouts, patron registration, patron editing, renewals, payments and holds placed from with the patron record for a given login. 
+
+To access the Work Log go to *Administration* -> *Local Administration* ->  *Work Log*. 
 
-In this example, a staff member has collected a fine from a patron.  To view
-this action in the work log, click *Administration* -> *Local Administration* ->  *Work
-Log*.  By default, the work log will record the staff member's username, the
-amount that was received, the payment type, the patron's barcode, and the
-patron's last name.
+There are two seperate logs, *Most Recently Logged Staff Actions* and *Most Recently Affected patrons*. The *Most Recently Logged Staff Actions* logs the the transactions in order they have occured on the workstation.  The *Most Recently Affected Patrons* log is a listing of the last patrons that transactions happened on. 
 
-image::media/Expanding_the_Work_Log1.jpg[Expanding_the_Work_Log1]
+The Work Log can contain a maximum number of transactions, this number is set via the <<library_settings_editor,Library Settings Editor>>. They are in the GUI group of settings. *Work Log: Maximum Actions Logged* effects the number of transactions listing under the *Most Recently Logged Staff Actions* and *Work Log: Maximum Patrons Logged* limits the number of patrons that are listed in the log. 
 
-In this example, a staff member has placed a hold for a patron.  To view this
-action in the work log, click *Administration* -> *Local Administration* ->  *Work Log*.
-By default, the work log will record the staff member's username, the hold type,
-the patron's barcode, and the patron's last name.
+image::worklog.png[Work Log]
 
-image::media/Expanding_the_Work_Log2.jpg[Expanding_the_Work_Log2]
diff --git a/docs-antora/modules/admin_initial_setup/assets/images/carousel1.png b/docs-antora/modules/admin_initial_setup/assets/images/carousel1.png
new file mode 100644 (file)
index 0000000..6ec0e14
Binary files /dev/null and b/docs-antora/modules/admin_initial_setup/assets/images/carousel1.png differ
diff --git a/docs-antora/modules/admin_initial_setup/assets/images/carousel2.png b/docs-antora/modules/admin_initial_setup/assets/images/carousel2.png
new file mode 100644 (file)
index 0000000..c2570ec
Binary files /dev/null and b/docs-antora/modules/admin_initial_setup/assets/images/carousel2.png differ
diff --git a/docs-antora/modules/admin_initial_setup/assets/images/carousel3.png b/docs-antora/modules/admin_initial_setup/assets/images/carousel3.png
new file mode 100644 (file)
index 0000000..44eee8b
Binary files /dev/null and b/docs-antora/modules/admin_initial_setup/assets/images/carousel3.png differ
diff --git a/docs-antora/modules/admin_initial_setup/assets/images/carousel4.png b/docs-antora/modules/admin_initial_setup/assets/images/carousel4.png
new file mode 100644 (file)
index 0000000..8c6fa31
Binary files /dev/null and b/docs-antora/modules/admin_initial_setup/assets/images/carousel4.png differ
diff --git a/docs-antora/modules/admin_initial_setup/assets/images/carousel5.png b/docs-antora/modules/admin_initial_setup/assets/images/carousel5.png
new file mode 100644 (file)
index 0000000..a492886
Binary files /dev/null and b/docs-antora/modules/admin_initial_setup/assets/images/carousel5.png differ
diff --git a/docs-antora/modules/admin_initial_setup/assets/images/carousel6.png b/docs-antora/modules/admin_initial_setup/assets/images/carousel6.png
new file mode 100644 (file)
index 0000000..e4106c0
Binary files /dev/null and b/docs-antora/modules/admin_initial_setup/assets/images/carousel6.png differ
diff --git a/docs-antora/modules/admin_initial_setup/assets/images/carousel7.png b/docs-antora/modules/admin_initial_setup/assets/images/carousel7.png
new file mode 100644 (file)
index 0000000..5e71110
Binary files /dev/null and b/docs-antora/modules/admin_initial_setup/assets/images/carousel7.png differ
diff --git a/docs-antora/modules/admin_initial_setup/assets/images/carousel8.png b/docs-antora/modules/admin_initial_setup/assets/images/carousel8.png
new file mode 100644 (file)
index 0000000..85e1541
Binary files /dev/null and b/docs-antora/modules/admin_initial_setup/assets/images/carousel8.png differ
index c83b89a..0920fd9 100644 (file)
@@ -1,5 +1,4 @@
-* xref:admin_initial_setup:introduction.adoc[System Configuration and
-* Customization]
+* xref:admin_initial_setup:introduction.adoc[System Configuration and Customization]
 ** xref:admin_initial_setup:describing_your_organization.adoc[]
 ** xref:admin_initial_setup:describing_your_people.adoc[]
 ** xref:admin_initial_setup:migrating_patron_data.adoc[]
@@ -13,6 +12,7 @@
 ** xref:admin:autorenewals.adoc[]
 ** xref:admin_initial_setup:hard_due_dates.adoc[]
 ** xref:admin:template_toolkit.adoc[]
+** xref:admin_initial_setup:carousels.adoc[Carousels]
 ** xref:opac:new_skin_customizations.adoc[]
 ** xref:admin:auto_suggest_search.adoc[]
 ** xref:admin:authentication_proxy.adoc[]
diff --git a/docs-antora/modules/admin_initial_setup/pages/carousels.adoc b/docs-antora/modules/admin_initial_setup/pages/carousels.adoc
new file mode 100644 (file)
index 0000000..405b21d
--- /dev/null
@@ -0,0 +1,264 @@
+Adding Carousels to Your Public Catalog
+---------------------------------------
+
+This feature fully integrates the creation and management of book carousels into Evergreen, allowing for the display of book cover images on a library’s public catalog home page. Carousels may be animated or static. They can be manually maintained by staff or automatically maintained by Evergreen. Titles can appear in carousels based on newly cataloged items, recent returns, popularity, etc. Titles must have copies that are visible to the public catalog, be circulating, and holdable to appear in a carousel. Serial titles cannot be displayed in carousels. 
+
+image::carousel1.png[Book carousel on public catalog front screen] 
+
+There are three administrative interfaces used to create and manage carousels and their components: 
+
+* <<carousel_types,Carousel Types>> - used to define different types of carousels 
+* <<carousel_definitions,Carousels>> - used to create and manage specific carousel definitions
+* <<carousel_mapping,Carousel Library Mapping>> - used to manage which libraries will display specific carousels, as well as the default display order on a library’s public catalog home page
+
+Each of these interfaces are detailed below.
+
+[[carousel_types]]
+CAROUSEL TYPES
+~~~~~~~~~~~~~~
+
+The Carousel Types administrative interface is used to create, edit, or delete carousel types. Carousel Types define the attributes of a carousel, such as whether it is automatically managed and how it is filtered. A carousel must be associated with a carousel type to function properly.  
+
+There are five stock Carousel Types:
+
+* *Newly Cataloged Items* - titles appear automatically based on the active date of the title’s copies
+* *Recently Returned Items* - titles appear automatically based on the mostly recently circulated copy’s check-in scan date and time 
+* *Top Circulated Titles* - titles appear automatically based on the most circulated copies in the Item Libraries identified in the carousel definition; titles are chosen based on the number of action.circulation rows created during an interval specified in the carousel definition and includes both circulations and renewals
+* *Newest Items by Shelving Location* - titles appear automatically based on the active date and shelving location of the title’s copies 
+* *Manual* - titles are added and managed manually by library staff
+
+Additional types can be created in the Carousel Types Interface. Types can also be modified or deleted. Access the interface by going to Administration > Server Administration > Carousel Types. 
+
+The interface displays the list of carousel types in a grid format. The grid displays the Carousel Type ID, name of the carousel type, and the characteristics of each type by default. The Actions Menu is used to edit or delete a carousel type.
+
+image::carousel2.png[Carousel Types configuration screen]
+
+Attributes of Carousel Types 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
+Each Carousel Type defines attributes used to add titles to the carousels associated with the type. Filters apply only to automatically managed carousels.
+
+* *Automatically Managed* - when set to true, Evergreen uses a cron job to add titles to a carousel automatically based on a set of criteria established in the carousel definition. When set to false, library staff must enter the contents of a carousel manually.
+* *Filter by Age* - when set to true, the type includes or excludes titles based on the age of their attached items
+* *Filter by Item Owning Library* - when set to true, the type includes or excludes titles based the owning organizational unit of their attached items
+* *Filter by Item Location* - when set to true, the type includes or excludes titles based on the shelving locations of their attached items
+
+Creating a Carousel Type
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+. Go to Administration > Server Administration > Carousel Types
+. Select the *New Carousel Type* button
+. Enter a name for the carousel type
+. Use the checkboxes to apply filtering characteristics to the carousel type; filters for age, item owning library, and location are applied only to automatically managed carousels 
+  .. Automatically Managed?
+  .. Filter by Age?
+  .. Filter by Item Owning Library?
+  .. Filter by Item Location?
+
+image::carousel3.png[Carousel Types Editor screen]
+
+Editing a Carousel Type
+^^^^^^^^^^^^^^^^^^^^^^^
+Users can rename a carousel type or change the characteristics of existing types.
+
+. Go to Administration > Server Administration > Carousel Types
+. Select the type you wish to edit with the checkbox at the beginning of the row for that type
+. Select the Actions Button (or right-click on the type’s row) and choose Edit Type
+
+Deleting a Carousel Type
+^^^^^^^^^^^^^^^^^^^^^^^^
+Carousel types can be deleted with the Actions Menu
+
+. Go to Administration > Server Administration > Carousel Types
+. Select the type you wish to delete with the checkbox at the beginning of the row for that type
+. Select the Actions button (or right-click on the type’s row) and choose Delete Type; carousel types cannot be deleted if there are carousels attached
+
+[[carousel_definitions]]
+CAROUSEL DEFINITIONS
+~~~~~~~~~~~~~~~~~~~~
+The Carousels administration page is used to define the characteristics of the carousel, such as the carousel type, which libraries will be able to display the carousel, and which shelving locations should be used to populate the carousel.
+
+The Carousels administration page is accessed through Administration > Server Administration > Carousels. (Please note that in the community release, this page will eventually move to Local Administration.) The interface displays existing carousels in a grid format. The grid can be filtered by organizational unit, based on ownership. The filter may include ancestor or descendent organization units, depending on the scope chosen. The columns displayed correspond to attributes of the carousel. The following are displayed by default: Carousel ID, Carousel Type, Owner, Name, Last Refresh Time, Active, Maximum Items. 
+
+image::carousel4.png[Carousels configuration screen]
+
+Additional columns may be added to the display with the column picker, including the log in of the creator and/or editor, the carousel’s creation or edit time, age limit, item libraries, shelving locations, or associated record bucket. 
+
+Attributes of a Carousel Definition
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* *Carousel ID* - unique identifier assigned by Evergreen when the carousel is created
+* *Carousel Type* - identifies the carousel type associated with the carousel
+* *Owner* - identifies the carousel’s owning library organizational unit
+* *Name* - the name or label of the carousel
+* *Bucket* - once the carousel is created, this field displays a link to the carousel’s corresponding record bucket
+* *Age Limit* - defines the age limit for the items (titles) that are displayed in the carousel
+* *Item Libraries* - identifies which libraries should be used for locating items/titles to add to the carousel; this attribute does not check organizational unit inheritance, so include all libraries that should be used
+* *Shelving Locations* - sets which shelving locations can/should be used to find titles for the carousel
+* *Last Refresh Time* - identifies the last date when the carousel was refreshed, either automatically or manually. This is currently read-only value.
+* *Is Active* - when set to true, the carousel is visible to the public catalog; automatically-maintained carousels are refreshed regularly (inactive automatic carousels are not refreshed)
+* *Maximum Items* - defines the maximum number of titles that should appear in the carousel; this attribute is enforced only for automatically maintained carousels
+
+
+Creating a Carousel from the Carousels Administration Page
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+. Go to Administration > Server Administration > Carousels
+. Select the *New Carousels* button
+. A popup will open where you will enter information about the carousel
+. Choose the Carousel Type from the drop-down menu
+. Choose the Owning Library from the drop-down
+. Enter the Name of the carousel
+. Enter the Age limit - this field accepts values such as “6 mons or months,” “21 days,” etc.
+. Choose the Item Libraries - this identifies the library from which items are pulled to include in the carousel
+  .. Click the field. A list of available organizational units will appear.
+  .. Select the organizational unit(s)
+   ... The owning and circulating libraries must be included on this list for titles/items to appear in the carousel. For libraries with items owned at one organizational unit (e.g., the library system), but circulating at a different organizational unit (e.g., a branch), both would need to be included in the list.
+  .. Click Add
+. Shelving Locations - this identifies the shelving locations from which items are pulled to include in the carousel. Please note that this field is not applicable when creating a carousel of the Newly Cataloged carousel type. For creating a carousel of newly cataloged items with shelving location filters, use the Newest Items by Shelving Location type instead.
+  .. Click the field. A list of available shelving locations will appear.
+  .. Select the shelving location - the library that “owns” the shelving location does not have to be included in the list of Item Libraries
+  .. Click Add
+. Last Refresh Time - not used while creating carousels - display the date/time when the carousel was most recently refreshed
+. Is Active - set to true for the carousel to be visible to the public catalog
+. Enter the Maximum Number of titles to display in the carousel
+. Click Save 
+
+image::carousel5.png[Carousel editor screen]
+
+Carousels and Record Buckets
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+When a carousel is created, a corresponding record bucket is also created. The bucket is owned by the staff user who created the carousel; however, access to the carousel is controlled by the carousel’s owning library. The bucket is removed if the carousel is deleted. 
+
+View a Carousel Bucket from Record Buckets
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A record bucket linked to a carousel can be displayed in the Record Bucket interface through the Shared Bucket by ID action.
+
+. Go to Cataloging > Record Buckets
+. Select the Buckets button
+. Enter the bucket number of the carousel’s bucket; this can be found on the Carousels administration page. “Bucket” is one of the column options for the grid. It displays the bucket number. 
+. The contents of the carousel and bucket will be displayed
+
+Users can add or remove records from the bucket. If the associated carousel is automatically maintained, any changes to the bucket’s contents are subject to being overwritten by the next automatic update. Users are warned of this when making changes to the bucket contents.
+
+Create a Carousel from a Record Bucket
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A carousel can be created from a record bucket.
+. Go to Cataloging > Record Buckets
+. The Bucket View tab opens. Select the Buckets button and choose one of the existing buckets to open. The list of titles in the bucket will display on the screen.
+. Select the Buckets button and choose Create Carousel from Bucket
+
+image::carousel6.png[Record Bucket Actions button - Create Carousel from Bucket]
+
+TIP: The Create Carousel from Bucket option is visible in both Record Query and Pending Buckets; however, initiating the creation of a carousel from either of these two tabs creates an empty bucket only. It will not pull titles from either to add contents to the carousel.
+
+Manually Adding Contents to a Carousel from Record Details Page
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Titles can be added to a manually maintained carousel through the record details page.
+
+. Go to the details page for a title record
+. Select the Other Actions button
+. Choose Add to Carousel
++
+image::carousel7.png[Actions button on Record Summary page - Add to Carousel] 
++
+. A drop-down with a list of manually maintained carousels that have been shared to at least one of the user’s working locations will appear
+. Choose the carousel from the list
+. Click Add to Selected Carousel
+
+TIP: The Add to Carousel menu item is disabled if no qualifying carousels are available
+
+[[carousel_mapping]]
+CAROUSEL LIBRARY MAPPING
+~~~~~~~~~~~~~~~~~~~~~~~~
+The Carousel Library Mapping administration page is used to manage which libraries will display specific carousels, as well as the default display order on a library’s public catalog. 
+
+The visibility of a carousel at a given organizational unit is not automatically inherited by the descendants of that unit. The carousel’s owning organizational unit is automatically added to the list of display organizational units.
+
+The interface is accessed by going to Administration > Server Administration > Carousel Library Mapping. (Please note that in the community release, this page will eventually move to Local Administration.) The interface produces a grid display with a list of the current mapping. The grid can be filtered by organizational unit, based on ownership. The filter may include ancestor or descendent organizational units, depending on the scope chosen. 
+
+WARNING: If a carousel is deleted, its mappings are deleted.
+
+Attributes of Carousel Library Mapping
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* *ID* - this is a unique identifier automatically generated by the database
+* *Carousel* - this is the carousel affected by the mapping
+* *Override Name* - this creates a name for automatically managed carousels that will be used in the public catalog display of the carousel instead of the carousel’s name
+* *Library* - this is the organizational unit associated with the particular mapping; excludes descendent units
+* *Sequence Number* - this is the order in which carousels will be displayed, starting with “0” (Example: Carousel 0 at consortial level will display first. Carousel 1 set at the consortial level will appear just below Carousel 0.)
+
+Create a New Carousel Mapping
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+. Go to Administration > Server Administration > Carousel Library Mapping
+. Select *New Carousels Visible at Library*
+. Choose the Carousel you wish to map from the Carousel drop-down menu
+. If you want the title of the carousel on the public catalog home screen to be different from the carousel’s name, enter your desired name in the Override Name field
+. Click on the Library field to choose on which library organizational unit’s public catalog home screen the carousel will appear
+. Enter a number in sequence number to indicate in which order the carousel should appear on the library public catalog home screen. “0” is the top level. “1” is the subsequent level, etc.
+
+image::carousel8.png[Carousel mapping editor screen]
+
+
+CAROUSELS - OTHER ADMINISTRATIVE FEATURES
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+New Staff Permissions
+^^^^^^^^^^^^^^^^^^^^^
+Includes new staff permissions:
+
+* ADMIN_CAROUSEL_TYPES - allows users to create, edit, or delete carousel types
+* ADMIN_CAROUSELS - allows users to create, edit, or delete carousels
+* REFRESH_CAROUSEL - allows users to perform a manual refresh of carousels
+
+New Database Tables
+^^^^^^^^^^^^^^^^^^^
+A new table was added to the database to specify the carousel and how it is to be populated, including the name, owning library, details about the most recent refresh, and a link to the Record Bucket and its contents.
+
+Another new table defines carousel types and includes the name, whether the carousel is manually or automatically maintained, and a link to the QStore query specifying the foundation database query used to populate the carousel.
+
+A third new table defines the set of organizational units at which the carousel is visible and the display order in which carousels should be listed at each organizational unit.
+
+OPAC Templates
+^^^^^^^^^^^^^^
+Carousels display on the public catalog home page by default. Administrators can modify the public catalog templates to display carousels where desired.
+
+A new Template Toolkit macro called “carousels” allows the Evergreen administrator to inject the contents of one or more carousels into any point in the OPAC. The macro will accept the following parameters:
+
+* carousel_id
+* dynamic (Boolean, default value false)
+* image_size (small, medium, or large)
+* width (number of titles to display on a “pane” of the carousel)
+* animated (Boolean to specify whether the carousel should automatically cycle through its panes)
+* animation_interval (the interval (in seconds) to wait before advancing to the next pane)
+
+If the carousel_id parameter is supplied, the carousel with that ID will be displayed. If carousel_id is not supplied, all carousels visible to the public catalog's physical_loc organizational unit is displayed.
+
+The dynamic parameter controls whether the entire contents of the carousel should be written in HTML (dynamic set to false) or if the contents of the carousel should be asynchronously fetched using JavaScript.
+
+A set of CSS classes for the carousels and their contents will be exposed in style.css.tt2. Lightweight JavaScript was used for navigating the carousels, based either on jQuery or native JavaScript. The carousels are responsive.
+
+Accessibility Features
+^^^^^^^^^^^^^^^^^^^^^^
+
+* Users can advance through the carousel using only a keyboard
+* Users can navigate to a title from the carousel using only a keyboard
+* Users pause animated carousels
+* Changes in the state of the carousel are announced to screen readers.
+
+OpenSRF
+^^^^^^^
+Several Evergreen APIs are used to support the following operations:
+
+* refreshing the contents of an individual carousel
+* refreshing the contents of all automatically-maintained carousels that are overdue for refresh
+* retrieving the names and contents of a carousel or all visible ones
+* creating a carousel by copying and existing record bucket
+
+The retrieval APIs allow for anonymous access to permit Evergreen admins to create alternative implementation of the carousel display or to share the carousels with other systems.
+
+Cron Job
+^^^^^^^^
+The carousels feature includes a cronjob added to the example crontab to perform automatic carousel refreshes. It is implemented as a srfsh script that invokes open-ils.storage.carousel.refresh_all.
+
index 5f82c6e..88de8ad 100644 (file)
@@ -1,3 +1,4 @@
 * xref:shared:attributions.adoc[Appendix A. Attributions]
 * xref:shared:licensing.adoc[Appendix B. Licensing]
+* xref:appendix:glossary.adoc[Glossary]
 * xref:shared:index.adoc[Index]
diff --git a/docs-antora/modules/appendix/pages/glossary.adoc b/docs-antora/modules/appendix/pages/glossary.adoc
new file mode 100644 (file)
index 0000000..a95e4bf
--- /dev/null
@@ -0,0 +1,252 @@
+[glossary]
+Evergreen Glossary
+==================
+
+xref:A[A] xref:B[B] xref:C[C] xref:D[D] xref:E[E] xref:F[F] xref:G[G] xref:H[H] xref:I[I] xref:J[J] xref:K[K] xref:L[L] xref:M[M] xref:N[N] xref:O[O] xref:P[P] xref:Q[Q] xref:R[R] xref:S[S] xref:T[T] xref:U[U] xref:V[V] xref:W[W] xref:X[X] xref:Y[Y] xref:Z[Z]
+
+[glossary]
+[[A]]AACR2 (Angolo-American Cataloguing Rules, Second Edition)::
+  AACR2 is a set of cataloging rules for descriptive cataloging of various types of resources.  http://www.aacr2.org/
+Acquisitions::
+  Processes related to ordering materials and managing expenditures.
+Age Protection:: 
+  Allows libraries to prevent holds on new books (on a item by item basis) from outside the owning library's branch or system for a designated amount of time.
+Apache::
+  Open-source web server software used to serve both static content and dynamic web pages in a secure and reliable way. More information is available at http://apache.org.
+Authority Record::
+  Records used to control the contents of MARC fields.
+[[B]]Balance stop percent::
+  A setting in acquisitions that prevents you from making purchases when only a specified amount of the fund remains. 
+Barcode::
+  The code/number attached to the item.  This is not the database ID. Barcodes are added to items to facilitate the checking in and out of an item. Barcodes can be changed as needed. Physical barcodes that can be placed on items can follow several different barcode symboligies.
+Bibliographic record::
+  The record that contains data about a work, such as title, author and copyright date.
+Booking::
+  Processes relating to reserving cataloged and non- bibliographic items.
+Brick::
+  A brick is a unit consisting of one or more servers. It refers to a set of servers with ejabberd, Apache, and all applicable Evergreen services.  It is possible to run all the software on a single server, creating a “single server brick.” Typically, larger installations will have more than one such brick and, hence, be more robust.
+Buckets::
+  This is a container of items. See also Record Buckets and Item Buckets.
+[[C]]Call number::
+  An item's call number is a string of letters and or numbers that work like map coordinates to describe where in a library a particular item "lives."
+Catalog::
+  The database of titles and objects 
+Cataloging::
+  The process of adding materials to be circulated to the system.
+Check-in::
+  The process of returning an item.
+Check-out::
+  The process of loaning and item to a patron.
+Circulation::
+  The process of loaning an item to an individual.
+Circulating library::
+  The library which has checked out the item.
+Circulation library::
+  The library which is the home of the item.
+Circulation limit sets::
+  Refines circulation policies by limiting the number of items that users can check out. 
+Circulation modifiers::
+  Circulation modifiers pull together Loan Duration, Renewal Limit, Fine Level, Max Fine, and Profile Permission Group to create circulation rules for different types of materials. Circulation Modifiers are also used to determine Hold Policies.
+Cloud Computing::
+  The use of a network of remote servers hosted on the Internet to store, manage, and process data, rather than a local server or computer. Terms sush as Software as a Service(SaaS) refer to these kinds of systems.  ILS vendors offering hosting where they manage the servers used by the ILS and provide access via the internet is an example of cloud computing.
+Commit::
+  To make code changes to the software code permanent. In open source software development, the ability to commit is usually limited to a core group. 
+Community::
+  Community in the open source world of software development and use refers to the users and developers who work in concert to develop, communicate, and collaborate to develop the software.
+Compiled::
+  A compiled software is where the software has been translated to a machine code for use. Compiled software usually targets a specific computer architecture. The code cannot be read by humans. 
+Consortium::
+  A consortium is a organization of two or more individuals, companies, libraries, consortiums, etc. formed to undertake an enterprise beyond the resources of any one member. 
+Consortial Library System (CLS)::
+  An ILS designed to run an consortium. A CLS is designed for resource sharing between all members of the consortium, it provides an union catalog for all items in the consortium. 
+[[copy]]Copy:: 
+  see <<item, Item>>
+[[D]]Default Search Library::
+  The default search library setting determines what library is searched from the advanced search screen and portal page by default. Manual selection of a search library will override it. One recommendation is to set the search library to the highest point you would normally want to search.
+Distribution formulas:: 
+  Used to specify the number of copies that should be distributed to specific branches and item locations in Acquisitions
+Due date::
+  The due date is the day on or before which an item must be returned to the library in order to avoid being charged an overdue fine. 
+[[E]]ejabberd::
+  ejabberd stands for Erland Jabber Daemon. This is the software that runs <<jabber, jabber>>. ejabberd is used to exchange data between servers.
+Electronic data interchange (EDI)::
+  Transmission of data between organizations using electronic means. This is used for Acquisitions. 
+Evergreen::
+  Evergreen is an open source ILS designed to handle the processing of a geographical dispersed, resource sharing library network. 
+[[F]]FIFO (First In First Out):: 
+  In a FIFO environment, holds are filled in the order that they are placed.
+FUD (Fear, Uncertainty, Doubt)::
+  FUD is a marketing stratagy to try to install Fear, Uncertainty, and/or Doubt about a competitors product.   
+Fund tags::
+  Tags used in acquisitions to allow you to group Funds.
+Funding sources::
+  Sources of the monies to fund acquisitions of materials.
+Funds::
+  Allocations of money used for purchases.
+FRBR (Functional Requirements for Bibliographic Records)::
+  See https://www.loc.gov/cds/downloads/FRBR.PDF[Library of Congress FRBR documentation]
+[[G]]Git::
+  Git is a versioning control software for tracking changes in the code. It is designed to work with multiple developers.
+GNU::
+  GNU is a recursive acronym for "GNU's Not Unix". GNU is an open source Unix like operating system.  
+GNU GPL version 2 (GNU General Public License version 2)::
+  GNU GPL Version 2 is the license in which Evergreen is licensed. GNU GPL version 2 is a copyleft licence, which means that derivative work must be open source and distributed under the same licence terms. See https://www.gnu.org/licenses/old-licenses/gpl-2.0.html for complete license information. 
+[[H]]Hatch::
+  A additional program that is installed as an extension of your browser to extend printing functionality with Evergreen.
+Hold::
+  The exclusive right for a patron to checkout a specific item. 
+Hold boundaries::
+  Define which organizational units are available to fill specific holds.
+Holdings import profile::
+  Identifies the <<IIA, Import Item Attributes>> definition.
+Holding subfield::
+  Used in the acquisitions module to map subfields to the appropriate item data. 
+[[I]]ICL (Inter-Consortium Loans)::
+  Inter-Consortium Loans are like ILL's, but different in the fact that the loan happens just with in the Consortium. 
+[[ILS]]ILS (Integrated Library System)::
+  The Integrated Library System is a set of applications which perform the business and technical aspects of library management, including but not exclusive to acquistions, cataloging, circulation, and booking. 
+ILL (Inter-Library Loan)::
+  Inter-Library Loan is the process of one libray borrows materials for a patron from another library. 
+[[IIA]]Import item attributes::
+  Used to map the data in your holdings tag to fields in the item record during a MARC import.
+Insufficient quality fall-through profile::
+  A back-up merge profile to be used for importing if an incoming record does not meet the standards of the minimum quality ratio.
+ISBN (International Standard Book Number)::
+  The ISBN is a publisher product number that has been used in the book supply industry since 1968. A published book that is a separate product gets its own ISBN. ISBNs are either 10 digits or 13 digits long. They may contain information on the country of publication, the publisher, title, volume or edition of a title. 
+ISSN (International Standard Serial Number)::
+  International Standard Serial Number is a unigue 8 digit number assigned by the Internation Serials Data System to identify a specfic Serial Title. 
+[[item]]Item:: 
+  The actual item.
+Item barcode::
+  Item barcodes uniquely identify each specific item entered into the Catalog.
+Item Buckets::
+  This is a container of individual items.
+Item Status::
+  Item Status allows you to see the status of a item without having to go to the actual Title Record.  Item status is a intragal part of Evergreen and how it works.
+[[J]][[jabber]]Jabber:: 
+  The communications protocol used for client-server message passing within Evergreen. Now known as <<XMPP, XMPP>>, it was originally named "Jabber."
+Juvenile flag::
+  User setting used to specify if a user is a juvenile user for circulation purposes.
+[[K]]KPAC (Kids' OPAC):: 
+  Alternate version of the Template Toolkit OPAC that is kid friendly
+[[L]]LaunchPad:: 
+  Launchpad is an open source suite of tools that help people and teams to work together on software projects. Launchpad brings together bug reports, wishlist ideas, translations, and blueprints for future development of Evergreen. https://launchpad.net/evergreen
+LCCN (Library of Congress Control Number)::
+  The LCCN is a system of numbering catalog records at the Library of Congress
+LMS (Library Management System)::
+  see <<ILS>>
+Loan duration::
+  Loan duration (also sometimes referred to as "loan period") is the length of time a given type of material can circulate.
+[[M]]MARC (Machine Readable Cataloging)::
+  The MARC formats are standards for the representation and communication of bibliographic and related information in machine-readable form. 
+MARC batch export::
+  Mass exporting of MARC records out of a library system.
+MARC batch import::
+  Mass importing of MARC records into a library system.
+MARCXML::
+  Framework for working with MARC data in a XML environment.
+Match score::
+  Indicates the relative importance of that match point as Evergreen evaluates an incoming record against an existing record.
+Minimum quality ratio::
+  Used to set the acceptable level of quality for a record to be imported.
+[[N]]Non-Cataloged::
+  Items that have not been cataloged.
+[[O]]OPAC (Online Public Access Catalog):: 
+  An OPAC is an online interface to the database of a library's holdings, used to find resources in their collections. It is possibly searchable by keyword, title, author, subject or call number.  The public view of the catalog.
+OpenSRF (Open Scalable Request Framework):: 
+  Acronym for Open Scalable Request Framework (pronounced 'open surf'). An enterprise class Service Request Framework. It's purpose is to serve as a robust message routing network upon which one may build complex, scalable applications. To that end, OpenSRF attempts to be invisible to the application developer, while providing transparent load balancing and failover with minimal overhead.
+Organizational units (Org Unit)::
+  Organizational Units are the specific instances of the organization unit types that make up your library's hierarchy.
+Organization unit type::
+  The organization types in the hierarchy of a library system.
+Overlay/merge profiles::
+  During a MARC import this is used identify which fields should be replaced, which should be preserved, and which should be added to the record.
+Owning library::
+  The library which has purchased a particular item and created the volume and item records. 
+[[P]]Parent organizational unit::
+  An organizational unit one level above whose policies may be inherited by its child units. 
+Parts::
+  Provide more granularity for copies, primarily to enable patrons to place holds on individual parts of a set of items.
+Patron::
+  A user of the ILS. Patrons in Evergreen can both be staff and public users.
+Patron barcode / library card number::
+  Patrons are uniquely identified by their library card barcode number.
+Permission Groups::
+  A grouping of permissions granted to a group of individuals, i.e. patrons, cataloging, circulation, administration. Permission Groups also set the depth and grantability of permissions.
+Pickup library::
+  Library designated as the location where requested material is to be picked up. 
+PostgreSQL::
+  A popular open-source object-relational database management system that underpins Evergreen software.
+Preferred Library::
+  The library that is used to show items and URIs regardless of the library searched.  It is recommended to set this to your Workstation library so that local copies always show up first in search Results.
+Print Templates::
+  Templates that Evergreen uses to print various receipts and tables.
+Printer Settings::
+  Settings in Evergreen for selected printers.  This is a HATCH functionality.
+Propagate funds::
+  Create a new fund for the following fiscal year with the same parameters as your current fund.
+Providers::
+  Vendors from whom you order your materials. Set in the Acquisition module.
+Purchase Order (PO)::
+  A document issued by a buyer to a vendor, indicating types, quantities, and prices of materials. 
+[[Q]]Quality metrics::
+  Provide a mechanism for Evergreen to measure the quality of records and to make importing decisions based on quality.  
+[[R]]RDA (Resource Description & Access)::
+    RDA is a set of cataloging standards and guidelines based on FRBR and FRAD. RDA is the successor for AACR2. http://rdatoolkit.org/ 
+Record Bucket::
+  This is a container of Title Records.
+Record match sets::
+  When importing records, this identifies how Evergreen should match incoming records to existing records in the system.
+Recurring fine::
+  Recurring Fine is the official term for daily or other regularly accruing overdue fines. 
+Register Patron::
+  The process of adding a Patron account with in Evergreen.
+Rollover::
+  Used to roll over remaining encumbrances and funds into the same fund the following year. 
+[[S]]SAN (Standard Address Number)::
+  SAN is an identificatin code for electronic communication with in the publishing industry. SAN uniguely identify an address for location.
+Shelving location:: 
+  Shelving location is the area within the library where a given item is shelved.
+SIP (Standard Interchange Protocol)::
+  SIP is a communications protocol used within Evergreen for transferring data to and from other third party devices, such as RFID and barcode scanners that handle patron and library material information. Version 2.0 (also known as "SIP2") is the current standard. It was originally developed by the 3M Corporation.
+[[SRU]]SRU (Search & Retrieve URL)::
+  Acronym for Search & Retrieve URL Service. SRU is a search protocol used in web search and retrieval. It expresses queries in Contextual Query Language (CQL) and transmits them as a URL, returning XML data as if it were a web page.
+Staff client::
+  The graphical user interface used by library workers to interact with the Evergreen system. Staff use the Staff Client to access administration, acquisitions, circulation, and cataloging functions.
+Standing penalties::
+  Serve as alerts and blocks when patron records have met certain criteria, commonly excessive overdue materials or fines; standing penalty blocks will prevent circulation and hold transactions.  
+Statistical categories:: 
+  Allow libraries to associate locally interesting data with patrons and holdings. Also known as stat cats.
+[[T]]Template Toolkit (TT)::
+  A template processing system written in Perl.
+TPAC:: 
+  Evergreen's Template Toolkit based OPAC. The web based public interface in Evergreen written using functionality from the Template Toolkit.
+[[U]]URI::
+  Universal Resource Identifier. A URI is a string of characters that identify a logical or physical resource. Examples are URL an URN
+URL (Universal Resource Locator)::
+  This is the web address.
+URN (Universal Resource Number)::
+  This is a standard number to identify a resource. Example of URNs are ISBN, ISSN, and UPC.
+UPC (Universal Product Code)::
+  The UPC is a number uniguely assigned to an item by the manufacturer.
+User Activity Type::
+  Different types of activities users do in Evergreen. Examples: Login, Verification of account
+[[V]]Vandelay::
+  MARC Batch Import/Export tool original name.
+[[W]]Wiki::
+  The Evergreen Wiki can be found at https://wiki.evergreen-ils.org. The Evergreen Wiki is a knowledge base of information on Evergreen. 
+Workstation::
+  The unique name associated with a specific computer and Org Unit.
+[[X]]XML (eXtensible Markup Language)::
+  Acronym for eXtensible Markup Language, a subset of SGML. XML is a set of rules for encoding information in a way that is both human-readable and machine-readable. It is primarily used to define documents but can also be used to define arbitrary data structures. It was originally defined by the World Wide Web Consortium (W3C).
+[[XMPP]]XMPP (Extensible Messaging and Presence Protocol)::
+  The open-standard communications protocol (based on XML) used for client-server message passing within Evergreen. It supports the concept of a consistent domain of message types that flow between software applications, possibly on different operating systems and architectures. More information is available at http://xmpp.org.
+  See Also: <<jabber,Jabber>>. 
+xpath::
+  The XML Path Language, a query language based on a tree representation of an XML document. It is used to programmatically select nodes from an XML document and to do minor computation involving strings, numbers and Boolean values. It allows you to identify parts of the XML document tree, to navigate around the tree, and to uniquely select nodes. The currently version is "XPath 2.0". It was originally defined by the World Wide Web Consortium (W3C). 
+[[Y]]YAOUS:: 
+  Yet Another Organization Unit Setting
+[[Z]]Z39.50 ::
+  An international standard client/server protocol for communication between computer systems, primarily library and information related systems.
+  See Also: <<SRU>>
+
index 0151393..c5b68a7 100644 (file)
 ** xref:cataloging:monograph_parts.adoc[]
 ** xref:cataloging:conjoined_items.adoc[]
 ** xref:cataloging:cataloging_electronic_resources.adoc[]
-** xref:cataloging:item_status.adoc[]
+** xref:cataloging:item_status.adoc[Item Status]
 ** xref:cataloging:volcopy_editor.adoc[]
 ** xref:cataloging:tpac_copy_edit_links.adoc[]
 ** xref:cataloging:holdings_editor_hide_fields.adoc[]
-** xref:cataloging:MARC_batch_edit.adoc[]
-** xref:cataloging:authorities.adoc[]
-** xref:cataloging:link_checker.adoc[]
+** xref:cataloging:MARC_batch_edit.adoc[MARC Batch Edit]
+** xref:cataloging:authorities.adoc[Authority Control]
+** xref:cataloging:link_checker.adoc[Link Checker]
 ** xref:admin:schema_bibliographic.adoc[]
 ** xref:admin:marc_templates.adoc[]
 
index 391fc66..0ec25e6 100644 (file)
@@ -55,9 +55,9 @@ indexterm:[pocket labels]
 Before printing spine labels, you will want to install Hatch
 or turn off print headers and footers in your browser.
 
-include::../admin/turn-off-print-headers-firefox.adoc[]
+include::../../admin/partials/turn-off-print-headers-firefox.adoc[]
 
-include::../admin/turn-off-print-headers-chrome.adoc[]
+include::../../admin/partials/turn-off-print-headers-chrome.adoc[]
 
 ==== Creating spine labels ====
 
@@ -71,3 +71,18 @@ To create spine and item labels for an item (or group of items):
 . Take a look at the Label Preview area.
 . When you are satisfied with your labels, click the _Print_ button.
 
+=== Request Items Action ===
+
+To place requests from the Item Status interface, select one or more items in List View and select *Actions -> Request Items*. This action can also be invoked for a single item from Item Status Detail View.
+
+Starting in 3.4, this action has an Honor User Preferences checkbox which does the following for the selected user when checked:
+
+* Changes the Pickup Library selection to match the user's Default Hold Pickup Location
+* Honor the user's Holds Notification settings (including Default Phone Number, etc.)
+
+Also beginning with 3.4, a Title Hold option has been added to the Hold Type menu.  This will create one title-level hold request for each unique title associated with the items that were selected when Request Items was invoked.
+
+image::media/request_from_item_status.png[Request from Item Status]
+
+Success and Failure toasts have also been added based on what happens after the Request Items interface has closed.
+