From 8c40e6316d0f9b4e5aeaec91bc05560582655767 Mon Sep 17 00:00:00 2001 From: Dan Wells Date: Wed, 4 Mar 2020 14:38:49 -0500 Subject: [PATCH] First pass at release notes for 3.5 This commit consolidates all the release notes in RELEASE_NOTES_NEXT, and does a few minor edits to formatting, layout, and text for improved flow of the content. Filling out of acknowledgements remains a TODO. Signed-off-by: Dan Wells --- docs/RELEASE_NOTES_3_5.adoc | 203 +++++++++++++++++++++ .../Administration/lp1849208_pg10_support.adoc | 4 - .../lp1849736_at_email_self_register.adoc | 16 -- .../Administration/sendemail-reactor-mime.adoc | 8 - .../Cataloging/ang-marc-editor.adoc | 7 - .../Cataloging/patron-view-tab.adoc | 9 - .../Circulation/ang-cat-holds-patron-search.adoc | 5 - .../hide-self-check-print-list-button.adoc | 9 - .../Circulation/update-hold-notifications.adoc | 7 - .../Client/ang-cat-prefs-page.adoc | 12 -- .../Client/hatch-file-writer.adoc | 11 -- .../Client/staff-cat-highlighting.adoc | 6 - .../OPAC/custom_css_in_opac.adoc | 6 - ...tron_status_always_permit_loans_SIP_option.adoc | 15 -- 14 files changed, 203 insertions(+), 115 deletions(-) create mode 100644 docs/RELEASE_NOTES_3_5.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/Administration/lp1849208_pg10_support.adoc delete mode 100755 docs/RELEASE_NOTES_NEXT/Administration/lp1849736_at_email_self_register.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/Administration/sendemail-reactor-mime.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/Cataloging/ang-marc-editor.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/Cataloging/patron-view-tab.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/Circulation/ang-cat-holds-patron-search.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/Circulation/hide-self-check-print-list-button.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/Circulation/update-hold-notifications.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/Client/ang-cat-prefs-page.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/Client/hatch-file-writer.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/Client/staff-cat-highlighting.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/OPAC/custom_css_in_opac.adoc delete mode 100644 docs/RELEASE_NOTES_NEXT/SIP/Add_patron_status_always_permit_loans_SIP_option.adoc diff --git a/docs/RELEASE_NOTES_3_5.adoc b/docs/RELEASE_NOTES_3_5.adoc new file mode 100644 index 0000000000..4871fd1bb9 --- /dev/null +++ b/docs/RELEASE_NOTES_3_5.adoc @@ -0,0 +1,203 @@ +Evergreen 3.5 Release Notes +=========================== +:toc: +:numbered: + +Upgrade notes +------------- + +New Action Trigger hook for patron registration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Use of the new Action Trigger stgu.created hook requires changes to +your action_trigger_filters.json file. See below for more details. + +New prerequisite - Email::MIME Perl module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The Email::MIME Perl module is now required, so be sure to run the +prerequisite installation procedure for your Linux distribution before +upgrading Evergreen. + + + +New Features for 3.5.0 +---------------------- + +Administration +~~~~~~~~~~~~~~ + +PostgreSQL 10 Support +^^^^^^^^^^^^^^^^^^^^^ +PostgreSQL 10 is now available for installation with Evergreen. Please +see the installation documentation for details. + +New Action Trigger hook for patron registration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Evergreen now includes a new type of Action Trigger hook: stgu.created. +This hook will trigger upon the patron registration submission form. In +addition to the new hook, an example Action Trigger definition is +provided (disabled) entitled "Patron Registered for a card +stgu.created". With clever timing and delay settings, a library can +receive a single notification containing all of the pending patron +registrations for a given time interval. No special server-side +considerations required unless you introduce a new granularity. There +is, however, a new clause introduced to the +"action_trigger_filters.json.example" file. + +If you wish to use this new hook, be sure to include this clause in your +local "action_trigger_filters.json" file: + +---- +"stgu.created" : { + "context_org": "home_ou", + "filter": { + "complete": "f" + } + } +---- + +SendEmail Reactor Updated to use Email::MIME +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The SendEmail reactor for Action/Trigger has been updated to use the +Email::MIME Perl module for proper encoding of the email message +header fields. You should notice no functional difference in the +sending of emails. + + + +Cataloging +~~~~~~~~~~ + +Enriched/Full MARC Editor Ported to Angular +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The full MARC editor is now implemented in Angular. This change impacts +both the experimental Angular catalog and the MARC edit option within +MARC Batch Import/Export (Vandelay) Queue manager. + +Patron View tab in Experimental Catalog +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The record view screen in the Experimental Catalog now has a +_Patron View_ tab. This tab displays a view of the record in +the OPAC, as a patron would see it. + +The _Patron View_ tab replaces the previous _View in Catalog_ +button. + + + +Circulation +~~~~~~~~~~~ + +Angular Staff Catalog Holds Patron Search Support +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The Angular staff catalog now supports patron searching directly from +the holds placement interace. + +Hide Print List Button On Self Check Home Page +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The _Print List_ button is no longer displayed on the main page +of the self check interface. This addresses an issue where +users were observed to either hit the _Print List_ button and +walk away or hit it *and* the _Logout_ button, causing duplicate +receipts to be printed. The _Print List_ button continues to +be displayed on the _Items Out_, _Holds_, and _Fines Details_ pages +of the self check interface. + +Update Hold Notification Information +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The public catalog and staff client now have the ability to update +existing holds if a patron or a staff member changes certain +notification preferences or contact information. Evergreen will detect +these changes and prompt the staff user or patron user and ask if they +want to update existing holds with the new contact information and/or +notification preferences. + + + +Client +~~~~~~ + +Angular Staff Catalog Preferences Page +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Adds a new "Catalog Preferences" interface, accessible directly from the +catalog. The UI houses the search preferences (default search lib, +preferred library, default search tab) and a new staff-specific +hits-per-page setting. Other preferences may be added later. + +Adds support for selecting a default search tab using the existing +'eg.search.adv_pane' setting. + +Hatch File Writer Print Option +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Adds a new stock print option in the Hatch printer configuration interface +called Hatch File Writer (translatable). When selected, any print content +that is delivered to this printer is translated into text where necessary +and written to a file in the Hatch profile directory. + +The name of the file written is based on the print context: +"receipt..txt". For example, 'receipt.label.txt'. + +Angular Staff Catalog gets Search Highlighting +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Search text highlighting is now supported on the search results and +record details pages in the Angular staff catalog for searches that +support highlighting. + + + +OPAC +~~~~ + +Custom CSS in OPAC +^^^^^^^^^^^^^^^^^^ +There is now a library setting called opac.patron.custom_css. This can +be populated with CSS that will load in the OPAC after the stylesheets +and allow for custom CSS without editing server side templates. + + + +SIP +~~~ + +Add patron_status_always_permit_loans Option to SIP Server +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Evergreen now has a new `oils_sip.xml` login attribute called +`patron_status_always_permit_loans` that specifies whether +the charge privileges denied, renewal privilges denied, and +card reported lost flags in the patron status block should be +coerced to permissive values regardless of the actual state +of the patron record. Turning this on works around an issue +where a 2019-12 change by the Hoopla SIP2 client takes those flag +fields into account, but some libraries may not wish those +to block a patron's access to online resources that use +SIP2 to authenticate. This setting can also be set as +an `implementation_config` option; note that if it is set to +'true' or 'false' as a login attribute, the login attribute will +override whatever is set in the `implementation_config`. + + + + +Acknowledgments +--------------- +The Evergreen project would like to acknowledge the following +organizations that commissioned developments in this release of +Evergreen: + +TODO + +We would also like to thank the following individuals who contributed +code, translations, documentations patches and tests to this release of +Evergreen: + +TODO + + +We also thank the following organizations whose employees contributed +patches: + +TODO + +We regret any omissions. If a contributor has been inadvertently +missed, please open a bug at http://bugs.launchpad.net/evergreen/ +with a correction. + diff --git a/docs/RELEASE_NOTES_NEXT/Administration/lp1849208_pg10_support.adoc b/docs/RELEASE_NOTES_NEXT/Administration/lp1849208_pg10_support.adoc deleted file mode 100644 index bc3d43d9d4..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Administration/lp1849208_pg10_support.adoc +++ /dev/null @@ -1,4 +0,0 @@ -PostgreSQL 10 Support -^^^^^^^^^^^^^^^^^^^^^ -PostgreSQL 10 is now available for installation with Evergreen. Please -see the installation documentation for details. diff --git a/docs/RELEASE_NOTES_NEXT/Administration/lp1849736_at_email_self_register.adoc b/docs/RELEASE_NOTES_NEXT/Administration/lp1849736_at_email_self_register.adoc deleted file mode 100755 index 480aa0c011..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Administration/lp1849736_at_email_self_register.adoc +++ /dev/null @@ -1,16 +0,0 @@ -== New Action Trigger hook for patron registration == - -Evergreen now includes a new type of Action Trigger hook: stgu.created. This hook will trigger upon the patron registration submission form. In addition to the new hook, an example Action Trigger definition is provided (disabled) entitled "Patron Registered for a card stgu.created". With clever timing and delay settings, a library can receive a single notification containing all of the pending patron registrations for a given time interval. No special server-side considerations required unless you introduce a new granularity. There is, however, a new clause introduced to the "action_trigger_filters.json.example" file. - -=== Upgrade instructions === - -Be sure and include this clause in your "action_trigger_filters.json.example" file - ----- -"stgu.created" : { - "context_org": "home_ou", - "filter": { - "complete": "f" - } - } ----- \ No newline at end of file diff --git a/docs/RELEASE_NOTES_NEXT/Administration/sendemail-reactor-mime.adoc b/docs/RELEASE_NOTES_NEXT/Administration/sendemail-reactor-mime.adoc deleted file mode 100644 index b6cb8d5eb5..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Administration/sendemail-reactor-mime.adoc +++ /dev/null @@ -1,8 +0,0 @@ -SendEmail Reactor Updated to use Email::MIME -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The SendEmail reactor for Action/Trigger has been updated to use the -Email::MIME Perl module for proper encoding of the email message -header fields. You should notice no functional difference in the -sending of emails. This change does add a new prerequisite package, -so be sure to run the prerequisite installation procedure for your -Linux distribution before upgrading Evergreen. diff --git a/docs/RELEASE_NOTES_NEXT/Cataloging/ang-marc-editor.adoc b/docs/RELEASE_NOTES_NEXT/Cataloging/ang-marc-editor.adoc deleted file mode 100644 index bbccf51209..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Cataloging/ang-marc-editor.adoc +++ /dev/null @@ -1,7 +0,0 @@ -Enriched/Full MARC Editor Ported to Angular -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The full MARC editor is now implemented in Angular. This change impacts -both the experimental Angular catalog and the MARC edit option within -MARC Batch Import/Export (Vandelay) Queue manager. - diff --git a/docs/RELEASE_NOTES_NEXT/Cataloging/patron-view-tab.adoc b/docs/RELEASE_NOTES_NEXT/Cataloging/patron-view-tab.adoc deleted file mode 100644 index 84371f57fa..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Cataloging/patron-view-tab.adoc +++ /dev/null @@ -1,9 +0,0 @@ -Patron View tab in Experimental Catalog -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The record view screen in the Experimental Catalog now has a -_Patron View_ tab. This tab displays a view of the record in -the OPAC, as a patron would see it. - -The _Patron View_ tab replaces the previous _View in Catalog_ -button. - diff --git a/docs/RELEASE_NOTES_NEXT/Circulation/ang-cat-holds-patron-search.adoc b/docs/RELEASE_NOTES_NEXT/Circulation/ang-cat-holds-patron-search.adoc deleted file mode 100644 index 6e21760ea2..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Circulation/ang-cat-holds-patron-search.adoc +++ /dev/null @@ -1,5 +0,0 @@ -Angular Staff Catalog Holds Patron Search Support -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The Angular staff catalog now supports patron searching directly from -the holds placement interace. - diff --git a/docs/RELEASE_NOTES_NEXT/Circulation/hide-self-check-print-list-button.adoc b/docs/RELEASE_NOTES_NEXT/Circulation/hide-self-check-print-list-button.adoc deleted file mode 100644 index df39fa741d..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Circulation/hide-self-check-print-list-button.adoc +++ /dev/null @@ -1,9 +0,0 @@ -Hide Print List Button On Self Check Home Page -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The _Print List_ button is no longer displayed on the main page -of the self check interface. This addresses an issue where -users were observed to either hit the _Print List_ button and -walk away or hit it *and* the _Logout_ button, causing duplicate -receipts to be printed. The _Print List_ button continues to -be displayed on the _Items Out_, _Holds_, and _Fines Details_ pages -of the self check interface. diff --git a/docs/RELEASE_NOTES_NEXT/Circulation/update-hold-notifications.adoc b/docs/RELEASE_NOTES_NEXT/Circulation/update-hold-notifications.adoc deleted file mode 100644 index c30ab1d73f..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Circulation/update-hold-notifications.adoc +++ /dev/null @@ -1,7 +0,0 @@ -Update Hold Notification Information -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The public catalog and staff client now have the ability to update existing -holds if a patron or a staff member changes certain notification preferences or -contact information. Evergreen will detect these changes and prompt the staff -user or patron user and ask if they want to update existing holds with the new -contact information and/or notification preferences. diff --git a/docs/RELEASE_NOTES_NEXT/Client/ang-cat-prefs-page.adoc b/docs/RELEASE_NOTES_NEXT/Client/ang-cat-prefs-page.adoc deleted file mode 100644 index ff23e5baa2..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Client/ang-cat-prefs-page.adoc +++ /dev/null @@ -1,12 +0,0 @@ -Angular Staff Catalog Preferences Page -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Adds a new "Catalog Preferences" interface, accessible directly from the -catalog. The UI houses the search preferences (default search lib, -preferred library, default search tab) and a new staff-specific -hits-per-page setting. Other preferences may be added later. - -Adds support for selecting a default search tab using the existing -'eg.search.adv_pane' setting. - - diff --git a/docs/RELEASE_NOTES_NEXT/Client/hatch-file-writer.adoc b/docs/RELEASE_NOTES_NEXT/Client/hatch-file-writer.adoc deleted file mode 100644 index 4fb2ec88e6..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Client/hatch-file-writer.adoc +++ /dev/null @@ -1,11 +0,0 @@ -Hatch File Writer Print Option -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Adds a new stock print option in the Hatch printer configuration interface -called Hatch File Writer (translatable). When selected, any print content -that is delivered to this printer is translated into text where necessary -and written to a file in the Hatch profile directory. - -The name of the file written is based on the print context: -"receipt..txt". For example, 'receipt.label.txt'. - diff --git a/docs/RELEASE_NOTES_NEXT/Client/staff-cat-highlighting.adoc b/docs/RELEASE_NOTES_NEXT/Client/staff-cat-highlighting.adoc deleted file mode 100644 index 2757876123..0000000000 --- a/docs/RELEASE_NOTES_NEXT/Client/staff-cat-highlighting.adoc +++ /dev/null @@ -1,6 +0,0 @@ -Angular Staff Catalog gets Search Highlighting -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Search text highlighting is now supported on the search results and -record details pages in the Angular staff catalog for searches that -support highlighting. - diff --git a/docs/RELEASE_NOTES_NEXT/OPAC/custom_css_in_opac.adoc b/docs/RELEASE_NOTES_NEXT/OPAC/custom_css_in_opac.adoc deleted file mode 100644 index ab0f2abb1e..0000000000 --- a/docs/RELEASE_NOTES_NEXT/OPAC/custom_css_in_opac.adoc +++ /dev/null @@ -1,6 +0,0 @@ -Custom CSS in OPAC -^^^^^^^^^^^^^^^^^^ - -There is now a library setting called opac.patron.custom_css. This can be populated with CSS that will load in the OPAC after the stylesheets and allow for custom CSS without editing server side templates. - - diff --git a/docs/RELEASE_NOTES_NEXT/SIP/Add_patron_status_always_permit_loans_SIP_option.adoc b/docs/RELEASE_NOTES_NEXT/SIP/Add_patron_status_always_permit_loans_SIP_option.adoc deleted file mode 100644 index 45c2d733ef..0000000000 --- a/docs/RELEASE_NOTES_NEXT/SIP/Add_patron_status_always_permit_loans_SIP_option.adoc +++ /dev/null @@ -1,15 +0,0 @@ -Add patron_status_always_permit_loans Option to SIP Server -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Evergreen now has a new `oils_sip.xml` login attribute called -`patron_status_always_permit_loans` that specifies whether -the charge privileges denied, renewal privilges denied, and -card reported lost flags in the patron status block should be -coerced to permissive values regardless of the actual state -of the patron record. Turning this on works around an issue -where a 2019-12 change by the Hoopla SIP2 client takes those flag -fields into account, but some libraries may not wish those -to block a patron's access to online resources that use -SIP2 to authenticate. This setting can also be set as -an `implementation_config` option; note that if it is set to -'true' or 'false' as a login attribute, the login attribute will -override whatever is set in the `implementation_config`. -- 2.11.0