[open-ils-commits] [GIT] Evergreen ILS branch master updated. bfa1bfa5143177f82b3db2faf41195f3d6e9304c
Evergreen Git
git at git.evergreen-ils.org
Tue Sep 12 22:57:22 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 bfa1bfa5143177f82b3db2faf41195f3d6e9304c (commit)
from 24b17829ea732e916c1f6dad5573eceda7968252 (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 bfa1bfa5143177f82b3db2faf41195f3d6e9304c
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date: Tue Sep 12 19:56:56 2017 -0700
Docs reorg: Adding a new manual for system administration from the Web client
Signed-off-by: Jane Sandberg <sandbej at linnbenton.edu>
diff --git a/docs/admin/acquisitions_admin.adoc b/docs/admin/acquisitions_admin.adoc
index a741a04..f97bf32 100644
--- a/docs/admin/acquisitions_admin.adoc
+++ b/docs/admin/acquisitions_admin.adoc
@@ -301,8 +301,8 @@ indexterm:[EDI,accounts]
Many libraries use Electronic Data Interchange (EDI) accounts to send purchase orders and receive invoices
from providers electronically. In Evergreen users can setup EDI accounts and manage EDI messages in
the admin module. EDI messages and notes can be viewed in the acquisitions module. See
-also the <<_setting_up_edi_acquisitions,EDI Installation Instructions>>
-because this is required for use of EDI.
+also the command line system administration manual, which includes some initial setup steps that are
+required for use of EDI.
Entering SANs (Standard Address Numbers)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/admin/librarysettings.adoc b/docs/admin/librarysettings.adoc
index a604b92..93a23f2 100644
--- a/docs/admin/librarysettings.adoc
+++ b/docs/admin/librarysettings.adoc
@@ -1,5 +1,8 @@
Library Settings Editor
-----------------------
+
+Introduction
+~~~~~~~~~~~~
(((Library Settings Editor)))
With the *Library Settings Editor* one can optionally customize
diff --git a/docs/admin_initial_setup/importing_via_staff_client.adoc b/docs/admin_initial_setup/importing_via_staff_client.adoc
index e800f68..7d0a35b 100644
--- a/docs/admin_initial_setup/importing_via_staff_client.adoc
+++ b/docs/admin_initial_setup/importing_via_staff_client.adoc
@@ -115,7 +115,7 @@ Profile* button to map this information.
tag.
. At a minimum, you should add the subfields that identify the *Circulating
Library*, the *Owning Library*, the *Call Number* and the *Barcode*.
-. For more details, see the <<_import_item_attributes_2,full list of import fields>>
+. For more details, see the <<_import_item_attributes,full list of import fields>>
NOTE: All fields (except for Name, Tag and Keep) can contain static
values, a MARC subfield code (such as "a"), or an XPATH query.
diff --git a/docs/admin_initial_setup/ordering_materials.adoc b/docs/admin_initial_setup/ordering_materials.adoc
index 3fb62e4..a7766aa 100644
--- a/docs/admin_initial_setup/ordering_materials.adoc
+++ b/docs/admin_initial_setup/ordering_materials.adoc
@@ -1,6 +1,9 @@
Ordering materials
==================
+Introduction
+------------
+
Acquisitions allows you to order materials, track the expenditure of your
collections funds, track invoices and set up policies for manual claiming. In
this chapter, we're going to be describing how to use the most essential
@@ -201,8 +204,7 @@ Preparing to send electronic orders from Evergreen
If your library wants to transmit electronic order information to a vendor, you
will need to configure your server to use EDI. You need to install the EDI
translator and EDI scripts on your server by following the instructions in the
-Evergreen 2.3 documentation.
-(http://docs.evergreen-ils.org/2.3/_installation.html)
+command line system administration manual.
Configure your provider's EDI information by selecting *Admin > Server
Administration > Acquisitions > EDI Accounts*. Give the account a name in the
diff --git a/docs/circulation/self_check.adoc b/docs/circulation/self_check.adoc
index 77ccf70..ba96354 100644
--- a/docs/circulation/self_check.adoc
+++ b/docs/circulation/self_check.adoc
@@ -1,6 +1,9 @@
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.
diff --git a/docs/reports/reporter_template_terminology.adoc b/docs/reports/reporter_template_terminology.adoc
index b1998b5..5227657 100644
--- a/docs/reports/reporter_template_terminology.adoc
+++ b/docs/reports/reporter_template_terminology.adoc
@@ -8,20 +8,64 @@ indexterm:[reports, data types]
The information in Evergreen's database can be classified in nine data types, formats that describe the type of data and/or its use. These were represented by text-only labels in prior versions of Evergreen. Evergreen 3.0 has replaced the text labels with icons. When building templates in _Reports_, you will find these icons in the Field Name Pane of the template creation interface.
-[options="header,footer"]
-|========================
-|Webby Icon|Data Type |Description |Notes
-a|image::media/datatypes_timestamp.png[] |timestamp |An exact date and time (year, month, day, hour, minutes, and seconds) |Select appropriate date/time transform. Raw Data includes second and timezone information, usually more than is required for a report.
-a|image::media/datatypes_link.png[] |link |A link to another database table |Link outputs a number that is a meaningful reference for the database but not of much use to a human user. You will usually want to drill further down the tree in the Sources pane and select fields from the linked table. However, in some instances you might want to use a link field. For example, to count the number of patrons who borrowed items you could do a count on the Patron link data.
-a|image::media/datatypes_text.png[] |text |A field of text |Usually uses the Raw Data transform.
-a|image::media/datatypes_bool.png[] |bool |True or False |Commonly used to filter out deleted item or patron records.
-a|image::media/datatypes_orgunit.png[] |org_unit |Organizational Unit - a number representing a library, library system, or federation |When you want to filter on a library, make sure that the field name is on an org_unit or id data type.
-a|image::media/datatypes_id.png[] |id |A unique number assigned by the database to identify each record |A number that is a meaningful reference for the database but not of much use to a human user. Use in displayed fields when counting records or in filters.
-a|image::media/datatypes_money.png[] |money |A monetary amount |
-a|image::media/datatypes_int.png[] |int |Integer (a number) |
-a|image::media/datatypes_interval.png[] |interval |A period of time |
-| | | |
-|=======================
+timestamp
+^^^^^^^^^
+image::media/datatypes_timestamp.png[]
+
+An exact date and time (year, month, day, hour, minutes, and seconds). Remember to select the appropriate date/time transform. Raw Data includes second and timezone information, which is usually more than is required for a report.
+
+link
+^^^^
+
+image::media/datatypes_link.png[]
+
+A link to another database table. Link outputs a number that is a meaningful reference for the database but not of much use to a human user. You will usually want to drill further down the tree in the Sources pane and select fields from the linked table. However, in some instances you might want to use a link field. For example, to count the number of patrons who borrowed items you could do a count on the Patron link data.
+
+text
+^^^^
+image::media/datatypes_text.png[]
+
+A field of text. You will usually want to use the Raw Data transform.
+
+bool
+^^^^
+image::media/datatypes_bool.png[]
+
+True or False. Commonly used to filter out deleted item or patron records.
+
+org_unit
+^^^^^^^^
+image::media/datatypes_orgunit.png[]
+
+Organizational Unit - a number representing a library, library system, or federation. When you want to filter on a library, make sure that the field name is on an org_unit or id data type.
+
+id
+^^
+
+image::media/datatypes_id.png[]
+
+A unique number assigned by the database to identify each record. These numbers are meaningful references for the database but not of much use to a human user. Use in displayed fields when counting records or in filters.
+
+money
+^^^^^
+
+image::media/datatypes_money.png[]
+
+A monetary amount.
+
+int
+^^^
+
+image::media/datatypes_int.png[]
+
+Integer (a number)
+
+interval
+^^^^^^^^
+
+image::media/datatypes_interval.png[]
+
+A period of time.
[[field_transforms]]
Field Transforms
diff --git a/docs/root_staff_client_admin.adoc b/docs/root_staff_client_admin.adoc
new file mode 100644
index 0000000..f6f34c8
--- /dev/null
+++ b/docs/root_staff_client_admin.adoc
@@ -0,0 +1,309 @@
+Evergreen System Administration at your Library
+===============================================
+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 system administrators
+at local libraries who use the staff client for their day-to-day work.
+
+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[]
+
+:leveloffset: 0
+
+include::admin/web_client-browser-tab-shortcuts.adoc[]
+
+:leveloffset: -1
+
+include::admin/librarysettings.adoc[]
+
+
+:leveloffset: 0
+
+Organizational Unit administration
+==================================
+
+:leveloffset: 1
+
+include::admin_initial_setup/describing_your_organization.adoc[]
+
+include::admin_initial_setup/lsa-closed.adoc[]
+
+include::admin_initial_setup/lsa-standing_penalties.adoc[]
+
+:leveloffset: 0
+
+include::admin_initial_setup/ordering_materials.adoc[]
+
+include::admin/acquisitions_admin.adoc[]
+
+
+
+// Cat
+Cataloging administration
+=========================
+
+include::admin/authorities.adoc[]
+
+include::admin/cn_prefixes_and_suffixes.adoc[]
+
+include::admin/lsa-statcat.adoc[]
+
+include::admin/MARC_Import_Remove_Fields.adoc[]
+
+include::admin/MARC_RAD_MVF_CRA.adoc[]
+
+include::admin/restrict_Z39.50_sources_by_perm_group.adoc[]
+
+:leveloffset: 1
+
+include::admin_initial_setup/importing_via_staff_client.adoc[]
+
+:leveloffset: 0
+// Circ
+Circulation administration
+==========================
+
+
+Circulation policies
+--------------------
+
+This section discusses the initial setup and subsequent troubleshooting and refinement of circulation policies.
+
+
+:leveloffset: 2
+
+include::admin_initial_setup/borrowing_items.adoc[]
+
+include::admin/circulation_limit_groups.adoc[]
+
+include::admin/hold_driven_recalls.adoc[]
+
+
+:leveloffset: 0
+
+include::admin/copy_statuses.adoc[]
+
+include::circulation/self_check.adoc[]
+
+
+
+Circulating uncataloged materials
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This section discusses settings for circulating items that are not cataloged.
+
+Pre-cataloged item settings
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Needs to be written. There is a Pre-cat Item Circ Lib OU setting.
+
+Non-cataloged item settings
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Needs to be written. This is about Local Admin > Non-cataloged item type.
+
+Hold policies
+-------------
+
+This section discusses hold policies.
+
+Transits and resource sharing
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This section offers specific information and guidance about holds that involve multiple libraries.
+
+:leveloffset: 2
+
+include::admin/age_hold_protection.adoc[]
+
+include::admin/Best_Hold_Selection_Sort_Order.adoc[]
+
+include::admin/Org_Unit_Proximity_Adjustments.adoc[]
+
+:leveloffset: 3
+
+include::admin/floating_groups.adoc[]
+
+:leveloffset: 0
+
+Working with money
+------------------
+
+This section discusses how to manage and report on payments accepted by your library's circulation processes.
+
+Accepting credit card payments
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Evergreen can accept credit card payments.
+
+Stripe
+^^^^^^
+
+Some info in the current Library Settings Editor docs
+
+Paypal, Authorize.net, etc.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This section needs to be written
+
+Cash reports
+~~~~~~~~~~~~
+
+This section needs to be written
+
+Negative balances
+~~~~~~~~~~~~~~~~~
+
+This section needs to be written
+
+Circulation timesavers and workflows
+------------------------------------
+
+This section describes specific settings that may increase efficiency or accuracy at some libraries, but might not be suitable for every library.
+
+:leveloffset: 1
+
+include::admin/lsa-barcode_completion.adoc[]
+
+include::admin/lsa-address_alert.adoc[]
+
+include::admin/patron_address_by_zip_code.adoc[]
+
+:leveloffset: 0
+
+Library closures
+----------------
+
+This section describes both everyday closures and specific details suitable for school and academic libraries that operate on a term or semester system.
+
+Library hours
+~~~~~~~~~~~~~
+
+In OU settings
+
+Closed dates
+~~~~~~~~~~~~
+
+Need to move out of the describing your OU docs
+
+:leveloffset: 1
+
+include::admin_initial_setup/hard_due_dates.adoc[]
+
+:leveloffset: 0
+
+Age to lost
+~~~~~~~~~~~
+
+No documentation yet
+
+:leveloffset: 1
+
+include::admin/booking-admin.adoc[]
+
+:leveloffset: 0
+
+Offline circulation
+-------------------
+
+Need to extract this from the offline circulation documentation
+
+include::admin/workstation_admin_receipt_template_editor.adoc[]
+
+Self-check administration
+-------------------------
+
+Need to extract this from the self-check documentation
+
+// Patron UX
+Patron User Experience Administration
+=====================================
+
+Introduction
+------------
+
+This section describes settings for the OPAC, including patron self-registration and other functionalities.
+
+include::admin/SMS_messaging.adoc[]
+
+include::opac/linked_libraries.adoc[]
+
+
+Reports
+=======
+
+Introduction
+------------
+
+Learn how to create and use reports in Evergreen.
+
+
+include::reports/reporter_daemon.adoc[]
+
+include::reports/reporter_folder.adoc[]
+
+include::reports/reporter_create_templates.adoc[]
+
+include::reports/reporter_generating_reports.adoc[]
+
+include::reports/reporter_view_output.adoc[]
+
+include::reports/reporter_cloning_shared_templates.adoc[]
+
+include::reports/reporter_running_recurring_reports.adoc[]
+
+include::reports/reporter_template_terminology.adoc[]
+
+include::reports/reporter_template_enhancements.adoc[]
+
+include::reports/reporter_export_usingpgAdmin.adoc[]
+
+
+
+// Staff
+
+Staff administration
+====================
+
+Introduction
+------------
+
+This section describes how to administer staff accounts.
+
+:leveloffset: 1
+
+include::admin_initial_setup/describing_your_people.adoc[]
+
+:leveloffset: 0
+
+include::admin/permissions.adoc[]
+
+include::admin/lsa-work_log.adoc[]
+
+include::admin/recent_staff_searches.adoc[]
+
+
+:leveloffset: 0
+
+include::shared/attributions.adoc[]
+
+include::shared/end_matter.adoc[]
+
-----------------------------------------------------------------------
Summary of changes:
docs/admin/acquisitions_admin.adoc | 4 +-
docs/admin/librarysettings.adoc | 3 +
.../importing_via_staff_client.adoc | 2 +-
docs/admin_initial_setup/ordering_materials.adoc | 6 +-
docs/circulation/self_check.adoc | 3 +
docs/reports/reporter_template_terminology.adoc | 72 ++++-
docs/root_staff_client_admin.adoc | 309 ++++++++++++++++++++
7 files changed, 380 insertions(+), 19 deletions(-)
create mode 100644 docs/root_staff_client_admin.adoc
hooks/post-receive
--
Evergreen ILS
More information about the open-ils-commits
mailing list