Book of Evergreen 1.6: Outline and Assignments
Below is a working outline for organizing the Documentation Interest Group's Book of Evergreen 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 1.6
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) - Ben Shum working on content ASSIGNED
-
Part: The Public Access Catalog
Introduction and Intended Audience DONE
Chapter: Basic Search - from SITKA DocBook DONE
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 - from SITKA DocBook DONE
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 - from SITKA DocBook DONE
Chapter: Search Methodology - from SITKA DocBook DONE
-
Chapter: Search Results and Details Pages - from SITKA DocBook DONE
Chapter: My Account Done
Section: Logging In (including required password change on first login, as well as self selected username alternative to card number)
Section: Password Reset - Robert Soulliere DONE
Section: Account Summary
Section: Items Checked Out
Section: Items on Hold
Section: Fines
Section: Account Preferences
Section: My Bookbags
Chapter: Self Check (simple self check interface and not to be confused with complex SIP server and hardware setup. SIP server configuration is in the SIP server chapter.) DONE
Part: Core Staff Tasks
Introduction and Intended Audience DONE
Chapter: Using the Staff Client (Install, login, start page (varies by institution or consortium), managing tabs/windows/button bar, menus, keyboard shortcuts, column editor, workstation configuration, receipt templates, operator change, exiting) [work in-progress Lindsay Stratton (Pioneer) lstratton {at} pls-net.org] DONE
Chapter: Circulation [work in-progress Lindsay Stratton (Pioneer) lstratton {at} pls-net.org] DONE
Chapter: Cataloging - (Possibly divide the whole thing into two major sections on managing & adding holdings and managing & adding records?) [work in-progress Lindsay Stratton (Pioneer) lstratton {at} pls-net.org] DONE
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?)
Section: Creating Templates
Section: Applying Templates
Section: Deleting Templates
Section: Changing Existing Templates
Section: Renaming Existing Templates
Section: Importing and Exporting Templates
Section: Changing Call Numbers
Section: Replacing Barcodes
Section: Transferring Volumes and Items
Section: Printing Spine and Pocket Labels
Section: Using the MARC Editor
Section: Editing Fixed Fields
Section: Editing the MARC Record
Section: Validating 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: Overlaying Records (Under Z 39.50?)
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: Copy Buckets
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 - content from Equinox DONE
Chapter: Acquisitions Leave out of 1.6 since it is not functional until 2.0?
(In future: Serials and Course Reserves Chapters too)
Part: Administration
Introduction and Intended Audience (mention any wiki pages that should be seen also for up to the minute info, as well as any general resources on server administration someone lacking experience might want to consult) - Robert Soulliere DONE
Chapter: System Requirements and Recommended Configuration(s) - Robert Soulliere DONE
Chapter: Evergreen Installation
-
-
Chapter: Starting, Stopping, Backups, Security, and Maintenance (other miscellanea?) - Robert Soulliere Done - add and improve as needed
Section: Starting, Stopping and Restarting OpenSRF/Evergreen
Section: Backing Up (Evergreen database and files)
Section: Security
Section: Managing Log Files
-
-
Section: Cron Jobs - Ben Shum ASSIGNED
Chapter: Server Administration (System-wide customization options) - Robert Soulliere & Roma Matott
Section: Organizational Unit Types and Organizational Units DONE
Section: User and Group Permissions DONE
Section: Copy Status DONE
Section: MARC Codes NEEDED
Section: Billing Types DONE
Section: Z39.50 Servers NEEDED
Section: Circulation Modifiers DONE
-
Section: Email Notifications DONE
Section: Cataloging Templates DONE
Section: Adjusting Search Relevancy Rankings DONE
Chapter: Local Administration (Local customizatioon options & tools for admin staff at all org-unit levels, excluding reporting which gets its own chapter)
Section:Receipt Template Editor DONE
Section:Global Font and Sound Settings DONE
Section:Printer Settings Editor DONE
Section:Closed Dates Editor DONE
Section:Copy Locations Editor DONE
Section:Library Settings Editor DONE
Section:Non-Catalogued Type Editor DONE
Section:Statistical Categories Editor DONE
Section: Standing Penalties NEEDED
Section: Group Penalty Thresholds DONE
Section: Field Documentation – Contributed by James Fournie DONE
Section: Notifications/Action Triggers NEEDED
Section:Surveys DONE
Section: Reports
DONE
- needs expanding: SQL reports, source information
Section:Cash Reports DONE
Section: Transit List NEEDED
Section: Circulation Policies NEEDED
Section: Hold Policies NEEDED
Chapter: Migrating Data (general principles, perhaps supplemented with specific examples when possible?) - Robert Soulliere, contribution by Repke de Vries, IISH NEEDS review and examples.
-
-
Chapter: Localization and Languages - Contribution by Tigran Zargaryan ASSIGNED
-
Chapter: Action Triggers - Robert Soulliere DONE
Chapter: Booking Module Administration - Jeremy Buhler DONE
Part: Reports
Chapter: Starting and Stopping the Reporter Daemon DONE
Chapter: Folders (Robert Soulliere from SITKA DocBook) DONE
Chapter: Creating Templates (Robert Soulliere from SITKA DocBook) DONE
Chapter: Generating Reports from Templates (Robert Soulliere from SITKA DocBook) DONE
Chapter: Viewing Report Output (Robert Soulliere from SITKA DocBook) DONE
Chapter: Cloning Shared Templates (Robert Soulliere from SITKA DocBook) DONE
Chapter: Running Recurring Reports (Robert Soulliere from SITKA DocBook) DONE
Chapter: Template Terminology (Robert Soulliere from SITKA DocBook) DONE
Chapter: SQL Reports NEEDED
Part: Third Party System Integration
Part: Development
Introduction and Intended Audience DONE
Chapter: OpenSRF Introduction (from Dan Scott's Article; Robert Soulliere will convert to docbook) - DONE
Chapter: Developing OpenSRF and Evergreen Applications (from Dan Scott's Workshop; Robert Soulliere will convert to docbook;) - DONE
Chapter: Intro to SQL (from Dan Scott's tutorial; Robert Soulliere will convert to docbook.) DONE
-
Chapter: File Structure and Configuration Files DONE
Chapter: Customizing the Staff Client (theme, labels & messages) DONE
Chapter: Customizing the OPAC - Robert Soullere
-
-
-
Section: Added Content DONE
Section: Customizing the Results Page DONE
Section: Customizing the Details Page DONE
-
Section: Integrated Catalog Search Box DONE
Section: Customizing the Slimpac DONE
Chapter: SuperCat Web Services
Appendices
Glossary Needs Work
-
Installation and Configuration Checklist (quick checklist of tasks to install and configure Evergreen) DONE
Database Schemas (Robert Soulliere) - auto-generated using autodoc
About This Documentation and DIG (Call for participation & credit for participants) DONE
More Information (point to open-ils.org, mailing lists, etc) DONE