Docs reorg: rearranging the example staff client sysadmin TOC
authorJane Sandberg <sandbej@linnbenton.edu>
Thu, 1 Dec 2016 01:49:03 +0000 (17:49 -0800)
committerJane Sandberg <sandbej@linnbenton.edu>
Thu, 1 Dec 2016 01:49:03 +0000 (17:49 -0800)
Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
docs/root_staffclient_sysadmin.txt

index 0376777..d041d8f 100644 (file)
@@ -6,7 +6,7 @@ Documentation Interest Group
 :numbered:
 
 Introduction
-============ 
+============
 
 About This Documentation
 ------------------------
@@ -56,226 +56,204 @@ type – public, academic, special, school, and even tribal and home libraries 
 in over a dozen countries worldwide.
 
 
-include::RELEASE_NOTES_2_10.adoc[]
 
-Library administration from the staff client
-============================================
+Using the Staff Client as a System Administrator
+================================================
 
-Introduction
-------------
+This section provides an orientation to the staff client, noting features of particular interest
+to system administrators.
 
-This part covers the options in the Local Administration menu found in the staff
-client. 
 
-// Follow structure from staff client local admin menu.
-
-include::admin/librarysettings.adoc[]
+include::admin/staff_client-login.txt[]
 
-Describing your organization
-============================
+include::admin/staff_client-button_bar_toolbar.txt[]
 
-include::admin_initial_setup/describing_your_organization.txt[]
+include::admin/staff_client-sticky_settings.txt[]
 
-System Configuration and Customization
-======================================
+include::admin/staff_client-tab_buttons.txt[]
 
-Introduction
-------------
+include::admin/staff_client-double_clicking.txt[]
 
-The Evergreen system allows a free range of customizations to every aspect of
-the system. Use this part of the documentation to become familiar with the tools
-for configuring the system as well as customizing the catalog and staff client.  
+include::admin/workstation_admin.txt[]
 
-// Push titles down one level.
-:leveloffset: 1
+include::admin/workstation_admin_customizable_toolbar.txt[]
 
+include::admin/customize_staff_client.txt[]
 
-include::admin_initial_setup/describing_your_people.txt[]
+include::admin/librarysettings.adoc[]
 
-include::admin_initial_setup/migrating_patron_data.txt[]
 
-include::admin_initial_setup/migrating_your_data.txt[]
+// OU Admin
 
-include::admin_initial_setup/importing_via_staff_client.txt[]
+include::admin_initial_setup/describing_your_organization.txt[]
 
-include::admin_initial_setup/ordering_materials.txt[]
 
-include::admin_initial_setup/designing_your_catalog.txt[]
+// Acq
+:leveloffset: -1
 
-include::admin_initial_setup/borrowing_items.txt[]
+include::admin/acquisitions_admin.txt[]
 
-// Return to normal title levels.
 :leveloffset: 0
 
-include::admin_initial_setup/hard_due_dates.txt[]
-
-
-
-include::admin/template_toolkit.txt[]
-
-// Push titles down one level.
-:leveloffset: 1
 
-include::opac/new_skin_customizations.txt[]
+// Cat
+Cataloging administration
+=========================
 
-// Return to normal title levels.
-:leveloffset: 0
+include::admin/authorities.txt[]
 
-include::admin/auto_suggest_search.txt[]
+// Circ
+Circulation administration
+==========================
 
-include::admin/authentication_proxy.txt[]
 
-// Push titles down one level.
-:leveloffset: 1
+Circulation policies
+--------------------
 
-include::TechRef/KidsOPAC.txt[]
+This section discusses the initial setup and subsequent troubleshooting and refinement of circulation policies.
 
-// Return to normal title levels.
-:leveloffset: 0
 
-include::admin/customize_staff_client.txt[]
+:leveloffset: 2
 
-include::admin/patron_address_by_zip_code.txt[]
-
-// Push titles down one level.
-:leveloffset: 1
+include::admin_initial_setup/borrowing_items.txt[]
 
-include::admin/phonelist.txt[]
+include::admin/circulation_limit_groups.txt[]
 
-// Return to normal title levels.
 :leveloffset: 0
 
