zzz_archive:evergreen-docs_2.3:outline
Table of Contents
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 EnhancementDone - 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)
- AcquisitionsFrom 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 LocationDone - 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 EventsDone - 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 ListsFrom 2.2
- Purchase Orders
- Add Brief RecordFrom 2.2
- Load MARC Order Records
- Federated SearchFrom 2.2
- Line items
- Line items to the catalog
- Export single attribute list
- Cancel/Suspend Acquisitions
- Invoices
- Receiving
- Receive Items from an InvoiceFrom 2.2
- Receive items in batch
- Receive specific copies
- Claiming
- Vandelay integrationFrom 2.2
Cataloging
- Batch Edit MARC
- Batch Importing MARC RecordsFrom 2.2
- Create new MARC record
- Conjoined ItemsFrom 2.2
- Overlay Existing Catalog Record via Z39.50 ImportFrom 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 PartsFrom 2.2
Serials
- IntroductionFrom 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 TemplatesFrom 2.2
- Setting Up SubscriptionsFrom 2.2
- Serials Control View
- Setting up subscription
- Handling special issues
- Alternate Serials Control View
- Setting up subscription
- Handling special issues
- Creating Special IssuesFrom 2.2
- Holdings StatementFrom 2.2
- MFHD and holdings generated by serials functions
- Explanation for adding and editing MFHD
- ReceivingFrom 2.2
- Batch receiving
- Receiving through the serials control view
- Edit SubscriptionsFrom 2.2
- Group Serials Issues in OPAC DisplayFrom 2.2
Circulation
- (covering Booking as well since it is in essence a circulation task)
- Booking ModuleFrom 2.2
- Circulating ItemsFrom 2.2
- Holds Management
- * Display Hold Types on Pull List:Done - from http://www.esilibrary.com/esi/availableDocs.php
- Patron ManagementFrom 2.2
- Register patrons
- Pending patrons
- Editing patrons
- Patron alerts and notes
- Merging patrons
- Triggered Events and NoticesDone - 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 ListsFrom 2.2
- Kids OPACDone - 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 TranslationsFrom 2.2
Appendices
- Attributions
zzz_archive/evergreen-docs_2.3/outline.txt · Last modified: 2022/02/10 13:34 by 127.0.0.1