Differences

This shows you the differences between two versions of the page.

--- evergreen-docs_2.2:outline [2012/02/24 15:26]
rsoulliere
+++ evergreen-docs_2.2:outline [2012/07/19 15:09] (current)
rsoulliere
@@ Line 1: / Line 1: @@
-===== Evergreen Documentation 2.2 -- DRAFT proposed reorganization =====
+===== Evergreen Documentation 2.2 =====
-=== Introduction and Release Notes (BASE) <HTML><span style="color: orange;font-weight: bold">Release notes will be taken from the release notes file with code -- update as required.</span></HTML> ===
+=== Color Indicators for documentation  ===
+    * <HTML><span style="color: red;font-weight: bold">RED "NEEDED" is for chapters/sections needed and not assigned.</span></HTML>
+    * <HTML><span style="color: blue;font-weight: bold">BLUE "ASSIGNED" is for chapters/sections which are assigned. Use this to indicate that you have volunteered for a chapter/section but have not submitted content yet. Also include your name or contact information so other folks can contact you to contribute.</span></HTML>
+    * <HTML><span style="color: orange;font-weight: bold">ORANGE is for chapters/sections in progress or needing improvement. Make note as required.</span></HTML>
+    * <HTML><span style="color: green;font-weight: bold">a GREEN "DONE" is for chapters/sections which are generally completed and have been distributed in the documentation.</span></HTML>
+=== Introduction and Release Notes (BASE)  ===
+<HTML><span style="color: orange;font-weight: bold">Release notes will be taken from the release notes file with code -- update as required.</span></HTML>
 === Software Installation (needed for a basic working system) ===
@@ Line 7: / Line 17: @@
   * Installing the server  software (BASE) <HTML><span style="color: orange;font-weight: bold">from README -- update as needed </span></HTML>
   * Upgrading the server software (BASE) <HTML><span style="color: orange;font-weight: bold">Review and update as needed</span></HTML>
+  * Install EDI <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
   * Testing and Troubleshooting
   * Installing the Staff Client
