===== Evergreen Documentation 2.3 ===== === Color Indicators for documentation === * RED "NEEDED" is for chapters/sections needed and not assigned. * 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. * ORANGE is for chapters/sections in progress or needing improvement. Make note as required. * a GREEN "DONE" is for chapters/sections which are generally completed and have been distributed in the documentation. === Introduction and Release Notes (BASE) === Release notes will be taken from the release notes file with code -- update as required. === Software Installation (needed for a basic working system) === * System Requirements (BASE) * Installing the server software (BASE) * Upgrading the server software (BASE) * Install EDI * Testing and Troubleshooting * Installing the Staff Client -- Done * Adding your Base Org Unit and Org. Type? * Migrating/Loading Data === System Configuration and Customization (enhancing the system) === * Global system configuration (which can be done by editing opensrf.xml, opensrf_core.xml, etc...) * Customizing the OPAC/TPAC -- From 2.2 * Auto Suggest Search box -- From 2.2 * Customizing the staff client * Backing-up data and files === Using the Staff Client === * Logging in -- rsoulliere * Tab buttons -- From 2.2 * Double clicking functionality -- From 2.2 * Patron Border Color Enhancement Done - from http://www.esilibrary.com/esi/availableDocs.php * Sorting columns -- From 2.2 * Recent searches -- From 2.2 * Return to search results from MARC editor -- From 2.2 === System-wide Administration from the staff client (Admin>>Server Administration) === * Acquisitions From 2.2 * 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 * * Maximum Checkout by Copy Location Done - from http://www.esilibrary.com/esi/availableDocs.php * 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 -- From 2.2 * User Setting Types * Weights Association * Z39.50 Server === Local Administration (Admin>>Local Administration) === * Address Alerts * 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 -- From 2.2 * 'Do not attempt Auto-Print' Setting * Field Documentation * Group Penalty Thresholds * Hold Policies * Library Settings Editor -- From 2.2 * * Auto Override Patron Hold Events Done - from http://www.esilibrary.com/esi/availableDocs.php * Non-cataloged types editor * Notifications/Action Triggers * Patrons with Negative Balances * Receipt Template Editor * * Print Holds Slip with Landscape Layout: Done - from http://www.esilibrary.com/esi/availableDocs.php * Reports - Refer to section below * Standing Penalties * * Additions to standing penalties: Done -from http://www.esilibrary.com/esi/availableDocs.php * Statistical Categories Editor -- From 2.2 * Surveys * Transit List * Work Log * * Expanding the Work Log: Done - from http://www.esilibrary.com/esi/availableDocs.php === Acquisitions === * 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 From 2.2 * Purchase Orders * Add Brief Record From 2.2 * Load MARC Order Records * Federated Search From 2.2 * Line items * Line items to the catalog * Export single attribute list * Cancel/Suspend Acquisitions * Invoices * Receiving * Receive Items from an Invoice From 2.2 * Receive items in batch * Receive specific copies * Claiming * Vandelay integration From 2.2 === Cataloging === * Batch Edit MARC * Batch Importing MARC Records From 2.2 * Create new MARC record * Conjoined Items From 2.2 * Overlay Existing Catalog Record via Z39.50 Import From 2.2 * 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 From 2.2 === Serials === * Introduction From 2.2 * 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 From 2.2 * Setting Up Subscriptions From 2.2 * Serials Control View * Setting up subscription * Handling special issues * Alternate Serials Control View * Setting up subscription * Handling special issues * Creating Special Issues From 2.2 * Holdings Statement From 2.2 * MFHD and holdings generated by serials functions * Explanation for adding and editing MFHD * Receiving From 2.2 * Batch receiving * Receiving through the serials control view * Edit Subscriptions From 2.2 * Group Serials Issues in OPAC Display From 2.2 === Circulation === * (covering Booking as well since it is in essence a circulation task) * Booking Module From 2.2 * Circulating Items From 2.2 * Holds Management * * Display Hold Types on Pull List: Done - from http://www.esilibrary.com/esi/availableDocs.php * Patron Management From 2.2 * Register patrons * Pending patrons * Editing patrons * Patron alerts and notes * Merging patrons * Triggered Events and Notices Done - from http://www.esilibrary.com/esi/availableDocs.php === Reports === * Administering Reports * 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 * Creating Folders * Managing Folders * Templates * Creating Templates * Choosing Report Fields * Applying Filters * Cloning Shared Templates * Template Terminology * Output * Generating Reports from Templates * Viewing Report Output * Running Recurring Reports === Using the Online Public Access Catalog (OPAC) (general user help) === * My Lists From 2.2 * Kids OPAC Done - from http://www.esilibrary.com/esi/availableDocs.php === Developer Resources === * Intro to Opensrf * Intro. to SQL (in context of Evergreen) * Other Developer basics? * Contributing Code to the Evergreen project * Adding Translations From 2.2 === Appendices === * Attributions