-include::admin/sip_server.txt[]
-
-include::admin/apache_rewrite_tricks.txt[]
 
-include::admin/apache_access_handler.txt[]
 
+Circulating uncataloged materials
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Using the Staff Client
-======================
+This section discusses settings for circulating items that are not cataloged.
 
+Pre-cataloged item settings
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Introduction
-------------
+Needs to be written.  There is a Pre-cat Item Circ Lib OU setting.
 
-This part of the documentation deals with general Staff Client usage including
-logging in, navigation and shortcuts.
+Non-cataloged item settings
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+Needs to be written.  This is about Local Admin > Non-cataloged item type.
 
-include::admin/staff_client-login.txt[]
+Hold policies
+-------------
 
-include::admin/staff_client-button_bar_toolbar.txt[]
+This section discusses hold policies.
 
-include::admin/staff_client-sticky_settings.txt[]
+Transits and resource sharing
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-include::admin/staff_client-tab_buttons.txt[]
+This section offers specific information and guidance about holds that involve multiple libraries.
 
-include::admin/staff_client-double_clicking.txt[]
+:leveloffset: 2
 
-include::admin/staff_client-patron_border.txt[]
-
-include::admin/staff_client-sorting_columns.txt[]
-
-include::admin/staff_client-column_picker.txt[]
-
-include::admin/staff_client-recent_searches.txt[]
+include::admin/age_hold_protection.txt[]
 
-include::admin/staff_client-return_to_results_from_marc.txt[]
+include::admin/Best_Hold_Selection_Sort_Order.txt[]
 
-include::admin/workstation_admin.txt[]
+include::admin/Org_Unit_Proximity_Adjustments.txt[]
 
-// Push titles down one level.
-:leveloffset: 1
+:leveloffset: 3
 
-include::admin/workstation_admin_receipt_template_editor.txt[]
+include::admin/floating_groups.txt[]
 
-// Return to normal title levels.
 :leveloffset: 0
 
-include::admin/workstation_admin_customizable_toolbar.txt[]
+Working with money
+------------------
 
-System Administration From the Staff Client
-===========================================
+This section discusses how to manage and report on payments accepted by your library's circulation processes.
 
-Introduction
-------------
+Accepting credit card payments
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This part deals with the options in the Server Administration menu found in the
-staff client. 
+Evergreen can accept credit card payments.
 
-// Follow structure from staff client system admin menu.
+Stripe
+^^^^^^
 
-include::admin/acquisitions_admin.txt[]
+Some info in the current Library Settings Editor docs
 
-include::admin/age_hold_protection.txt[]
+Paypal, Authorize.net, etc.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-include::admin/authorities.txt[]
+This section needs to be written
 
-include::admin/Best_Hold_Selection_Sort_Order.txt[]
+Cash reports
+~~~~~~~~~~~~
 
-include::admin/booking-admin.txt[]
+This section needs to be written
 
-include::admin/cn_prefixes_and_suffixes.txt[]
+Negative balances
+~~~~~~~~~~~~~~~~~
 
-include::admin/circulation_limit_groups.txt[]
+This section needs to be written
+
+Circulation timesavers and workflows
+------------------------------------
 
-include::admin/copy_statuses.txt[]
+This section describes specific settings that may increase efficiency or accuracy at some libraries, but might not be suitable for every library.
 
-// Push titles down one level.
 :leveloffset: 1
 
-include::admin/floating_groups.txt[]
+include::admin/lsa-barcode_completion.txt[]
+
+include::admin/patron_address_by_zip_code.txt[]
 
-// Return to normal title levels.
 :leveloffset: 0
 
-include::admin/MARC_Import_Remove_Fields.txt[]
+Library closures
+----------------
 
-include::admin/MARC_RAD_MVF_CRA.txt[]
+This section describes both everyday closures and specific details suitable for school and academic libraries that operate on a term or semester system.
 
-include::admin/Org_Unit_Proximity_Adjustments.txt[]
+Library hours
+~~~~~~~~~~~~~
 
-include::admin/permissions.txt[]
+In OU settings
 
-include::admin/SMS_messaging.txt[]
+Closed dates
+~~~~~~~~~~~~
 
