User Tools

Site Tools


evergreen-docs:documentation_needs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

evergreen-docs:documentation_needs [2021/05/28 13:00]
lfloyd
evergreen-docs:documentation_needs [2022/02/10 13:34]
Line 1: Line 1:
-=====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? [[docs@evergreen-ils.org|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 [[http://docs.evergreen-ils.org|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 [[open-ils-documentation@list.georgialibraries.org|email list]]\\ - Learn more about [[evergreen-docs:how-to-contribute-documentation|ways to contribute your changes]] | 
- 
-==== Style Guide ==== 
- 
-  * Remember to follow (and improve) the [[evergreen-docs:dig_style_guide|DIG Style Guide]] 
- 
-===== EASY Tasks for New Contributors ===== 
- 
-**Bitesize (simple) documentation bugs on [[https://bugs.launchpad.net/evergreen/?field.searchtext=&orderby=-importance&search=Search&field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=FIXCOMMITTED&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&assignee_option=any&field.tag=bitesize-doc+&field.tags_combinator=ANY|Launchpad]]**: 
- 
-  * **IDL acronym used, but never defined**<html><span style="color:blue;font-weight:bold">Lynn and Blake</span></html> <html><span style="color: green;font-weight: bold"> COMPLETE!</span></html> 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1857917|Details on Launchpad]] 
-    * Simply add term to glossary (can use suggested definition on bug report) 
- 
-  * **Docs use acronym TLD without defining it** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1837753|Details on Launchpad]] 
-    * Add term to glossary (can use suggested definition on bug report) 
-    * Also change first use of "TLD" to "Top Level Domain (TLD)" 
- 
-  * **Documentation needed for adjustable font size in the catalog** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1250528|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_using_the_browser_staff_client.html|Current Docs]] - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/admin/web-client-browser-best-practices.adoc|Edit on GitHub]] 
-    * To fix this, let's add a section about browser font size controls to the "Using the Browser Staff Client" chapter 
-      * [[https://support.mozilla.org/en-US/kb/font-size-and-zoom-increase-size-of-web-pages|Mozilla Firefox]] 
-      * [[https://support.google.com/chrome/answer/96810?hl=en|Google Chrome]] 
- 
-  * **Add tips for using the browser bookmarks toolbar in place of the XUL button bar** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1751146|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_best_practices_for_using_the_browser.html|Current Docs]] - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/admin/web-client-browser-best-practices.adoc|Edit on GitHub]] 
-      * [[https://support.google.com/chrome/answer/188842?hl=en&co=GENIE.Platform=Desktop|Managing Bookmarks in Google Chrome]] 
-      * We may want to include tips about [[https://support.google.com/chrome/answer/2391819?co=GENIE.Platform%3DDesktop&hl=en|Managing Tabs in Google Chrome]] 
- 
-  * **Update "Holds Management" section for web client** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1775402|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_holds_management.html|Current Docs]] - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/circulation/advanced_holds.adoc|Edit on GitHub]] 
- 
-  * **Update "Address Alert" section for web client** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1776977|Details on Launchpad]] - [[http://docs.evergreen-ils.org/dev/_address_alert.html|Current Docs]] - [[https://github.com/evergreen-library-system/Evergreen/blob/master/docs/admin/lsa-address_alert.adoc|Edit on GitHub]] 
- 
-  * **Give example for importing stat cats via Holdings Import Profile** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1845499|Details on Launchpad]] 
- 
-  * **Record bucket search by item type** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1845253|Details on Launchpad]] 
- 
-  * **Archive stat cats clarification** 
-    * [[https://bugs.launchpad.net/evergreen/+bug/1836221|Details on Launchpad]] 
- 
-**Pull Requests ready for review** 
- 
-  * [[https://bugs.launchpad.net/evergreen/+bugs?field.searchtext=&orderby=-importance&field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=FIXCOMMITTED&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&field.tag=documentation+pullrequest&field.tags_combinator=ALL|See Launchpad]] 
- 
- 
- 
-**Add Index Terms Throughout the Docs** 
-  * [[evergreen-docs:adding_indexterms|Documentation files that are missing index terms]] 
- 
-**Add Terms and Definitions to the Glossary** 
-  * [[evergreen-docs:glossary|Glossary wiki page (draft)]] 
-  * [[https://bugs.launchpad.net/evergreen/+bug/1855451|Glossary Committed to Master]].  Please add any additional terms and definitions. <html><span style="color: green;font-weight: bold"> UPDATED!!</span></html> 
- 
-**Documentation Re-Organization Clean Up Tasks** 
-  * Help improve the various new [[evergreen-docs:reorg:clean_up|documentation manuals]] 
- 
- 
-===== Other Documentation Tasks ===== 
- 
-  * [[https://bugs.launchpad.net/evergreen/?field.searchtext=&orderby=-importance&search=Search&field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=FIXCOMMITTED&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&assignee_option=any&field.tag=documentation+&field.tags_combinator=ANY|All documentation bugs]] on Launchpad 
- 
- 
- 
-<html><div style="background:#FFDDDD; padding:0.3em"> 
-<h3>TIPS</h3> 
-Check Sitka's documentation, especially when documenting older features: 
-<ul><li><a href="http://docs.libraries.coop/sitka/">Main Manual</a> (<a href="https://github.com/BCLibCoop/sitka-manual">AsciiDoc files here</a>)</li> 
-<li><a href="http://docs.libraries.coop/acquisitions/">Acquisitions Manual</a> (<a href="https://github.com/BCLibCoop/acq-manual">AsciiDoc files here</a>)</li></ul> 
- 
-Also, consider adding links to their <a href="https://www.youtube.com/channel/UCiMYBCQG4QJVT-B3Ruk0Ncg">YouTube videos</a>. 
-</div></html> 
- 
-===== 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 [[evergreen-docs:quickstarts|initial idea]]. 
- 
-  * [[http://www.sandbox.lbcc.linnlibraries.org/Evergreen/docs/quickstarts/check_out.html|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 [[https://www.youtube.com/playlist?list=PLdwlgwBNnH4rSKEJPA3Q_vz7QO-h4JN0P|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 [[evergreen-docs:quickstarts#check_out|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><span style="color:blue;font-weight:bold">[your name]</span></html>'' (<html><span style="color:blue;font-weight:bold">[your name]</span></html>) 
-  * Add a status: ''<html><span style="color: green;font-weight: bold"> COMPLETE!</span></html>'' (<html><span style="color: green;font-weight: bold">COMPLETE!</span></html>) 
- 
-==== Acquisitions ==== 
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_acquisitions|Angular Providers Interface]] -- could use some re-writing and new screenshots. 
-  * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Invoice Closed Date and Closed By Fields]] -- it would be helpful to document the advice about creating report templates here 
-  * [2.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_4.html|Acquisitions Inline Item Detail View]] - <HTML><span style="color:blue;font-weight:bold">MassLNC/SITKA</span></HTML> 
-    * Consider borrowing from [[https://docs.libraries.coop/acquisitions/_line_items.html#lineitem-detail|SITKA's chapter on this subject]] 
-  * [2.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_4.html|Acquisitions Lineitem Order Identifiers]] - <HTML><span style="color:blue;font-weight:bold">MassLNC/SITKA</span></HTML> 
-    * Consider borrowing from [[https://docs.libraries.coop/acquisitions/_line_items.html#order-identifier|SITKA's chapter on this subject]] 
-  * [2.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_4.html|Acquisitions Purchase Order and other Interface Improvements]] - <HTML><span style="color:blue;font-weight:bold">MassLNC/SITKA</span></HTML> 
- 
-   
-==== Administration ==== 
- 
-=== Acquisitions Administration === 
-  * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|New acq admin interfaces]] (listed under Architecture > Angular6 Base Application), probably needs screenshots 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|New EDI Order Generator]] 
- 
- 
-=== Notification / Action Triggers === 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|3 Day Courtesy Notice by SMS]] <html><span style="color:blue;font-weight:bold">stephengwills</span></html> 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Action/Trigger Events Data Purging]] 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|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 [[http://git.evergreen-ils.org/?p=Evergreen.git;a=blob;f=Open-ILS/src/perlmods/lib/OpenILS/Application/Trigger/Reactor.pm;h=0df0ab08ba8e284c40c684408420a9b21433f6be;hb=refs/heads/rel_2_12#l39|Reactor.pm]]) 
-  * [2.11] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_11.html|Add Date Header to Action Trigger Email/SMS Templates]] 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|New patron action/trigger notice]] 
-  * [2.9] [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_pre_expiration_a_t_event_definition|Pre-Expiration A/T Event Definition]] <html><span style="color:blue;font-weight:bold"> Stompro</span><span style="color: green;font-weight: bold"> in progress</span></html> [[https://gist.github.com/stompro/5574d7e4587d3c3e7587|Gist]] FIXME 
-  * [2.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_4.html|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] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Permission Group Display Entries]] 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_angular_standing_penalty_admin_page|Angular Standing Penalty Admin Page]] 
- 
-=== Credit Card Processing === 
-  * <del>[2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|Credit Processor Stripe Settings Permissions]]</del> - Done 
-  * [2.10] Credit card receipts and privacy (May simply copy the [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html#_credit_card_receipts_and_privacy|release notes]]) 
- 
-=== Installation / Upgrade / Build / Translation === 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|Add separate make target for translators]] 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|Allow admin to specify where Perl modules will be installed]] 
- 
-=== Integration with other software === 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_configurable_apis_for_patron_authentication_and_retrieval|Configurable APIs for Patron Authentication and Retrieval]] 
- 
-=== Other (or not categorized yet) === 
-  * Admin interfaces updated to Angular (probably just need new screenshots) 
-    * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_angular_organizational_units_admin_page|New Angular interface for Organizational Unit Administration]] 
-    * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_port_org_unit_type_admin_to_angular|New Angular interface for OU Type]] 
-    * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_port_local_administration_page_to_angular|New Angular local admin interfaces]] 
-    * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_port_permission_group_admin_to_angular|New permission group admin interface]] 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_server_managed_print_templates_for_angular|Server-Managed Print Templates for Angular]] 
-  * [3.2] Switching workstation settings to user settings: see [[https://markmail.org/message/hfaogumstphagscy|this email]], [[http://irc.evergreen-ils.org/evergreen/2019-06-03#i_408119|this irc message]], [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html#_browser_client_settings_amp_preferences_stored_on_the_server|these release notes]], and especially [[https://markmail.org/message/njz7qt7lfmhmtjgo|this email]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|New Latency Tester Tool]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Add Description Field to Circulation and Hold Configuration Entries]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|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] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Hold Targeter V2 Repairs and Improvements]] 
-    * START WITH: [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html#_batch_hold_targeter_speed_up_and_new_features|Batch Hold Targeter Speed-up and New Features]] (just copy the release notes entry to the docs) 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|RTL and LTR Public Catalog Stylesheets Merged]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Miscellaneous Improvements]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Tweaks to Caching/Expiry of Public Catalog Assets]] 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|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 [[https://evergreen-ils.org/documentation/previews/RELEASE_NOTES_2_10_beta.html#_administration | changes]] 
- 
-==== API ==== 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Batch Patron Contact Invalidation]] 
- 
- 
-==== Architecture ==== 
-  * [3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Database Support for PostgreSQL 10]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|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] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_circulation|Booking Capture in Angular]] -- just needs some updated screenshots 
-==== Cataloging ==== 
- 
-  * Holdings Editor Defaults - especially around call number defaults 
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_cataloging|Manage Authorities angular version]] -- some light updates and perhaps some screenshots would be helpful 
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_cataloging|MARC Batch Edit angular version]] -- some light updates and perhaps some screenshots would be helpful 
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_administration|Preloaded Audio Icon and Search Format]] -- should be added to [[https://docs.evergreen-ils.org/eg/docs/latest/admin/MARC_RAD_MVF_CRA.html#_search_and_icon_formats|this documentation]].  Also, that documentation should probably also be included in the cataloging area (maybe as an [[https://docs.antora.org/antora/2.2/asciidoc/include-partial/|antora partial]]?). 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_new_cancel_edit_button_in_record_merge_interface|New Cancel Edit Button In Record Merge Interface]] <html><span style="color:blue;font-weight:bold">jweston</span></html> 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_staff_catalog_basket_export_option|Staff Catalog Basket Export Option]] <html><span style="color:blue;font-weight:bold">jweston</span></html> 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_copy_edit_interface_display_modifications|Copy Edit Interface Display Modifications]] 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_new_options_for_importing_copies|New options for importing copies]] 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_enhanced_request_items_functionality|Enhanced request items functionality]] 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_display_codes_in_physical_characteristics_wizard_drop_downs_lp_1776003|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] ([[https://bugs.launchpad.net/bugs/1779158|Bug #1779158]]) [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|MARC Import/Export Interface Update (Angular Port)]] -- <html><span style="color:blue;font-weight:bold">Clare</span></html> 
-    * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Asynchronous Vandelay Imports]] 
-  * [3.3] ([[https://bugs.launchpad.net/evergreen/+bug/1716473|Bug #1716473]]) Hide fields in the holdings editor, rather than simply graying them out <html><span style="color:blue;font-weight:bold">Beth W.</span> <span style="color: green;font-weight: bold">In progress</span></html> 
-  * Spine Labels: 
-    * [3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Spine label sheet printing]] 
-    * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Printing spine labels]] (see [[https://bugs.launchpad.net/evergreen/+bug/1704873|bug #1704873]]) - Some very basic documentation exists, but it needs more content about how to work with the templates, etc. 
-  * [3.1] <del>[[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Track Record Merges]] <html><span style="color: green;font-weight: bold"> COMPLETE!</del> -- pushed to master, 3.2 and 3.3 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Include Call Number Prefixes and Suffixes in Export and Z39.50 output]] -- added to Export documentation, not yet in Z39.50 documentation 
-  * <del>[2.11] Copy Alerts - **Angela COMPLETE!** will commit with 3.0 release</del> 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Additional fixed fields]] 
- 
- 
-==== Circulation ==== 
- 
-Billing 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|New Patron Billing Statement]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Enhanced Billing Timestamp Support]] 
- 
-Holds 
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_circulation|Hopeless holds]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Alternate Patron Hold Pickup]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Place Multiple Holds At Once]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Pickup Library for Staff-placed Holds]] 
-  * <del>[2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Alternate parts selection display when placing holds]]</del> 
-  * [2.5] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_5.html|Wrong-Shelf Holds in Clearable Shelf-Expired Holds List]] - Should be incorporated (with updated screenshots) in newly revived [[http://docs.evergreen-ils.org/dev/_managing_holds.html#_clearing_shelf_expired_holds|Holds documentation]] 
- 
-Patrons 
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_circulation|Test notification method]] 
-  * [3.3] ([[https://bugs.launchpad.net/bugs/1490616|Bug #1490616]]) Changed "Staff-Generated Penalties/Messages" label to "Penalties and Messages" in patron display form  
-    * Simple text changes 
-    * Needs updated screenshots 
-  * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Patron Preferred Name and Name Search Keywords]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Patron Email Addresses Now Clickable In Web Staff Client]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Batch Editing of Patron Records]] 
-    * NOTE: Seems to be finished in [[http://docs.evergreen-ils.org/3.0/_user_buckets.html|3.0 manuals]] 
-    * CONSIDER removing earlier draft section: [[http://docs.evergreen-ils.org/reorg/3.0/circulation/_user_buckets_2.html|XI. User buckets]] 
-  * [3.0] <del>[[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Patron Search by Birth Date]]</del>: <html><span style="color:blue;font-weight:bold">Katie</span></html> 
-  * [3.0] <del>[[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Retrieve Recent Patrons]]</del>  <html><span style="color:blue;font-weight:bold">Katie</span></html> 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|duplicate search when registering patrons]] <html><span style="color:blue;font-weight:bold">Jennifer</span> <span style="color: green;font-weight: bold">in progress</span></html> 
-  * [2.9] [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_user_registration_includes_inactive_accounts_in_dupe_search|User Registration Includes Inactive Accounts in Dupe Search]] <html><span style="color:blue;font-weight:bold">[Lynn]</span></html> 
-  * [2.5] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_5.html|Patron barcode regex for patron registration]] 
-  * [2.5] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_5.html|Patron blocking by lost items and include lost as items out]] 
- * [[http://docs.libraries.coop/sitka/_resetting_staff_account_password.html | staff account password resets]] 
- 
-Self Check Out 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Changes to self check interface when patron not logged in]] <html><span style="color:blue;font-weight:bold">Jennifer</span> <span style="color: green;font-weight: bold">in progress</span></html> 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|self check inactivity timeout]] <html><span style="color:blue;font-weight:bold">Jennifer</span> <span style="color: green;font-weight: bold">in progress</span></html> 
-  * [2.9] [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_selfcheck_inactivity_warning|Selfcheck Inactivity Warning]] <html><span style="color:blue;font-weight:bold"> Stompro</span><span style="color: green;font-weight: bold"> in progress</span></html> [[https://gist.github.com/stompro/7811c59905a321807518|Gist]] FIXME 
- 
-Other (or not categorized yet) 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_enhanced_mark_item_functionality|Enhanced Mark Item Functionality]] 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_library_links_in_billing_details_screen|Library Links in Billing Details screen]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Copy Alerts and Suppression Matrix]] <html><span style="color:blue;font-weight:bold">Angela</span> <span style="color: green;font-weight: bold">COMPLETE! Will be added to master soon.</span></html> 
-    * **CAREFUL**: This intentionally replaces a "new" feature from 3.0.1: https://bugs.launchpad.net/evergreen/+bug/1719967 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|New Notice Columns in Items Out Grid]] <html><span style="color:blue;font-weight:bold">Angela</span> <span style="color: green;font-weight: bold">COMPLETE! Will be added to master soon.</span></html> 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Honor timezone of the acting library]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Enhancements to Hard Due Date Functionality]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Transit Cancel Time and Terminology Change]] 
-  * [2.11] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_11.html|Staff Client Honors Aged Circulations]] 
-  * [2.11] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_11.html|"Canceled Transit" Item Status]] - <html><span style="color:blue;font-weight:bold">Debbie</span></html> <html><span style="color: green;font-weight: bold"> COMPLETE!</span></html> **[[https://github.com/evergreen-library-system/Evergreen/pull/81|GitHub PR #81]]** FIXME 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|non-active status copy transit message]] 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|selectively disallow opt-in based on patron's home library]] 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|standing penalty ignore proximity]] 
-  * [2.5] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_5.html|Setting for Desk Renewal to use original circulating library]] 
-  * [2.5] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_5.html|User Setting Defaults]] 
- 
-==== Client ==== 
-  * [3.6] Angular staff catalog is now the default -- probably lots of implications for step-by-step procedures, screenshots, etc. 
-  * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Disabling of legacy XUL client]] 
-  * [3.2] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_2.html|Browser Client Settings & Preferences Stored on the Server]] -- also see this IRC discussion: http://irc.evergreen-ils.org/evergreen/2019-06-03#i_408119 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Add Circ Modifier to Record Detail Page in Staff TPAC]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Date+Time Format Settings for Web Client]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|New "About Evergreen" page]] (see [[https://bugs.launchpad.net/evergreen/+bug/1718036|bug #1718036]]) 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|Active Date Column Picker Option]] 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|Touch screen improvements for Evergreen self-check interface]] 
-  * [2.11] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_11.html|Additional Fields Available for Display in Some Interfaces]] 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_angular_grid_improvements|New features for Angular Grids]] 
-   
-==== Course Materials ==== 
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_circulation|Course Materials Module]] -- [[https://docs.google.com/document/d/1Dy1jcs6Kog8kxuIGg2GfJ4wIr4uKwMuMzd-uGuovaCc/edit#|this test plan]] may be helpful 
- 
-==== Public catalog ==== 
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_opac_2|Enhanced Public Catalog Printing and Email]] 
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_opac_2|Improve Access to Libray Info in OPAC]] 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_carousels|Carousels]] 
-    * NOTE: This contains info that should be added to other sections (e.g. Administration, OPAC Customization) 
-    * Add this tip (from Jason Boyer via Evergreen General Discussion List) to the OPAC Customization section: 
-      * Here is the format to specify those parameters: ''[% PROCESS carousels args={width=5,animated=1} %]'' 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_item_tags_now_display_tag_type_labels|Item Tags Now Display Tag Type Labels]] 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_new_column_in_items_out_display|New Column in Items Out Display]] 
-  * [3.3] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_3.html|Display UPC as Option for Public Catalog Advanced Search]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Search term highlighting]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Copy Location Filter Displays for System Searches]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Multi-source Attributes]] 
-  * [3.1] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_1.html|Optional Display of Badges in OPAC]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Improvements to Bill Payment Pages]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Download Checkout History CSV Fixed for Large Number of Circulations]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|jQuery for the TPAC]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|New Popularity Parameters]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Option to Suspend Holds at the Time They are Placed]] 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|New Subject Browse Index Definitions]] 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|Right-to-Left Language Support for the catalog]] 
-    * NOTE: It looks like this should be documented under [[http://docs.evergreen-ils.org/dev/_setting_a_default_language_and_adding_optional_languages.html|Designing your catalog]] 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|Links to Other Formats and Editions]] 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|Metarecord Search Improvements]] <html><span style="color:blue;font-weight:bold">[Kathy]</span><span style="color: green;font-weight: bold"> In Progress</span></html> - 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. 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|Allow Metarecord Search by default]] 
-  * [2.12] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_12.html|RDA Improvements]] 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Editable borrowing history]] <html><span style="color:blue;font-weight:bold">Jennifer</span></html> <html><span style="color: green;font-weight: bold">in progress</span></html> 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Patron history disable warning]] <html><span style="color:blue;font-weight:bold">Jennifer</span></html> <html><span style="color: green;font-weight: bold">in progress</span></html> 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|New form/genre search and facet index]] 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Limit numbers of facets retrieved during search]] 
-  * [2.10] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_10.html|Password reset without an email address]] 
-  * [2.9] [[http://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_9.html#_new_class_attribute_for_e_resource_links|New class attribute for e-resource links]] 
-    * **EASY:** Add release notes to [[http://docs.evergreen-ils.org/dev/_designing_your_catalog.html|TPAC docs]] within section "Adding and removing MARC fields from the record details display page" 
-  * [2.5] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_5.html|Conjoined items - update [[http://docs.evergreen-ils.org/2.4/_conjoined_items.html]] docs to update with tpac functionality and replace jspac screenshots with tpac screenshots.]] 
-  * [2.5] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_5.html|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.]] 
- 
- 
-==== Reports ==== 
-  * [3.6] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_6_0.html#_reports|Subtotals]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Fix to reporter.classic_current_circ view]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|New report source table allowing report of "last" deleted copy]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Add Provider to Provider Note link]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Link ILS User and Working Location Reporting Sources]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|New circulation report source "All Circulation Combined Types"]] 
-  * [3.0] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_0.html|Reports Template Searching]] 
- 
-   
- 
-==== SIP ==== 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_fine_item_detail_enhancements|Fine Item Detail Enhancements]] 
-  * [3.4] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_3_4.html#_option_to_limit_hold_items_to_available|Option to Limit Hold Items to Available]] 
-  * [2.5] [[https://evergreen-ils.org/documentation/release/RELEASE_NOTES_2_5.html|Return Hold ID to SIP - Probably requires some documentation since the use cases it support may not be immediately apparent.]] (the release notes are not clear about when this is returned, etc.) 
- 
- 
- 
-==== 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 [[http://pines.georgialibraries.org/inventory|some instructions]] that can be adapted into the official docs. 
-  * Patron penalty color-codes (colored border around patron name) ([[https://bugs.launchpad.net/evergreen/+bug/1759357|see Bug 1759357]]) 
- 
-==== Other Requested Documentation ==== 
- 
-  * Cataloging (needs to be reorganized) 
-    * Need a new "Volume/Copy Editor" section (borrow from [[http://docs.evergreen-ils.org/dev/_monograph_parts.html|"Monograph Parts"]]) 
-  * 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 
-  * <del>Library Settings Editor</del> - (Lynn Floyd, SCLENDS) 
-  * OpenSRF/Evergreen Installation Guide (two PDFs linked from email below, useful but need updating) 
-    * http://markmail.org/thread/uitwopkmbv2nqlhs 
-  * Archiving of Circulation Transactions (new section) 
-  * Addresses on Routing List (missing?) 
-  * Wrong Cover Art, and what to do.  
- 
-  * Administration 
-    * Local Administration 
-      * Library Settings Overview Tables (update) <html><span style="color:blue;font-weight:bold">jweston</span></html> 
-      * Copy Template Editor 
-      * Field Documentation 
-      * Group Penalty Thresholds 
-      * Hold Policies - some very useful info here (especially from a command-line perspective): https://evergreen-ils.org/~bshum/eg12/looking-glass/notes.html 
-      * Patrons with Negative Balances <html><span style="color:blue;font-weight:bold">Lynn Floyd</span></html>https://github.com/evergreen-library-system/Evergreen/pull/115 
-      * Search Filter Groups 
-      * Surveys <html><span style="color:blue;font-weight:bold">Lynn Floyd</span></html>[[https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/lfloyd/Docs_Surveys|Surveys]]<html><span style="color: green;font-weight: bold"> COMPLETE!</span></html> 
-      * Transit List <html><span style="color:blue;font-weight:bold">Lynn Floyd</span></html> 
-      * Hold Targeting and Hold Targeting script 
-    * Acquisitions 
-      * Patron Requests/Acquisition requests - [[https://gist.github.com/stompro/5768323e51326b8388a7|Notes Gist]] FIXME 
-      * Work Log <html><span style="color:blue;font-weight:bold">Lynn Floyd</span></html> https://bugs.launchpad.net/evergreen/+bug/1767378 <html><span style="color: green;font-weight: bold"> COMPLETE!</span></html> 
-    * Server Administration 
-      * Actor Stat Cat Sip Fields 
-      * Age Hold Protect Rules 
-      * Asset Stat Cat Sip Fields 
-      * Billing Types 
-      * Circulation Matchpoint Weights - [[https://wiki.evergreen-ils.org/doku.php?id=evergreen-admin:customization:indb-circ|use wiki page]] 
-      * Custom Org Unit Trees 
-      * Global Flags 
-      * Hold Matchpoint Weights 
-      * User Setting Types <html><span style="color:blue;font-weight:bold">[Stompro]</span></html> 
-      * Database Backup and Restore Documentation [[https://gist.github.com/stompro/b9d44ed44f57f4e1a54c|Notes/In Progress Gist]] FIXME 
-      * Loop-Based Hold Targeting & Pickup Location Weight [[https://gist.github.com/stompro/f22ebdb8521193b84408|Notes/In Progress Gist]] FIXME 
-      * Override Permissions - need docs that explain that any event can have an override permission created. 
-      * Z39.50 server setup - [[https://coffeecode.net/egdocs/1.6/draft/html/z3950.html|DBS docs on setting up Z39.50 Server]] 
-  * Circulation 
-    * Hold Design - There doesn't seem to be anything that describes how holds work in the current documentation.   
-      * A great start in the wiki by phasefx - http://wiki.evergreen-ils.org/doku.php?id=scratchpad:holds 
-      * There is a presentation by Equinox - http://evergreen-ils.org/~corinne/Hippos_Final.ppt 
-  * Patrons 
-    * Registration - Define any undefined fields and what they're used for 
- 
-==== Non-Docs Tasks ==== 
-  * Incorporate relevant docs links into Web Staff Client screens (i.e. contextual help) 
-    * Related bug: [[https://bugs.launchpad.net/evergreen/+bug/1768999|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 [[http://git.evergreen-ils.org/?p=Evergreen.git;a=commit;h=8631cf299664da0cbc12a3841bddff52740687ec|aspell wordlist]]) 
-      * [[http://georgialibraries.markmail.org/thread/l5ttj5rqmgndsrek|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 
-    * [[http://georgialibraries.markmail.org/thread/kjddts4zod2uwbe6|OPW intern ideas]] 
evergreen-docs/documentation_needs.txt · Last modified: 2022/02/10 13:34 (external edit)

© 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.