evergreen-docs:documentation

Evergreen Documentation Needs

High level workflow for documenting new EG features

1. Choose a Task	2. Read Release Notes	3. Update the Docs
- Look at the task list below and add your name next to a task - Need a wiki account? Just ask.	- Review the release notes entry for the feature (and/or the Launchpad bug) - It may need a new section in one or more of the official manuals - It may fit within an existing section - It may only need updated screenshots - You may be able to simply copy the release note into the appropriate section	- Make corrections in any format (perhaps by editing on GitHub) and share with the email list - Learn more about ways to contribute your changes

Style Guide

Remember to follow (and improve) the DIG Style Guide

3.12 Documentation Still Needed

List here all extant documentation needed for Evergreen version 3.12:

Hatch Print Config Angular Port (LP1965326) - there's not a lot on Hatch in general in the documentation.
Shelving Locations Editor: Hide deleted shelving locations by default (LP1917092) - can likely just be a quick/short addition maybe in the intro or in the section about deleting
Staff can now set a default item alert type for new item alerts (LP2017673)
Two new filter combo boxes have been added to the Holds Pull List (LP1968070) - I (Susan) can take this one, I made some updates to PINES's docs that I can generalize
Grids throughout the staff client now have an option to print only rows that the user has selected, rather than printing all rows in the grid(LP2037128) - Susan can take this one too
Adds display of upcoming closures (as entered in the Closed Dates Editor) to the library information pages in the OPAC. (LP2017913)

3.13 Documentation Still Needed

EASY Tasks for New Contributors

Bitesize (simple) documentation bugs on Launchpad:

Update "Holds Management" section for web client
- Details on Launchpad - Current Docs - Edit on GitHub

Move images into dedicated page subfolder
- Details on Launchpad

Give example for importing stat cats via Holdings Import Profile
- Details on Launchpad

Record bucket search by item type
- Details on Launchpad

Archive stat cats clarification
- Details on Launchpad

Pull Requests ready for review

See Launchpad

Add Index Terms Throughout the Docs

Documentation files that are missing index terms

Add Terms and Definitions to the Glossary

Glossary wiki page (draft)
Glossary Committed to Master. Please add any additional terms and definitions. UPDATED!!

Documentation Re-Organization Clean Up Tasks

Help improve the various new documentation manuals

Quick Start Guides

We would like to provide an "Evergreen Quick Start" guide for the most common functions of Evergreen. The intended audience is library volunteers, student workers, and staff who are new to libraries. Learn more about the initial idea.

Proof of concept
Some key features of such a guide would be:
- Short (hopefully fitting on a single page printout)
- Simple (no library jargon, no extra explanations)
- Generic (not specific to any library or consortium)
- Includes a short video
See Sitka's short videos for examples.

Here's a list of the guides we think we need. Feel free to add more!

Check In

Check Out

See the draft of a video script.

Adding Holdings

Adding call numbers and items to a bibliographic record.

How would you say "bibliographic record" without library jargon?

Undocumented Features/Changes, Taken From Release Notes

Many of these will be easy changes. Some will need no changes at all.

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

Assign yourself: <html>[your name]</html> ([your name])
Add a status: <html> COMPLETE!</html> (COMPLETE!)

Acquisitions

[3.6] Angular Providers Interface – could use some re-writing and new screenshots.
[3.2] Invoice Closed Date and Closed By Fields – it would be helpful to document the advice about creating report templates here
[2.4] Acquisitions Inline Item Detail View -
MassLNC/SITKA
- Consider borrowing from SITKA's chapter on this subject
[2.4] Acquisitions Lineitem Order Identifiers -
MassLNC/SITKA
- Consider borrowing from SITKA's chapter on this subject
[2.4] Acquisitions Purchase Order and other Interface Improvements -
MassLNC/SITKA

Administration

Acquisitions Administration

[3.2] New acq admin interfaces (listed under Architecture > Angular6 Base Application), probably needs screenshots
[3.0] New EDI Order Generator

Notification / Action Triggers

