====== Book of Evergreen 2.0: Outline and Assignments ====== Below is a working outline for organizing the Documentation Interest Group's Book of Evergreen 2.0 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 [[http://libmail.georgialibraries.org/mailman/listinfo/open-ils-documentation|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.0 ===== * **Introduction and Intended Audience** * Chapter: **About Evergreen** (what it is, history, etc) DONE: pulled from 1.6 * 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) * Chapter: **Release Notes** Robert Soulliere -- DONE Converted from http://www.open-ils.org/dokuwiki/doku.php?id=feature_list_2_0 ===== Part: The Public Access Catalog ===== * **Introduction and Intended Audience** DONE: pulled from 1.6 * 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: pulled from 1.6 * 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) * Chapter: **Circulation** * Chapter: **Cataloging** - (Possibly divide the whole thing into two major sections on managing & adding holdings and managing & adding records?) * Section: Locating Records - //Kathy Lussier// ASSIGNED * Section: Understanding the Holdings Maintenance Screen - //Kathy Lussier// ASSIGNED * Section: Adding Holdings - //Kathy Lussier// ASSIGNED * Section: Adding Volumes * Section: Adding Items / Copies * Section: Adding Holdings for Multiple Volumes or Branches Simultaneously * Section: Using the Copy Editor - - //Kathy Lussier// ASSIGNED * 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// ASSIGNED * 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 - //Kathy Lussier// ASSIGNED * Section: Replacing Barcodes - //Kathy Lussier// ASSIGNED * Section: Transferring Volumes and Items - //Kathy Lussier// ASSIGNED * Section: Transferring Volumes from One Record or Branch to Another * Section: Transferring Items from One Volume to Another * Section: Printing Spine and Pocket Labels NEEDED * Section: Printing Labels for New Items * Section: Printing Labels for Existing Items * Section: Pocket Labels * Section: Using the MARC Editor - //Hilary Caws-Elwitt// ASSIGNED * Section: Editing the MARC Record (including fixed fields) * Section: Overlaying MARC Records * Section: Validating Records * Section: Authority Records - //Hilary Caws-Elwitt// ASSIGNED * 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 - //Hilary Caws-Elwitt// ASSIGNED * 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 NEEDED * 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 NEEDED * Section: Deleting Records from Holdings Maintenance NEEDED * 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?) NEEDED * 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 NEEDED * Section: Deleting Pre-Cat Items * Section: Transferring Pre-Cat Items to Bibliographic Records * Section: Copy Buckets NEEDED * 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 NEEDED * 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: pulled from 1.6 * Chapter: **Acquisitions** DONE: Merged by Jennifer Turner * Chapter: **Serials** NEEDS WORK- FROM GPLS * Chapter: **Course Reserves** NEEDED ===== Part: Administration ===== * **Introduction and Intended Audience** DONE: pulled from 1.6 * Chapter: **System Requirements and Recommended Configuration(s)** DONE - added to repo from 1.6 * Chapter: **Evergreen Installation** * Section: **Server-side Installation** * Section: Installing Evergreen 2.0 On Ubuntu and Debian WORKING - ssheppard will adapt from OLD 1.6 * Section: Installing Evergreen 2.0 On Fedora 13 and 14 WORKING - ssheppard will adapt from latest http://evergreen-ils.org/dokuwiki/doku.php?id=server:2.0:install:fedora&s[]=installing&s[]=evergreen&s[]=2&s[]=0 * Section: Installing OpenSRF 1.6.x On Ubuntu and Debian WORKING - ssheppard will adapt from OLD 1.6 * Chapter: **Staff Client Installation** NEEDED * Chapter: **Upgrading from 1.6** More review required * Chapter: **Starting, Stopping, Backups, Security, and Maintenance** (other miscellanea?) More sections needed? * Section: Starting, Stopping and Restarting OpenSRF/Evergreen DONE: pulled from 1.6 * Section: Backing Up (Evergreen database and files) DONE: pulled from 1.6 * Section: Security DONE: pulled from 1.6 * Section: Managing Log Files DONE: pulled from 1.6 * Section: Configuring PostgreSQL DONE: pulled from 1.6 * Section: Cron Jobs NEEDED * Chapter: **Server Administration** (System-wide customization options) NEEDED * 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 ([[evergreen-admin:customization:indb-circ|Draft docs from Thomas Berezansky's rewrite adventure, covers 1.6-2.1]]) * 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?) orange Pulled from 1.6 -- review needed * Chapter: **Z39.50 Server** DONE: pulled from 1.6 * Chapter: **SIP2** DONE: pulled from 1.6 * Chapter: **Localization and Languages** NEEDED * Chapter: **Troubleshooting** DONE: pulled from 1.6 * Chapter: **Action Triggers** DONE: pulled from 1.6 * Chapter: **Booking Module Administration** DONE: pulled from 1.6 ===== Part: Reports ===== * Chapter: **Folders** Done: pulled from 1.6 * Chapter: **Creating Templates** Done: pulled from 1.6 * Chapter: **Generating Reports from Templates** Done: pulled from 1.6 * Chapter: **Viewing Report Output**Done: pulled from 1.6 * Chapter: **Cloning Shared Templates** Done: pulled from 1.6 * Chapter: **Running Recurring Reports** Done: pulled from 1.6 * Chapter: **Template Terminology** Done: pulled from 1.6 * Chapter: **Starting and Stopping the Reporter Daemon** Done: pulled from 1.6 * Chapter: **Exporting Report Templates Using phpPgAdmin** Done * Chapter: **SQL Reports** NEEDED ===== 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** DONE: pulled from 1.6 * Chapter: **OpenSRF Introduction** DONE: pulled from 1.6 * Chapter: **Developing OpenSRF and Evergreen Applications** Some of this is in OpenSRF Introduction - review needed: pulled from 1.6 * Chapter: **Intro to SQL** DONE: pulled from 1.6 * Chapter: **JSON** DONE: pulled from 1.6 * Chapter: **File Structure and Configuration Files** DONE: pulled from 1.6 * Chapter: **Customizing the Staff Client** (theme, labels & messages, key mappings) Should be reviewed and updated: pulled from 1.6 * Chapter: **Customizing the OPAC** Should be reviewed and updated: pulled from 1.6 * 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** Should be enhanced, reviewed and updated: pulled from 1.6 * Section: Searching with SuperCat * Section: Customizing SuperCat Results * Section: Adding Formats to SuperCat ===== Appendices ===== * **Installation and Configuration Checklist** (quick checklist of tasks to install and configure Evergreen) * **Permissions List** - List of permissions with definitions auto-generated using a postgresql function. NEEDED: Improved descriptions of the permissions in database table. * See: [[https://github.com/rsoulliere/Evergreen-DocBook/blob/master/tools/permissions_to_docbook_function.sql]]for details. * **Database Schemas** - Robert Soulliere auto-generated using autodoc * **Glossary** * **Index** generated by DocBook but editors need to indicate which terms will be indexed. See [[http://www.docbook.org/tdg5/en/html/indexterm.singular.html]] * **About This Documentation and DIG** (Call for participation & credit for participants) DONE: pulled from 1.6 * **More Information** (point to open-ils.org, mailing lists, etc) DONE: pulled from 1.6