User Tools

Site Tools


evergreen-docs_2.1:outline

Book of Evergreen 2.1: Outline and Assignments

Below is a working outline for organizing the Documentation Interest Group's Book of Evergreen 2.1 into Parts, Chapters, Sections, and Sections within Sections as deeply as needed. If you wish to make changes to the outline at the Part or Chapter level or that affect an area others are working on, please discuss your proposed changes on the documentation mailing list first. At the section and subsection level, many chapters are only vaguely organized. Your input on how to divide up these chapters into sections is greatly appreciated whether you edit the outline here or propose changes on the mailing list.

Besides helping keep the work in progress logically organized, this outline will also serve to keep track of who's working on which sections and subsections of the documentation at any given time and what stage those sections are in, so we can see which areas need volunteers and who to contact about a given section. When you undertake to write, test, edit, or convert a section to docbook, please add your name next to that section, and ideally your email address so others can contact you with questions, suggestions, and offers to help. Completed contributions should be submitted to the documentation mailing list for testing, editing, Docbook conversion, and committing to the repository.

Part: Introduction to Evergreen 2.1

  • Introduction and Intended Audience DONE
  • Chapter: About Evergreen (what it is, history, etc) DONE
  • Chapter: Key Concepts (organizational units and locations, flexible permissions by profile group home library or individual login, bib records/volumes/copies, item types/circ modifiers/item status/item stat cat, borrower groups/user stat cats, family accounts, patron notification/action triggers, buckets, holds behavior – targeting/retargeting/priority in filling/pull lists/expired holds/suspending holds/ holds across item types) NEEDED
  • Chapter: Release Notes DONE

Part: The Public Access Catalog

  • Introduction and Intended Audience DONE - from 2.0
  • Chapter: Basic Search NEEDED
    • Section: Entering Search Terms (automatic and, Boolean has no meaning, minus for not, auto-stemming, generally fewer terms = more results, quotes for phrases, etc)
    • Section: Basic Search Options (Limit fields to search, Limit formats to return, select locations to search, choose display language)
  • Chapter: Advanced Search NEEDED
    • Section: Search Input
    • Section: Sort Criteria
    • Section: Search Library
    • Section: Group Formats and Editions
    • Section: Limit to Available
    • Section: Search Filters
    • Section: Quick Search
    • Section: MARC Expert Search
    • Section: Text Size and Language Options
  • Chapter: Search Tips NEEDED
  • Chapter: Search Methodology NEEDED
  • Chapter: Search URL NEEDED
  • Chapter: Search Results and Details Pages NEEDED
  • Chapter: My Account NEEDED
    • Section: Logging In (including required password change on first login, as well as self selected username alternative to card number)
    • Section: Password Reset
    • Section: Account Summary
    • Section: Items Checked Out
    • Section: Items on Hold
    • Section: Fines
    • Section: Account Preferences
    • Section: My Bookbags
  • Chapter: Self Check NEEDED