@@ Line 15: / Line 26: @@
 **Please add sections**FIXME
   * Global system configuration  (which can be done by editing opensrf.xml, opensrf_core.xml, etc...)
   * Customizing the OPAC/TPAC -- <HTML><span style="color: green;font-weight: bold">DONE -- From Dan Scott (http://bzr.coffeecode.net/2011/tpac_tutorial/TPAC_development_101.txt).</span></HTML>
+  * Auto Suggest Search box -- <HTML><span style="color: green;font-weight: bold">DONE -- From Sally and ESI.</span></HTML>
   * Customizing the staff client
   * Backing-up data and files
+  * Locales and Languages (See: http://open-ils.org/dokuwiki/doku.php?id=evergreen-admin:customizations:i18n)
-=== System-wide Administration from the staff client ===
+=== Using the Staff Client ===
-**Please flesh out sections**FIXME
+  * Logging in
-  * (should follow the Server Administration menu in the staff client)
+  * Tab buttons -- <HTML><span style="color: green;font-weight: bold">DONE -- From Sally and ESI.</span></HTML>
+  * Double clicking functionality -- <HTML><span style="color: green;font-weight: bold">DONE -- From Sally and ESI.</span></HTML>
+  * Sorting columns -- <HTML><span style="color: green;font-weight: bold">DONE -- From Sally and ESI.</span></HTML>
+  * Recent searches -- <HTML><span style="color: green;font-weight: bold">DONE -- From Sally and ESI.</span></HTML>
+  * Return to search results from MARC editor -- <HTML><span style="color: green;font-weight: bold">DONE -- From Sally and ESI.</span></HTML>
+=== System-wide Administration from the staff client (Admin>>Server Administration)  ===
+  * Acquisitions <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+  * Actor Stat Cat SIP Fields
+  * Age Hold Protect Rules
+  * Asset Stat Cat SIP Fields
+  * Authorities
+  * Billing Types
+  * Booking
+  * Call Number Prefixes
+  * Call Number Suffixes
+  * Circulation Duration Rules
+  * Circulation Limit Groups
+  * Circulation Matchpoint Weights
+  * Circulation Max Fine Rules
+  * Circulation Modifiers
+  * Circulation Recurring Fine Rules
+  * Copy Statuses
+  * Custom Org Unit Trees
+  * Global Flags
+  * Hard Due Date Changes
+  * Hold Matchpoint Weights
+  * Import Match Sets
+  * MARC Coded Value Maps
+  * MARC Record Attributes
+  * MARC Search/Facet Fields
+  * Organizational Types
+  * Organizational Unit Setting Types
+  * Organizational Units
+  * Permission Groups
+  * Permissions
+  * SMS Carriers
+  * User Activity Types  -- <HTML><span style="color: green;font-weight: bold">DONE -- From Sally and ESI.</span></HTML>
+  * User Setting Types
+  * Weights Association
+  * Z39.50 Server
-=== Local Administration ===
+=== Local Administration (Admin>>Local Administration) ===
-**Please flesh out sections**FIXME
+  * Address Alerts
-  * (should follow the Local Administration menu in the staff client)
+  * Age Overdue Circs to Lost
+  * Barcode Completion
+  * Cash Reports
+  * Circulation Limit Sets
+  * Circulation Policies
+  * Closed Dates Editor
+  * Copy Location Editor
+  * Copy Location Order
+  * Copy Locations Editor
+  * Copy Template Editor -- <HTML><span style="color: green;font-weight: bold">DONE -- See Serials Copy Template</span></HTML>
+  * 'Do not attempt Auto-Print' Setting
+  * Field Documentation
+  * Group Penalty Thresholds
+  * Hold Policies
+  * Library Settings Editor -- <HTML><span style="color: orange;font-weight: bold">Some content (fines accrued, Target Copies for Holds at Closed Libraries)</span></HTML>
+  * Non-cataloged types editor
+  * Notifications/Action Triggers
+  * Patrons with Negative Balances
+  * Reports -  Refer to section below
+  * Standing Penalties
+  * Statistical Categories Editor -- <HTML><span style="color: green;font-weight: bold">DONE -- From Scott Prater</span></HTML>
+  * Surveys
+  * Transit List
+  * Work Log
 === Acquisitions ===
-**Please add more sections**FIXME
+  * Introduction - includes workflow diagram
+  * Setup
+    * Link to server administration>>acquisitions>>fund sources?
+    * Link to server administration>>acquisitions>>funds?
+    * Link to server administration>>acquisitions>>providers?
+    * and others?
+  * Selection Lists and Purchase Orders
+    * Selection Lists <HTML><span style="color: orange;font-weight: bold">being reviewed</span></HTML>
+    * Purchase Orders
+    * Add Brief Record <HTML><span style="color: orange;font-weight: bold">being reviewed</span></HTML>
+    * Load MARC Order Records
+    * Federated Search <HTML><span style="color: orange;font-weight: bold">being reviewed</span></HTML>
+    * Line items
+    * Line items to the catalog
+    * Export single attribute list
+    * Cancel/Suspend Acquisitions
+  * Invoices
+  * Receiving
+    * Receive Items from an Invoice <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+      * Receive items in batch
+      * Receive specific copies
+  * Claiming
+  * Vandelay integration <HTML><span style="color: green;font-weight: bold">from Sally/ESI</span></HTML>
 === Cataloging ===
-**Please add more sections**FIXME
+  * Batch Edit MARC
   * Batch Importing MARC Records <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+  * Create new MARC record
+  * Conjoined Items <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
   * Overlay Existing Catalog Record via Z39.50 Import <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+    * Not sure if we need something additional beyond this for z39.50 but should be looked at
+  * Manage authorities
+  * Manage Copy Buckets
+  * Manage Record Buckets
   * Monograph Parts <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
-  * Conjoined Items <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
 === Serials ===
-**Please flesh out sections**FIXME
+  * Introduction <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+    * Explanation of difference in Serials Control View and Alternate Serials Control View (this could include a table to identify the differences in the two views)
+    * Workflow diagram
+  * Copy Templates <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+  * Setting Up Subscriptions <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+    * Serials Control View
+      * Setting up subscription
+      * Handling special issues
+    * Alternate Serials Control View
+      * Setting up subscription
+      * Handling special issues
+  * Creating Special Issues <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+  * Holdings Statement <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+    * MFHD and holdings generated by serials functions
+    * Explanation for adding and editing MFHD
+  * Receiving <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+    * Batch receiving
+    * Receiving through the serials control view
+  * Edit Subscriptions <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
+  * Group Serials Issues in OPAC Display <HTML><span style="color: green;font-weight: bold">DONE -- from Sally/ESI</span></HTML>
 === Circulation ===
 **Please add sections**FIXME
   * (covering Booking as well since it is in essence a circulation task)
-  * Circulating Items <HTML><span style="color: green;font-weight: bold">DONE -- From 2.1</span></HTML>
   * Booking Module <HTML><span style="color: green;font-weight: bold">DONE -- From 2.1</span></HTML>
+  * Circulating Items <HTML><span style="color: green;font-weight: bold">DONE -- From 2.1</span></HTML>
+  * Holds Management
+  * Patron Management <HTML><span style="color: green;font-weight: bold">DONE -- From Jenny and PALS</span></HTML>
+    * Register patrons
+    * Pending patrons
+    * Editing patrons
+    * Patron alerts and notes
+    * Merging patrons
+    * Bills and payments  <HTML><span style="color:green;font-weight: bold">Done -- From Jenny and PALS</span></HTML>
 === Reports ===
-**Please flesh out sections**FIXME
+  * Administering Reports   <HTML><span style="color: green;font-weight: bold">Done - from 2.1</span></HTML>
+    * Starting and Stopping the Reporter Daemon
+    * Adding Data Sources to Reporter
+    * Create a PostgreSQL query, view, or table that will provide the data for your data source
+    * Add a new class to fm_IDL.xml for your data source
+    * Restart the affected services to see the new data source in the reporter
+    * Exporting Report Templates Using phpPgAdmin
+  * Folders <HTML><span style="color: green;font-weight: bold">Done - from 2.1</span></HTML>
+    * Creating Folders
+    * Managing Folders
+  * Templates <HTML><span style="color: green;font-weight: bold">Done - from 2.1</span></HTML>
+    * Creating Templates
+    * Choosing Report Fields
+    * Applying Filters
+    * Cloning Shared Templates
+    * Template Terminology
+  * Output <HTML><span style="color: green;font-weight: bold">Done - from 2.1</span></HTML>
+    * Generating Reports from Templates
+    * Viewing Report Output
+    * Running Recurring Reports
 === Using the Online Public Access Catalog  (OPAC)  (general user help) ===
-**Please flesh out sections**FIXME
+**Please add sections**FIXME
+  * My Lists  <HTML><span style="color: green;font-weight: bold">DONE</span></HTML>
 === Developer Resources ===
@@ Line 61: / Line 212: @@
   * Other Developer basics?
   * Contributing Code to the Evergreen project
+  * Adding Translations (See: http://open-ils.org/dokuwiki/doku.php?id=evergreen-admin:customizations:i18n)
 === Appendices ===
   * Attributions