User Tools

Site Tools


Evergreen 3.0 Documentation Needs (deprecated, see Evergreen 3.1 Documentation Needs)

Documentation needs based on the Release Notes entries that were submitted with new features during the 3.0 release cycle as well as Launchpad bugs targeted to 3.0.

Copy the HTML code below to update the status of an item:

  • Assign yourself: <html><span style="color:blue;font-weight:bold">[your name]</span></html> ([your name])
  • Add a status: <html><span style="color: green;font-weight: bold"> COMPLETE!</span></html> (COMPLETE!)


Check Sitka's documentation, especially when documenting older features: Regular Manual and Acquisitions Manual. Also, consider adding links to their YouTube video.
There is also a rough draft of the AsciiDoc version of Sitka docs, (thanks Dan Scott!).

High level workflow for documenting new EG features

These are the high-level steps we take to document new features:

  1. Look at the new feature docs to do list (this page) and sign yourself up for documenting a new feature
    1. You will need a EG community wiki account to edit wiki pages, just email for access.
  2. Look over the release notes entry for the feature you picked and decide
    1. if the feature warrants a new section in one or more of the official manuals ( to explain the new feature
    2. or just a bit of new content in an existing section that is related to the new feature.
    3. Maybe what is needed is to replace an existing screenshot in the docs with a newer screenshot that shows off or demonstrates the new feature
  3. Once you decide how the new feature should be documented follow the standard steps to contribute documentation to DIG

NOTE: Sometimes you can reuse almost all of the text in the new feature release note for use in the official docs, but sometime you have to come up with significant edits to the original release notes text.

Style Guide

Bugs/Minor Problems in the Documentation

Web Client docs needs

3.0 documentation needs

Upgrade notes

  • Change to Names of Shared Libraries
  • open-ils.auth.login
  • Multi-Time Zone Installations


  • New EDI Order Generator
  • 3 Day Courtesy Notice by SMS
  • Add Description Field to Circulation and Hold Configuration Entries
  • Apache Internal Port Configuration Option
  • Configurable Bib Record Display Fields
  • Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
  • Hold Targeter V2 Repairs and Improvements
  • New marc_export –descendants option
  • RTL and LTR Public Catalog Stylesheets Merged
  • Miscellaneous Improvements
  • Obsolete Internal Flag Removed
  • Tweaks to Caching/Expiry of Public Catalog Assets
  • Action/Trigger Events Data Purging
  • Remove JSPAC Redirects


  • New open-ils.auth.login API
  • Batch Patron Contact Invalidation


  • Pure-SQL catalog searching


  • Authority Record and Headings Browse Improvements
  • Copy Tags and Digital Bookplates Angela COMPLETE!
  • Include Call Number Prefixes and Suffixes in Export and Z39.50 output


  • Batch Editing of Patron Records
  • Honor timezone of the acting library
  • Enhancements to Hard Due Date Functionality
  • Patron Search by Birth Date
  • Patron Search from Place Hold Mary COMPLETE!
  • Retrieve Recent Patrons
  • Transit Cancel Time and Terminology Change


  • Deprecation of XUL client
  • Offline Circ Available in Web Staff Client Andrea COMPLETE!
  • Add Circ Modifier to Record Detail Page in Staff TPAC
  • Date+Time Format Settings for Web Client

Public catalog

  • Improvements to Bill Payment Pages
  • Clickable Copy Locations - DONE (pushed to master)
  • Download Checkout History CSV Fixed for Large Number of Circulations
  • Google Books Preview rewrite
  • jQuery for the TPAC
  • New Popularity Parameters
  • Option to Suspend Holds at the Time They are Placed


  • Fix to reporter.classic_current_circ view
  • New report source table allowing report of "last" deleted copy
  • Add Provider to Provider Note link
  • Link ILS User and Working Location Reporting Sources
  • New circulation report source "All Circulation Combined Types"
  • Reports Template Searching


  • Web Staff Client Serials Module Angela COMPLETE!


  • SIP Bugfix Changes How Encoding Is Determined in Configuration - done, pushed to 3.0 and above

Needs From Previous Versions

Remove items from the list below as they are completed (or confirmed to be already complete).

Borrow Chapters from Evergreen In Action (from EG 2.2)

  • Controlling how holds are fulfilled
  • Managing patron penalties and alerts
  • Care and feeding of Evergreen
  • Preparing for disaster: saving your data - done (committed to 3.0 and above)
  • Maximizing performance - this includes a lot of specific configurations, and probably needs and expert's eye to see which configurations still exist/make sense
  • Staying current and secure - done (committed to 3.0 and above)
  • Resources
  • Getting more help in the community
  • Glossary
  • Appendix A: Suggested Profile Permissions


Upgrade notes

  • Postgresql requirements
  • New services – done (committed to 2.12 and above)


  • Bibliographic Fingerprint Improvements
  • Batch Hold Targeter Speed-up and New Features (just copy the release notes entry to the docs)
  • Add separate make target for translators
  • Allow admin to specify where Perl modules will be installed
  • Addition of missing permissions (No change needed)
  • get_org_unit_ancestor_at_depth Helper Added to Action Trigger Reactor Helpers
    • It would be nice to briefly document all the available Helper functions (see
  • Removed unused selfcheck password setting (No change needed)
  • Credit Processor Stripe Settings Permissions


  • New Access Points for MARC Merge/Overlay Profiles Sally COMPLETE! Angela will commit as part of Z39.50 doc staff client rewrite


  • Active Date Column Picker Option
  • Punctuation Insensitive Patron Search - JeanetteDone (pushed to 2.12 and above)
  • Touch screen improvements for Evergreen self-check interface


  • Client Timezone Awareness

Public catalog

  • New Subject Browse Index Definitions
  • Right-to-Left Language Support for the catalog
  • Links to Other Formats and Editions [Kathy] In Progress
  • Metarecord Search Improvements [Kathy] In Progress - Note: The net effect of these search improvements was to fix bugs where we couldn't limit by format, properly retrieve e-resources, or navigate metarecord search results correctly. Since those bugs weren't mentioned in docs, I don't think anything new needs to be added here. It just works in places that it didn't work before.
  • Allow Metarecord Search by default [Kathy] In Progress
  • RDA Improvements



  • Add Date Header to Action Trigger Email/SMS Templates
  • Tablefunc Extension No Longer Required (No change needed)
  • SIP Renewals – done, pushed to 3.0 and above
  • Treat SIP Location Field as Login Workstation – done, pushed to 3.0 and above


  • Copy Alerts - Angela COMPLETE! will commit with 3.0 release


  • Staff Client Honors Aged Circulations
  • "Canceled Transit" Item Status - Debbie in progress
  • Set Per-OU Limits on Allowed Payment Amounts - done, pushed to master and 3.0


  • Additional Fields Available for Display in Some Interfaces



  • Credit card receipts and privacy (May simply copy the release notes)
  • New patron action/trigger notice
  • sortable HTML reports

some documentation may need to be updated based on these changes


  • Additional fixed fields
  • Link personal name/title series added entries
  • Change to MARC batch edit progress page


  • Alternate parts selection display when placing holds
  • non-active status copy transit message
  • selectively disallow opt-in based on patron's home library
  • standing penalty ignore proximity
  • Changes to self check interface when patron not logged in Jennifer in progress
  • self check inactivity timeout Jennifer in progress
  • duplicate search when registering patrons Jennifer in progress


  • Distinct images for pop-ups and slips


  • Editable borrowing history Jennifer in progress
  • Patron history disable warning Jennifer in progress
  • Search scope depth selection - done and committed to master and 3.0
  • New form/genre search and facet index
  • Limit numbers of facets retrieved during search
  • Password reset without an email address



  • Acquisitions
    • Support PO activation without loading copies into catalog - Should be added to chapter on PO's while moving PO chapter up - Kathy
    • Differentiate between cancelled and "delayed" lineitems - Same as above - Kathy
  • Administration
    • Default filter option for configuration screens - bitesize
  • Circulation
    • Patron barcode regex for patron registration
    • Setting for Desk Renewal to use original circulating library
    • Floating Groups - Note: Developer documentation is done, but could use review for readability and to add screenshots.
    • Patron blocking by lost items and include lost as items out
    • Wrong-Shelf Holds in Clearable Shelf-Expired Holds List - Should be incorporated (with updated screenshots) in newly revived Holds documentation
    • User Setting Defaults
  • OPAC
    • Conjoined items - update docs to update with tpac functionality and replace jspac screenshots with tpac screenshots.
    • Some new OPAC features (shelving location filter, set search context by shortname, RSS links to full catalog) should probably be incorporated in a larger "document the tpac" project.
  • Serials
    • Support Reader Address Information in Routing Slip Template
  • SIP
    • Support SIP Hold Cancellation – done, pushed to 3.0 and above
    • Return Hold ID to SIP - Probably requires some documentation since the use cases it support may not be immediately apparent.


  • Acquisitions
    • Acquisitions Inline Item Detail View - MassLNC/SITKA
    • Acquisitions Lineitem Order Identifiers - MassLNC/SITKA
    • Acquisitions Purchase Order and other Interface Improvements - MassLNC/SITKA
  • Cataloging
    • Direct access to item attribute editor - pushed to 3.0 and master
  • Administration
  • Staff Client
    • Staff Client Search Preferences - Add as separate chapter to the Using the Staff Client section. - pushed to 3.0 and master

Older or Unknown Release

  • Inventory
    • Elaine Hardy of PINES wrote some instructions that can be adapted into the official docs.
  • Patron penalty color-codes (colored border around patron name) (see Bug 1759357)
  • Cataloging (needs to be reorganized)
  • Intro to SQL (Based on Dan Scott content) Yamil still needs to make some edits like proper attribution, and test that its addition does not break the full docs
  • Library Settings Editor - (Lynn Floyd, SCLENDS is working on it)
  • OpenSRF/Evergreen Installation Guide (two PDFs linked from email below, useful but need updating)
  • Archiving of Circulation Transactions (new section)
  • Addresses on Routing List (missing?)
  • Administration
    • Local Administration
      • Copy Template Editor
      • Field Documentation
      • Group Penalty Thresholds
      • Hold Policies
      • Patrons with Negative Balances Lynn Floyd
      • Search Filter Groups
      • Surveys Lynn Floyd on hold, major bug. LP#1573269
      • Transit List Lynn Floyd
      • Hold Targeting and Hold Targeting script
    • Acquisitions
      • Patron Requests/Acquisition requests - Notes Gist FIXME
    • Server Administration
      • Actor Stat Cat Sip Fields
      • Age Hold Protect Rules
      • Asset Stat Cat Sip Fields
      • Billing Types
      • Circulation Matchpoint Weights - use wiki page
      • Custom Org Unit Trees
      • Global Flags
      • Hold Matchpoint Weights
      • User Setting Types [Stompro]
      • Database Backup and Restore Documentation Notes/In Progress Gist FIXME
      • Loop-Based Hold Targeting & Pickup Location Weight Notes/In Progress Gist FIXME
      • Override Permissions - need docs that explain that any event can have an override permission created.
  • Circulation

Non-Docs Tasks

  • Setup a mechanism for testing/building the master docs (as part of buildbot?)
    • yboston will email Dev list for feedback on this preliminary plan
    • include checks for common mistakes (incorrect image references, unused image files, etc.)
  • Improve the PDF version of the built documentation (ask community for usage, ideas, etc.)
  • Setup/use Google analytics to improve docs website design
  • Incorporate relevant docs links into Web Staff Client screens (i.e. contextual help)
  • UI improvements
evergreen-docs/3.0_needs.txt · Last modified: 2022/02/10 13:34 by

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.