Part: Core Staff Tasks

  • Introduction and Intended Audience DONE - from 2.0
  • Chapter: Using the Staff Client (Install, login, start page (varies by institution or consortium), managing tabs/windows/button bar, menus, keyboard shortcuts (Kathy Lussier), column editor, workstation configuration, receipt templates (Kathy Lussier), operator change, exiting) Migrated from 2.0
  • Chapter: Circulation
    • Section: Patron Registration and Management
      • Section: Searching Patrons
      • Section: Registering New Patrons
      • Section: Updating Patron Information
    • Section: Circulating Items Kathy Lussier
      • Section: Check Out
      • Section: Check In
      • Section: Renewal and Editing the Item's Due Date
      • Section: Marking Items Lost and Claimed Returned
      • Section: In-house Use
      • Section: Item Status
    • Section: Holds
      • Section: Placing Holds DONE - from Kathy Lussier
      • Section:Managing Holds DONE -from Kathy Lussier
      • Section:Pulling Holds DONE -from Kathy Lussier
      • Section:Holds Notification DONE - from Kathy Lussier
      • Section:Clearing Holds Shelf DONE -from Kathy Lussier
    • Section: Bills & Payment
      • Section: Making Payments
      • Section: Patron Credit
      • Section: Adding New "Grocery" Bills
      • Section: Bill History
      • Section: Refunds
  • Chapter: Cataloging - (Possibly divide the whole thing into two major sections on managing & adding holdings and managing & adding records?) NEEDED
    • Section: Locating Records
    • Section: Understanding the Holdings Maintenance Screen
    • Section: Adding Holdings
    • Section: Using the Copy Editor
      • Section: Using the Copy Editor to Make Changes
      • Section: Adding and Deleting Copy Notes
      • Section: Viewing Copy Notes in the OPAC (or maybe link this to the relevant section of the OPAC part?)
    • Section: Item Templates (under Copy Editor?)(Kathy Lussier)
      • Section: Creating Templates
      • Section: Applying Templates
      • Section: Deleting Templates
      • Section: Changing Existing Templates
      • Section: Renaming Existing Templates
      • Section: Importing and Exporting Templates
    • Section: Call Number Prefixes and Suffixes http://www.esilibrary.com/esi/docs/asciidoc/Call_Number_Prefixes_and_Suffixes_2.1_doc/Call_Number_Prefixes_and_Suffixes_2.1.txt DONE - from Sally Fortin, Equinox Software.
    • Section: Changing Call Numbers
    • Section: Replacing Barcodes
    • Section: Transferring Volumes and Items
      • Section: Transferring Volumes from One Record or Branch to Another
      • Section: Transferring Items from One Volume to Another
    • Section: Printing Spine and Pocket Labels
      • Section: Printing Labels for New Items
      • Section: Printing Labels for Existing Items
      • Section: Pocket Labels
    • Section: Using the MARC Editor – Merged from 2.0
      • Section: Editing the MARC Record (including fixed fields) – Merged from 2.0
      • Section: Overlaying MARC Records – Merged from 2.0
      • Section: Validating Records – Merged from 2.0
    • Section: Authority Records
      • Section: Viewing/Searching Authority Records
      • Section: Editing Authority Records
      • Section: Adding New Authority Records
      • Section: Merging or Deleting Authority Records
    • Section: Adding New Records via Built In Z39.50 Client
      • Section: Z39.50 Screen Features
      • Section: Importing a record via Z39.50
      • Section: Record Collisions
      • Section: Fast Item Adds
      • Section: Raw Searches
    • Section: Batch Importer / Exporter
      • Section: Importing Bibliographic Records
      • Section: Importing Authority Records
      • Section: Using the Import Queue
      • Section: Exports
      • Section: Editing Record Attributes on Import
    • Section: Creating Original Records in Evergreen
    • Section: Deleting Records from Holdings Maintenance
      • Section: Deleting Item Records from Evergreen
      • Section: Deleting Volume Records from Evergreen
      • Section: Deleting Bibliographic Records from Evergreen
      • Section: Undeleting Records
    • Section: The Item Status Screen (This is geared for use by catalogers - should there be separate sections on Item Status for different users, or should there be one multi-purpose guide with links for different areas. Same question with searching, using tabs, holds?)
      • Section: Checking Your Work Using the Item Status Screen
      • Section: Using the Item Status Screen to Make Changes to Multiple Items
      • Section: Saving Report Data in Excel for Use with the Item Status Screen
      • Section: Using Notepad to Save Report Data as a Text File
      • Section: Importing Data to the Item Status Screen from a Text File
    • Section: Pre-Cats
      • Section: Deleting Pre-Cat Items
      • Section: Transferring Pre-Cat Items to Bibliographic Records
    • Section: Copy Buckets Kathy Lussier
      • Section: Creating New Copy Buckets from the Bucket Manager
      • Section: Viewing Copy Buckets
      • Section: Adding Items to Copy Buckets from Holdings Maintenance or Item Status
      • Section: Creating New Buckets when Adding Items to Buckets
      • Section: Adding Items to Copy Buckets from the Bucket Manager
      • Section: Copying Copy Buckets
      • Section: Using Copy Bucket Manager Batch Function Tools
      • Section: Sharing Copy Buckets
      • Section: Removing Contents from Copy Buckets
      • Section: Deleting Copy Buckets
    • Section: Record Buckets
      • Creating New Record Buckets from the Bucket Manager
      • Viewing Record Buckets
      • Adding Records to Buckets when Viewing Records in the Catalog
      • Creating New Record Buckets when Adding Records to Buckets
      • Adding Records to Buckets from the Bucket Manager
      • Copying Record Buckets
      • Merging Records
      • Additional Record Bucket Manager Batch Function Tools
      • Sharing Record Buckets
      • Removing Contents from Record Buckets
      • Deleting Record Buckets
  • Chapter: Booking Done - from 2.0
  • Chapter: Acquisitions Done - from 2.0
  • Chapter: Serials Done - from 2.0
  • Chapter: Course Reserves NEEDED