-include::admin/user_activity_type.txt[]
+Need to move out of the describing your OU docs
 
-include::admin/restrict_Z39.50_sources_by_perm_group.txt[]
+:leveloffset: 1
 
+include::admin_initial_setup/hard_due_dates.txt[]
 
+:leveloffset: 0
 
-//    Address Alert Feature
-include::admin/lsa-address_alert.txt[]
+Age to lost
+~~~~~~~~~~~
 
-//    Barcode Completion Feature
-include::admin/lsa-barcode_completion.txt[]
+No documentation yet
 
-// Push titles down one level.
 :leveloffset: 1
 
-include::admin/hold_driven_recalls.txt[]
+include::admin/booking-admin.txt[]
 
-// Return to normal title levels.
 :leveloffset: 0
 
-include::admin/actiontriggers.txt[]
+Offline circulation
+-------------------
 
-include::admin/recent_staff_searches.txt[]
+Need to extract this from the offline circulation documentation
 
-include::admin/lsa-standing_penalties.txt[]
-
-include::admin/lsa-statcat.txt[]
+include::admin/workstation_admin_receipt_template_editor.txt[]
 
-include::admin/lsa-work_log.txt[]
+Self-check administration
+-------------------------
 
-Acquisitions
-===========
+Need to extract this from the self-check documentation
 
-include::acquisitions/introduction.txt[]
+// Patron UX
+Patron User Experience Administration
+=====================================
 
-include::acquisitions/vandelay_acquisitions_integration.txt[]
+This section describes settings for the OPAC, including patron self-registration and other functionalities.
 
 
 Reports
@@ -284,7 +262,8 @@ Reports
 Introduction
 ------------
 
-Learn how to create and use reports in Evergreen. 
+Learn how to create and use reports in Evergreen.
+
 
 include::reports/reporter_daemon.txt[]
 
@@ -298,8 +277,6 @@ include::reports/reporter_view_output.txt[]
 
 include::reports/reporter_cloning_shared_templates.txt[]
 
-include::reports/reporter_add_data_source.txt[]
-
 include::reports/reporter_running_recurring_reports.txt[]
 
 include::reports/reporter_template_terminology.txt[]
@@ -308,131 +285,34 @@ 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
---------------------
+// Staff
 
-Introduction
-~~~~~~~~~~~~
-This part of the documentation deals with general client usage including
-logging in, navigation and shortcuts.
+Staff administration
+====================
 
-// Push titles down one level.
-:leveloffset: 1
+This section describes how to administer staff accounts.
 
-include::admin/web_client-login.txt[]
+:leveloffset: 1
 
-include::admin/web_client-browser-tab-shortcuts.txt[]
+include::admin_initial_setup/describing_your_people.txt[]
 
-// Return to normal title levels.
 :leveloffset: 0
 
-Using the Public Access Catalog
-===============================
-
-Introduction
-------------
-
-Evergreen has a public OPAC that meets WCAG guidelines (http://www.w3.org/WAI/intro/wcag), which helps make the OPAC accessible to users with a range of disabilities. This part of the documentation explains how to use the Evergreen public OPAC. It covers the basic catalog and more advanced search topics. It also describes the ``My Account'' tools users have to find information and manage their personal library accounts through the OPAC. This section could be used by staff and patrons but would be more useful for staff as a generic reference when developing custom guides and tutorials for their users.
-
-include::opac/my_lists.txt[]
-
-include::opac/kids_opac.txt[]
-
-include::opac/catalog_browse.txt[]
-
-include::opac/advanced_features.txt[]
+include::admin/lsa-work_log.txt[]
 
-include::opac/tpac_meta_record_holds.txt[]
 
-include::opac/linked_libraries.txt[]
+// 3rd party
 
-include::opac/opensearch.txt[]
+Integrating third-party tools
+=============================
 
-// Push titles down one level.
-:leveloffset: 1
+This section describes how to integrate third-party tools, such as RFID systems.
 
-include::opac/search_form.txt[]
 
-// Return to normal title levels.
-:leveloffset: 0
 
 
-[appendix]
 Admonitions
 ===========