[3.0] 3 Day Courtesy Notice by SMS stephengwills
[3.0] Action/Trigger Events Data Purging
[2.12] 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 Reactor.pm)
[2.11] Add Date Header to Action Trigger Email/SMS Templates
[2.10] New patron action/trigger notice
[2.9] Pre-Expiration A/T Event Definition Stompro in progress Gist
[2.4] Generic CSV Notification Generator/Receiver (more info here: https://github.com/evergreen-library-system/Evergreen/blob/master/docs/TechRef/notify_csv.adoc)

Circulation Administration

[3.2] Permission Group Display Entries
[3.4] Angular Standing Penalty Admin Page

Credit Card Processing

~~[2.12] Credit Processor Stripe Settings Permissions~~ - Done
[2.10] Credit card receipts and privacy (May simply copy the release notes)

Installation / Upgrade / Build / Translation

Integration with other software

[3.4] Configurable APIs for Patron Authentication and Retrieval

Other (or not categorized yet)

Admin interfaces updated to Angular (probably just need new screenshots)
- [3.4] New Angular interface for Organizational Unit Administration
- [3.4] New Angular interface for OU Type
- [3.4] New Angular local admin interfaces
- [3.4] New permission group admin interface
[3.4] Server-Managed Print Templates for Angular
[3.2] Switching workstation settings to user settings: see this email, this irc message, these release notes, and especially this email
[3.1] New Latency Tester Tool [Lynn Floyd]
[3.0] Add Description Field to Circulation and Hold Configuration Entries
[3.0] Configurable Bib Record Display Fields – this would be helpful with an example of how to display these fields in notification templates and/or elsewhere
[3.0] Hold Targeter V2 Repairs and Improvements
- START WITH: [2.12] Batch Hold Targeter Speed-up and New Features (just copy the release notes entry to the docs)
[3.0] RTL and LTR Public Catalog Stylesheets Merged
[3.0] Miscellaneous Improvements
[3.0] Tweaks to Caching/Expiry of Public Catalog Assets
[2.10] sortable HTML reports
- EASY: Update screenshot of report output: http://docs.evergreen-ils.org/3.1/viewing_report_output.html
- EASY: Add brief statement somewhere on that page: "HTML reports can be sorted by clicking on the header for a given column. Clicking on the header toggles between sorting the column in ascending and descending order. NOTE: Sorting is available only when there are at most 10,000 rows of output."
[2.10] Some documentation may need to be updated based on these changes

API

[3.0] Batch Patron Contact Invalidation

Architecture

[3.3] Database Support for PostgreSQL 10
[3.0] Pure-SQL catalog searching
- NOTE: This was a big change! It may be worth writing more about it, maybe in the developer docs section.

Booking

[3.6] Booking Capture in Angular – just needs some updated screenshots

Cataloging

Holdings Editor Defaults - especially around call number defaults
[3.6] Manage Authorities angular version – some light updates and perhaps some screenshots would be helpful
[3.6] MARC Batch Edit angular version – some light updates and perhaps some screenshots would be helpful
[3.6] Preloaded Audio Icon and Search Format – should be added to this documentation. Also, that documentation should probably also be included in the cataloging area (maybe as an antora partial?).
[3.4] New Cancel Edit Button In Record Merge Interface jweston
[3.4] Staff Catalog Basket Export Option jweston
[3.4] Copy Edit Interface Display Modifications
[3.4] New options for importing copies
[3.4] Enhanced request items functionality
[3.4] Display Codes in Physical Characteristics Wizard Drop-downs – might be worth a screenshot
[3.3] Experimental Angular Staff Catalog
MARC Import/Export (a.k.a. Vandelay):
- [3.3] (Bug #1779158) MARC Import/Export Interface Update (Angular Port) – Clare
- [3.2] Asynchronous Vandelay Imports
[3.3] (Bug #1716473) Hide fields in the holdings editor, rather than simply graying them out Beth W. In progress
Spine Labels:
- [3.3] Spine label sheet printing
- [3.0] Printing spine labels (see bug #1704873) - Some very basic documentation exists, but it needs more content about how to work with the templates, etc.
[3.1] ~~Track Record Merges <html> COMPLETE!~~ – pushed to master, 3.2 and 3.3
[3.0] Include Call Number Prefixes and Suffixes in Export and Z39.50 output – added to Export documentation, not yet in Z39.50 documentation
~~[2.11] Copy Alerts - Angela COMPLETE! will commit with 3.0 release~~
[2.10] Additional fixed fields

Circulation

Billing

[3.1] New Patron Billing Statement
[3.1] Enhanced Billing Timestamp Support

Holds

[3.6] Hopeless holds
[3.1] Alternate Patron Hold Pickup
[3.1] Place Multiple Holds At Once
[3.1] Pickup Library for Staff-placed Holds
~~[2.10] Alternate parts selection display when placing holds~~
[2.5] Wrong-Shelf Holds in Clearable Shelf-Expired Holds List - Should be incorporated (with updated screenshots) in newly revived Holds documentation

Patrons

[3.6] Test notification method
[3.3] (Bug #1490616) Changed "Staff-Generated Penalties/Messages" label to "Penalties and Messages" in patron display form
- Simple text changes
- Needs updated screenshots
[3.2] Patron Preferred Name and Name Search Keywords
[3.1] Patron Email Addresses Now Clickable In Web Staff Client
[3.0] Batch Editing of Patron Records
- NOTE: Seems to be finished in 3.0 manuals
- CONSIDER removing earlier draft section: XI. User buckets
[3.0] ~~Patron Search by Birth Date~~: Katie
[3.0] ~~Retrieve Recent Patrons~~ Katie
[2.10] duplicate search when registering patrons Jennifer in progress
[2.9] User Registration Includes Inactive Accounts in Dupe Search [Lynn]
[2.5] Patron barcode regex for patron registration
[2.5] Patron blocking by lost items and include lost as items out

* staff account password resets

Self Check Out

[2.10] Changes to self check interface when patron not logged in Jennifer in progress
[2.10] self check inactivity timeout Jennifer in progress
[2.9] Selfcheck Inactivity Warning Stompro in progress Gist

Other (or not categorized yet)

[3.4] Enhanced Mark Item Functionality
[3.4] Library Links in Billing Details screen
[3.1] Copy Alerts and Suppression Matrix Angela COMPLETE! Will be added to master soon.
- CAREFUL: This intentionally replaces a "new" feature from 3.0.1: https://bugs.launchpad.net/evergreen/+bug/1719967
[3.1] New Notice Columns in Items Out Grid Angela COMPLETE! Will be added to master soon.
[3.0] Honor timezone of the acting library
[3.0] Enhancements to Hard Due Date Functionality
[3.0] Transit Cancel Time and Terminology Change
[2.11] Staff Client Honors Aged Circulations
[2.11] "Canceled Transit" Item Status - Debbie COMPLETE! GitHub PR #81
[2.10] non-active status copy transit message
[2.10] selectively disallow opt-in based on patron's home library
[2.10] standing penalty ignore proximity
[2.5] Setting for Desk Renewal to use original circulating library
[2.5] User Setting Defaults

Borrow from Shared Docs

Web Client docs
- Shared by Katie Greenleaf Martin (Blair County Library System)
  - https://drive.google.com/drive/folders/1bZ7dNaKNKdDVQOFt9dmHEnpKdYzrN_Xx?usp=sharing
  - NOTE: Only use the files showing the CC BY SA 4 logo, or ask Katie to ask the authors
- Shared by Diane Disbro (Scenic Regional Library)
  - http://libraries.missourievergreen.org/content/general
  - Only "Circulation Training Manual" volumes 1 & 2 are updated for the web client so far.
Command Line installation demos (Evergreen 2.12, includes web client)
- Shared by Ben Shum (Evergreener.net)
- https://evergreener.net/demos.html
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)

Non-Docs Tasks

Incorporate relevant docs links into Web Staff Client screens (i.e. contextual help)
- Related bug: Add links from the Web client to the relevant documentation
Improve docs testing/building via the automated testing server (aka buildbot)
- Currently, the docs are built (HTML, PDF and ePub) whenever the tests are run (every day around 6am and 6pm EST). If there is any warning or error output, it should signal a failure of the tests.
- Ideas to improve this include:
  - Adding spellcheck (using the aspell wordlist)
  - Checking for other 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
UI improvements
- OPW intern ideas

Table of Contents

Evergreen Documentation Needs

High level workflow for documenting new EG features

Style Guide

3.12 Documentation Still Needed

3.13 Documentation Still Needed

EASY Tasks for New Contributors

Other Documentation Tasks

TIPS

Quick Start Guides

Check In

Check Out

Adding Holdings

Undocumented Features/Changes, Taken From Release Notes

Acquisitions

Administration

Acquisitions Administration

Notification / Action Triggers

Circulation Administration

Credit Card Processing

Installation / Upgrade / Build / Translation

Integration with other software

Other (or not categorized yet)

API

Architecture

Booking

Cataloging

Circulation

Client

Public catalog

Reports

SIP

Borrow from Shared Docs

Other Requested Documentation

Non-Docs Tasks