Part: Administration

  • Introduction and Intended Audience DONE
  • Chapter: System Requirements and Recommended Configuration(s) NEEDED
  • Chapter: Evergreen Installation DONE -- taken from README packaged with Evergreen
  • Chapter: Staff Client Installation NEEDED
  • Chapter: Upgrading from 2.0 NEEDS REVIEW
  • Chapter: Starting, Stopping, Backups, Security, and Maintenance (other miscellanea?) Partially Done - needs Cron Jobs
    • Section: Starting, Stopping and Restarting OpenSRF/Evergreen
    • Section: Backing Up (Evergreen database and files)
    • Section: Security
    • Section: Managing Log Files
    • Section: Configuring PostgreSQL
    • Section: Cron Jobs
  • Chapter: Server Administration (System-wide customization options) June Rayner ASSIGNED adapting docs from previous versions
    • Section: Organization Types
    • Section: Organizational Units
    • Section: Adjusting Search Relevancy Rankings (?)
    • Section: Permission Groups
    • Section: Permissions
    • Section: Copy Statuses
    • Section: Billing Types
    • Section: Z30.50 Servers
    • Section: Circulation Modifiers
    • Section: Global Flags
    • Section: Organization Unit Setting Types
    • Section: User Setting Types
    • Section: Hard Due Date Changes
    • Section: Circulation Duration Rules
    • Section: Circulation Recurring Fine Rules
    • Section: Circulation Max Fine Rules
    • Section: Age Hold Protect Rules
    • Section: Acquisitions
    • Section: Booking Module
    • Section: Email Notifications (?)
    • Section: Cataloging Templates (?)
  • Chapter: Local Administration (Local customization options & tools for admin staff at all org-unit levels, excluding reporting which gets its own chapter) NEEDED
    • Section:Age Overdue Circs to Lost
    • Section:Cash Reports
    • Section:Circulation Policies
    • Section:Closed Dates Editor
    • Section:Copy Locations Editor
    • Section:Copy Locations Order
    • Section:Copy Template Editor
    • Section:External Text Editor Command
    • Section:Field Documentation
    • Section:Global Font and Sound Settings
    • Section:Group Penalty Thresholds
    • Section:Hold Policies
    • Section:Library Settings Editor
    • Section:Notifications/Action Triggers
    • Section:Patrons with Negative Balances
    • Section:Printer Settings Editor
    • Section:'Do Not Attempt Auto-Print' Setting
    • Section:Reports
    • Section:Standing Penalties
    • Section:Statistical Categories Editor
    • Section:Surveys
    • Section:Transit List
    • Section:Work Log
  • Chapter: Migrating Data (general principles, perhaps supplemented with specific examples when possible?) Done
  • Chapter: Z39.50 Server NEEDED
  • Chapter: SIP2 NEEDED
  • Chapter: Localization and Languages NEEDED
  • Chapter: Troubleshooting NEEDED
  • Chapter: Action Triggers NEEDED
  • Chapter: Booking Module Administration NEEDED

Part: Reports

  • Chapter: Starting and Stopping the Reporter Daemon Done -- from 2.0
  • Chapter: Folders Done -- from 2.0
  • Chapter: Creating Templates Done -- from 2.0
  • Chapter: Generating Reports from Templates Done -- from 2.0
  • Chapter: Viewing Report Output Done -- from 2.0
  • Chapter: Cloning Shared Templates Done -- from 2.0
  • Chapter: Running Recurring Reports Done -- from 2.0
  • Chapter: Template Terminology Done -- from 2.0
  • Chapter: Exporting Report Templates Using phpPgAdmin Done -- from 2.0
  • Chapter: SQL Reports Done -- from 2.0

Part: Third Party System Integration

  • Introduction and Intended Audience
  • Chapter: Integrating Evergreen Data in Third Party Applications NEEDED
    • Section: OpenSRF (potential overlap with Developement -> API -> OpenSRF) NEEDED
    • Section: SuperCat NEEDED
    • Section: SRU (Z39.50 [EG as target] deliberately left out) NEEDED
    • Section: OpenSearch NEEDED
    • Section: unAPI NEEDED
    • Section: SIP2 NEEDED
    • Section: Feeds NEEDED
    • Section: Asteriks and other Telephony Systems NEEDED
    • Section: EDI NEEDED

Part: Development

  • Introduction and Intended Audience
  • Chapter: OpenSRF Introduction NEEDED
  • Chapter: Developing OpenSRF and Evergreen Applications NEEDED
  • Chapter: Intro to SQL NEEDED
  • Chapter: JSON NEEDED
  • Chapter: File Structure and Configuration Files NEEDED
  • Chapter: Customizing the Staff Client (theme, labels & messages, key mappings) NEEDED
  • Chapter: Customizing the OPAC NEEDED
    • Section: Color Schemes
    • Section: Text and Labels
    • Section: Logo Images
    • Section: Added Content
    • Section: Customizing the Results Page
    • Section: Customizing the Details Page
    • Section: BibTemplate
    • Section: Integrated Catalog Search Box
    • Section: Customizing the Slimpac
  • Chapter: SuperCat Web Services NEEDED
    • Section: Searching with SuperCat
    • Section: Customizing SuperCat Results
    • Section: Adding Formats to SuperCat

Appendices

evergreen-docs_2.1/outline.txt · Last modified: 2012/03/09 10:50 by rsoulliere

© 2008-2017 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a member of Software Freedom Conservancy.