This shows you the differences between two versions of the page.
|
evergreen-docs_2.2:outline [2012/03/30 12:59] 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 ===== |
| + | |||
| + | === 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) === | === Introduction and Release Notes (BASE) === | ||
| Line 17: | Line 26: | ||
| **Please add sections**FIXME | **Please add sections**FIXME | ||
| * Global system configuration (which can be done by editing opensrf.xml, opensrf_core.xml, etc...) | * 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> | + | * 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 | * Customizing the staff client | ||
| * Backing-up data and files | * Backing-up data and files | ||
| * Locales and Languages (See: http://open-ils.org/dokuwiki/doku.php?id=evergreen-admin:customizations:i18n) | * Locales and Languages (See: http://open-ils.org/dokuwiki/doku.php?id=evergreen-admin:customizations:i18n) | ||
| + | |||
| + | === Using the Staff Client === | ||
| + | * Logging in | ||
| + | * 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) === | === System-wide Administration from the staff client (Admin>>Server Administration) === | ||
| - | * Organizational Types | + | * Acquisitions <HTML><span style="color: green;font-weight: bold">DONE</span></HTML> |
| - | * Organizational Units | + | * Actor Stat Cat SIP Fields |
| - | * Permission Groups | + | * Age Hold Protect Rules |
| - | * Permissions | + | * Asset Stat Cat SIP Fields |
| - | * Copy Statuses | + | * Authorities |
| + | * Billing Types | ||
| + | * Booking | ||
| * Call Number Prefixes | * Call Number Prefixes | ||
| * Call Number Suffixes | * Call Number Suffixes | ||
| - | * MARC Record Attributes | + | * Circulation Duration Rules |
| - | * MARC Coded Value Maps | + | * Circulation Limit Groups |
| - | * MARC Search/Facet Fields | + | * Circulation Matchpoint Weights |
| - | * Billing Types | + | * Circulation Max Fine Rules |
| - | * Z39.50 Server | + | |
| * Circulation Modifiers | * Circulation Modifiers | ||
| + | * Circulation Recurring Fine Rules | ||
| + | * Copy Statuses | ||
| + | * Custom Org Unit Trees | ||
| * Global Flags | * Global Flags | ||
| + | * Hard Due Date Changes | ||
| + | * Hold Matchpoint Weights | ||
| * Import Match Sets | * Import Match Sets | ||
| + | * MARC Coded Value Maps | ||
| + | * MARC Record Attributes | ||
| + | * MARC Search/Facet Fields | ||
| + | * Organizational Types | ||
| * Organizational Unit Setting 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 | * User Setting Types | ||
| - | * Hard Due Date Changes | ||
| - | * Circulation Duration Rules | ||
| - | * Circulation Recurring Fine Rules | ||
| - | * Circulation Max Fine Rules | ||
| - | * Age Hold Protect Rules | ||
| - | * Circulation Matchpoint Weights | ||
| - | * Hold Matchpoint Weights | ||
| * Weights Association | * Weights Association | ||
| - | * Actor Stat Cat SIP Fields | + | * Z39.50 Server |
| - | * Asset Stat Cat SIP Fields | + | |
| - | * Acquisitions | + | |
| - | * Authorities | + | |
| - | * Booking | + | |
| === Local Administration (Admin>>Local Administration) === | === Local Administration (Admin>>Local Administration) === | ||
| + | * Address Alerts | ||
| * Age Overdue Circs to Lost | * Age Overdue Circs to Lost | ||
| + | * Barcode Completion | ||
| * Cash Reports | * Cash Reports | ||
| - | * Barcode Completion | + | * Circulation Limit Sets |
| * Circulation Policies | * Circulation Policies | ||
| * Closed Dates Editor | * Closed Dates Editor | ||
| * Copy Location Editor | * Copy Location Editor | ||
| * Copy Location Order | * Copy Location Order | ||
| - | * Copy Template Editor | + | * Copy Locations Editor |
| - | * Field Documenation | + | * 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 | * Group Penalty Thresholds | ||
| * Hold Policies | * Hold Policies | ||
| - | * Library Settings Editor | + | * 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 | * Non-cataloged types editor | ||
| * Notifications/Action Triggers | * Notifications/Action Triggers | ||
| * Patrons with Negative Balances | * Patrons with Negative Balances | ||
| - | * 'Do not attempt Auto-Print' Setting | + | * Reports - Refer to section below |
| - | * Reports | + | |
| * Standing Penalties | * Standing Penalties | ||
| - | * Statistical Categories Editor | + | * Statistical Categories Editor -- <HTML><span style="color: green;font-weight: bold">DONE -- From Scott Prater</span></HTML> |
| * Surveys | * Surveys | ||
| * Transit List | * Transit List | ||
| Line 86: | Line 111: | ||
| * Link to server administration>>acquisitions>>providers? | * Link to server administration>>acquisitions>>providers? | ||
| * and others? | * and others? | ||
| - | * Selection Lists | + | * Selection Lists and Purchase Orders |
| - | * 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 | * Invoices | ||
| * Receiving | * 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 === | === Cataloging === | ||
| - | **Please add more sections**FIXME | ||
| + | * Batch Edit MARC | ||
| * Batch Importing MARC Records <HTML><span style="color: green;font-weight: bold">DONE</span></HTML> | * 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> | * 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> | * 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 === | === Serials === | ||
| - | **Please add sections**FIXME | ||
| * Introduction <HTML><span style="color: green;font-weight: bold">DONE</span></HTML> | * 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) | * 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) | ||
| Line 119: | Line 161: | ||
| * Batch receiving | * Batch receiving | ||
| * Receiving through the serials control view | * Receiving through the serials control view | ||
| - | * Edit Subscriptions <HTML><span style="color: green;font-weight: bold">DONE</span></HTML> | + | * 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 === | === Circulation === | ||
| **Please add sections**FIXME | **Please add sections**FIXME | ||
| * (covering Booking as well since it is in essence a circulation task) | * (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> | * 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 === | === 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) === | === Using the Online Public Access Catalog (OPAC) (general user help) === | ||