From 7ab4ea645000249d056e8134b438fb39d2193075 Mon Sep 17 00:00:00 2001 From: Ben Shum Date: Tue, 19 Mar 2013 22:49:49 -0400 Subject: [PATCH] Initial cut of 2.4 release notes. Basically, the contents of RELEASE_NOTES_NEXT organized into RELEASE_NOTES_2_4.txt and removed from RELEASE_NOTE_NEXT. Move copy of alternate_graphic_fields to TechRef. Signed-off-by: Ben Shum Signed-off-by: Kathy Lussier Signed-off-by: Mike Rylander --- docs/RELEASE_NOTES_2_4.txt | 229 ++++++++++++++++++ docs/RELEASE_NOTES_NEXT/about_about.txt | 13 - .../acq_marc_upload_defaults.txt | 7 - .../calculated-proximity-adjustments.txt | 10 - .../circulation_patron_expiry_warning.txt | 9 - .../clickable_patron_indicators.txt | 6 - .../custom-best-hold-selection.txt | 16 -- docs/RELEASE_NOTES_NEXT/hold_patron_name.txt | 7 - .../loading_sample_data.txt | 24 -- .../queryparser_changes.txt | 25 -- docs/RELEASE_NOTES_NEXT/toolbar_perms.txt | 12 - docs/RELEASE_NOTES_NEXT/tpac-ou-hiding.txt | 20 -- .../tpac_google_books_preview.txt | 12 - .../vandelay_default_match_set.txt | 11 - .../alternate_graphic_fields.txt | 0 15 files changed, 229 insertions(+), 172 deletions(-) create mode 100644 docs/RELEASE_NOTES_2_4.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/about_about.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/acq_marc_upload_defaults.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/calculated-proximity-adjustments.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/circulation_patron_expiry_warning.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/clickable_patron_indicators.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/custom-best-hold-selection.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/hold_patron_name.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/loading_sample_data.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/queryparser_changes.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/toolbar_perms.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/tpac-ou-hiding.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/tpac_google_books_preview.txt delete mode 100644 docs/RELEASE_NOTES_NEXT/vandelay_default_match_set.txt rename docs/{RELEASE_NOTES_NEXT => TechRef}/alternate_graphic_fields.txt (100%) diff --git a/docs/RELEASE_NOTES_2_4.txt b/docs/RELEASE_NOTES_2_4.txt new file mode 100644 index 0000000000..8d725372bf --- /dev/null +++ b/docs/RELEASE_NOTES_2_4.txt @@ -0,0 +1,229 @@ +Evergreen 2.4 Alpha1 Release Notes +================================== +:toc: +:numbered: + +Upgrade notes +------------- + +Custom toolbar permissions +~~~~~~~~~~~~~~~~~~~~~~~~~~ +With the addition of more granular permissions for configuring a custom +toolbars, the ADMIN_TOOLBAR permission alone will not allow users to +configure a custom toolbar. This permission must now be used in conjunction +with one or more of the following permissions: + +* ADMIN_TOOLBAR_FOR_ORG +* ADMIN_TOOLBAR_FOR_USER +* ADMIN_TOOLBAR_FOR_WORKSTATION + +New features +------------ + +Acquisitions +~~~~~~~~~~~~ + +Acquisitions MARC Upload Form Persistence +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Adds a two-layer persistence mechanism for the acquisitions MARC file upload +interface. A set of org unit settings now exist for managing default values +for the interface. Additionally, for each field where no org unit setting +value is configured, the last-used value will be persisted locally and re- +used with subsequent loads of the interface. + +OPAC +~~~~ + +Display alternate graphic (880) fields +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +By default, Evergreen displays alternate graphic fields, if any, for +contributors (1xx / 7xx), titles (245), edition statements (250), imprints +(260), notes (5xx), subjects (6xx), and series (4xx / 8xx) in search results and record details +per the Library of Congress MARC21 specifications: + +* http://www.loc.gov/marc/bibliographic/bd880.html +* http://www.loc.gov/marc/bibliographic/ecbdcntf.html +* http://www.loc.gov/marc/bibliographic/ecbdmulti.html (Model A) + +Default display ++++++++++++++++ +In general, alternate graphic fields display below the corresponding +primary field. One exception is the attribution summary on the record details +page, in which the alternate graphic field contents display between the +primary field content and the attribution statement. To support CSS +customizations, HTML elements for the graphic fields have the class attribute +value `graphic880`. + +Search Changes +^^^^^^^^^^^^^^ +A number of changes have been made to search to allow more control and improve +performance. These changes and their associated configurations are global to +the entire system and can not be configured on a per-library basis. + +Amongst other things the new search code fixes: + +* Inability to use statuses and locations as part of a larger query +* Invalid queries being generated from advanced searches +* Some timeouts from backend code taking too long to preform a search +* Some filters being one-use only +* Negations not working properly where multiple indexes are involved + +Improvements include: + +* Exact matches on input should be more likely to float to the top of results +* Non-English stemming can be used, alongside or instead of English stemming +* Entered search terms can be found across multiple indexes + +Default configuration is geared towards English but is easily changed. In a +production environment changes will likely require re-indexing, however. + +The upgrade script could be pre-tweaked to install desired configuration before +it builds and/or re-builds many of the indexes. + +TPAC Google Books preview +^^^^^^^^^^^^^^^^^^^^^^^^^ +Setting `ctx.google_books_preview` to `1` in the TPAC `config.tt2` +configuration file will cause the TPAC to check to see, as part of the record +details view, if Google Books has an online preview available. If it does, +then a preview button will be displayed in the book cover image location. +If the user then clicks the preview button, the preview will load below the +title of the book in the record details page. + +By default, this functionality is disabled to protect the privacy of users +who might not want to share their browsing behaviour with Google. + +TPAC Org Unit Hiding +^^^^^^^^^^^^^^^^^^^^ +Adds support for the opac.org_unit_hiding.depth org unit setting to +TPAC, which makes out-of-scope org units disappear (except when +explicitly requested). + +Org unit hiding is based on the physical_loc (Physical Location) param / +cookie, which is the closest analog to 'ol' (original location), from +which it was based in the JSPAC. + +UI Changes +++++++++++ + + * All search org unit selectors + * Holds pickup lib selector + * Copy summary in search results page + * Copy list in search results page + * Copy summary in record detail page (which controls the copy grid). + * Hold summary in record detail page + +Cataloging +~~~~~~~~~~ + +Vandelay Default Match Set +^^^^^^^^^^^^^^^^^^^^^^^^^^ +A new org unit setting to specify a default Record Match Set when +importing MARC records through the MARC Batch Import/Export interface. It does +not affect the default match set selected in acquisitions. If this +is set, it will not be possible to leave the Record Match Set field blank; +it may be necessary to define a default match set that replicates the current +default behavior. + +A new "Vandelay" org unit settings group is also created. + +Circulation +~~~~~~~~~~~ + +Clickable Patron Indicators +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +When retrieving a patron record, staff can now click on the indicators listed +beneath the patron's name and launch the related tabs. + +For example, clicking on (See Notes) will open the associated patron's notes. + +"Warn patrons when their account is about to expire" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +To give staff the ability to warn patrons when their account is about to +expire, the staff client can display an alert message on the patron information +window. A new library setting, `Warn patrons when their account is about to +expire` in the *Circulation* section of the *Library Settings Editor*, +determines how many days in advance of a patron's account expiry date the alert +should be displayed. By default, warnings about upcoming patron account expiry +dates are not displayed. + +Show Hold Patron Name in TPAC +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +When looking up patron information for hold placement via the staff client in +TPac the hold patron name is now shown next to the entered barcode. In the event +that the barcode is not found a notice is displayed and the submit button is +disabled until a valid barcode is entered or the staff member is switched to. + +Administration +~~~~~~~~~~~~~~ + +Calculated Proximity Adjustments +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Allows customization to the way that Evergreen measures the distance between +org units for the purposes of 1) determining what copy at what org unit is best +suited for targeting a title-level hold, and 2) determining what hold is best +suited for fulfillment by a copy-in-hand at capture (checkin) time. The +customization is based on a table 'actor.org_unit_proximity_adjustment', with +certain matching criteria that the system compares to properties of the holds +and copies in question. + +Custom best-hold selection sort order +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The ranking algorithm that chooses the best hold to target a copy in +hand at a capture time used to be fairly simple. It had two modes, FIFO +and not-FIFO, and that was it. + +This change allows full configuration of that algorithm. In other +words, when the system captures a copy and sets out to evaluate what +hold, if any, that copy might best fulfull, site staff of sufficient +permission level are now empowered to choose exactly which comparisons +the systems makes in what order. This gives said staff much greater +flexibililty than they have today over holds policy. + +For more information, see the included tech spec documents. + +Staff Client +~~~~~~~~~~~~ + +add "about:about" to developer menu in staff client +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +about:about gives access to various XULRunner diagnostic tools. +Useful ones include: + +about:buildconfig:: + Get information about how the staff client is built. +about:config:: + Tweak XULRunner settings. +about:memory:: + Get detailed information about the memory usage of the staff + client. + +Miscellaneous +------------- + +Loading Sample Data +~~~~~~~~~~~~~~~~~~~ +One common need for people evaluating Evergreen, as well as for developers, +writers, and testers, is a set of sample data that can be easily loaded into +the Evergreen database and provide a consistent set of results for testing +and training purposes. + +This release features sets of sample data consisting of: + +* 100 bibliographic records retrievable via a "concerto" keyword search +* 100 French bibliographic records +* Associated call numbers, copies, parts, and conjoined items +* Patron accounts, including some recently expired patrons +* Circulation transactions, including some holds and some overdue items + +To load the sample data into a freshly installed Evergreen database, you can +pass the following arguments to the `eg_db_config` script (either when you are +creating the initial database schema, or as a separate call after creating the +database schema): + +* `--load-all-sample`: Loads all sample data, including bibliographic records, + call numbers, copies, users, and transactions. +* `--load-concerto-sample`: Loads a subset of sample data that includes just + 100 bibliographic records, and associated call numbers and copies. + diff --git a/docs/RELEASE_NOTES_NEXT/about_about.txt b/docs/RELEASE_NOTES_NEXT/about_about.txt deleted file mode 100644 index 32b716dae9..0000000000 --- a/docs/RELEASE_NOTES_NEXT/about_about.txt +++ /dev/null @@ -1,13 +0,0 @@ -New feature: add "about:about" to developer menu in staff client -================================================================= - -about:about gives access to various XULRunner diagnostic tools. -Useful ones include: - -about:buildconfig:: - Get information about how the staff client is built. -about:config:: - Tweak XULRunner settings. -about:memory:: - Get detailed information about the memory usage of the staff - client. diff --git a/docs/RELEASE_NOTES_NEXT/acq_marc_upload_defaults.txt b/docs/RELEASE_NOTES_NEXT/acq_marc_upload_defaults.txt deleted file mode 100644 index e0e709fd6a..0000000000 --- a/docs/RELEASE_NOTES_NEXT/acq_marc_upload_defaults.txt +++ /dev/null @@ -1,7 +0,0 @@ -Acquisitions MARC Upload Form Persistence -========================================= -Adds a two-layer persistence mechanism for the acquisitions MARC file upload -interface. A set of org unit settings now exist for managing default values -for the interface. Additionally, for each field where no org unit setting -value is configured, the last-used value will be persisted locally and re- -used with subsequent loads of the interface. diff --git a/docs/RELEASE_NOTES_NEXT/calculated-proximity-adjustments.txt b/docs/RELEASE_NOTES_NEXT/calculated-proximity-adjustments.txt deleted file mode 100644 index 61a81a709b..0000000000 --- a/docs/RELEASE_NOTES_NEXT/calculated-proximity-adjustments.txt +++ /dev/null @@ -1,10 +0,0 @@ -Calculated Proximity Adjustments -================================ - -Allows customization to the way that Evergreen measures the distance between -org units for the purposes of 1) determining what copy at what org unit is best -suited for targeting a title-level hold, and 2) determining what hold is best -suited for fulfillment by a copy-in-hand at capture (checkin) time. The -customization is based on a table 'actor.org_unit_proximity_adjustment', with -certain matching criteria that the system compares to properties of the holds -and copies in question. diff --git a/docs/RELEASE_NOTES_NEXT/circulation_patron_expiry_warning.txt b/docs/RELEASE_NOTES_NEXT/circulation_patron_expiry_warning.txt deleted file mode 100644 index eebe3eb869..0000000000 --- a/docs/RELEASE_NOTES_NEXT/circulation_patron_expiry_warning.txt +++ /dev/null @@ -1,9 +0,0 @@ -New feature: "Warn patrons when their account is about to expire" -================================================================= -To give staff the ability to warn patrons when their account is about to -expire, the staff client can display an alert message on the patron information -window. A new library setting, `Warn patrons when their account is about to -expire` in the *Circulation* section of the *Library Settings Editor*, -determines how many days in advance of a patron's account expiry date the alert -should be displayed. By default, warnings about upcoming patron account expiry -dates are not displayed. diff --git a/docs/RELEASE_NOTES_NEXT/clickable_patron_indicators.txt b/docs/RELEASE_NOTES_NEXT/clickable_patron_indicators.txt deleted file mode 100644 index 4d0baeec0b..0000000000 --- a/docs/RELEASE_NOTES_NEXT/clickable_patron_indicators.txt +++ /dev/null @@ -1,6 +0,0 @@ -New feature: Clickable Patron Indicators -======================================== -When retrieving a patron record, staff can now click on the indicators listed -beneath the patron's name and launch the related tabs. - -For example, clicking on (See Notes) will open the associated patron's notes. diff --git a/docs/RELEASE_NOTES_NEXT/custom-best-hold-selection.txt b/docs/RELEASE_NOTES_NEXT/custom-best-hold-selection.txt deleted file mode 100644 index 4fb440a9f8..0000000000 --- a/docs/RELEASE_NOTES_NEXT/custom-best-hold-selection.txt +++ /dev/null @@ -1,16 +0,0 @@ -Custom best-hold selection sort order -===================================== - -The ranking algorithm that chooses the best hold to target a copy in -hand at a capture time used to be fairly simple. It had two modes, FIFO -and not-FIFO, and that was it. - -This change allows full configuration of that algorithm. In other -words, when the system captures a copy and sets out to evaluate what -hold, if any, that copy might best fulfull, site staff of sufficient -permission level are now empowered to choose exactly which comparisons -the systems makes in what order. This gives said staff much greater -flexibililty than they have today over holds policy. - -For more information, see the included tech spec documents. - diff --git a/docs/RELEASE_NOTES_NEXT/hold_patron_name.txt b/docs/RELEASE_NOTES_NEXT/hold_patron_name.txt deleted file mode 100644 index 30891c7b52..0000000000 --- a/docs/RELEASE_NOTES_NEXT/hold_patron_name.txt +++ /dev/null @@ -1,7 +0,0 @@ -Show Hold Patron Name in TPac -============================= - -When looking up patron information for hold placement via the staff client in -TPac the hold patron name is now shown next to the entered barcode. In the event -that the barcode is not found a notice is displayed and the submit button is -disabled until a valid barcode is entered or the staff member is switched to. diff --git a/docs/RELEASE_NOTES_NEXT/loading_sample_data.txt b/docs/RELEASE_NOTES_NEXT/loading_sample_data.txt deleted file mode 100644 index 063eb1e2f6..0000000000 --- a/docs/RELEASE_NOTES_NEXT/loading_sample_data.txt +++ /dev/null @@ -1,24 +0,0 @@ -New feature: loading sample data -================================ -One common need for people evaluating Evergreen, as well as for developers, -writers, and testers, is a set of sample data that can be easily loaded into -the Evergreen database and provide a consistent set of results for testing -and training purposes. - -This release features sets of sample data consisting of: - -* 100 bibliographic records retrievable via a "concerto" keyword search -* 100 French bibliographic records -* Associated call numbers, copies, parts, and conjoined items -* Patron accounts, including some recently expired patrons -* Circulation transactions, including some holds and some overdue items - -To load the sample data into a freshly installed Evergreen database, you can -pass the following arguments to the `eg_db_config` script (either when you are -creating the initial database schema, or as a separate call after creating the -database schema): - -* `--load-all-sample`: Loads all sample data, including bibliographic records, - call numbers, copies, users, and transactions. -* `--load-concerto-sample`: Loads a subset of sample data that includes just - 100 bibliographic records, and associated call numbers and copies. diff --git a/docs/RELEASE_NOTES_NEXT/queryparser_changes.txt b/docs/RELEASE_NOTES_NEXT/queryparser_changes.txt deleted file mode 100644 index d25609658b..0000000000 --- a/docs/RELEASE_NOTES_NEXT/queryparser_changes.txt +++ /dev/null @@ -1,25 +0,0 @@ -Search Changes -============== -A number of changes have been made to search to allow more control and improve -performance. These changes and their associated configurations are global to -the entire system and can not be configured on a per-library basis. - -Amongst other things the new search code fixes: - -* Inability to use statuses and locations as part of a larger query -* Invalid queries being generated from advanced searches -* Some timeouts from backend code taking too long to preform a search -* Some filters being one-use only -* Negations not working properly where multiple indexes are involved - -Improvements include: - -* Exact matches on input should be more likely to float to the top of results -* Non-English stemming can be used, alongside or instead of English stemming -* Entered search terms can be found across multiple indexes - -Default configuration is geared towards English but is easily changed. In a -production environment changes will likely require re-indexing, however. - -The upgrade script could be pre-tweaked to install desired configuration before -it builds and/or re-builds many of the indexes. diff --git a/docs/RELEASE_NOTES_NEXT/toolbar_perms.txt b/docs/RELEASE_NOTES_NEXT/toolbar_perms.txt deleted file mode 100644 index 111ab52a36..0000000000 --- a/docs/RELEASE_NOTES_NEXT/toolbar_perms.txt +++ /dev/null @@ -1,12 +0,0 @@ -Upgrade Notes -------------- -Custom toolbar permissions -~~~~~~~~~~~~~~~~~~~~~~~~~~ -With the addition of more granular permissions for configuring a custom -toolbars, the ADMIN_TOOLBAR permission alone will not allow users to -configure a custom toolbar. This permission must now be used in conjunction -with one or more of the following permissions: - -* ADMIN_TOOLBAR_FOR_ORG -* ADMIN_TOOLBAR_FOR_USER -* ADMIN_TOOLBAR_FOR_WORKSTATION diff --git a/docs/RELEASE_NOTES_NEXT/tpac-ou-hiding.txt b/docs/RELEASE_NOTES_NEXT/tpac-ou-hiding.txt deleted file mode 100644 index adebd77129..0000000000 --- a/docs/RELEASE_NOTES_NEXT/tpac-ou-hiding.txt +++ /dev/null @@ -1,20 +0,0 @@ -TPAC Org Unit Hiding -==================== - -Adds support for the opac.org_unit_hiding.depth org unit setting to -TPAC, which makes out-of-scope org units disappear (except when -explicitly requested). - -Org unit hiding is based on the physical_loc (Physical Location) param / -cookie, which is the closest analog to 'ol' (original location), from -which it was based in the JSPAC. - -UI Changes ----------- - - * All search org unit selectors - * Holds pickup lib selector - * Copy summary in search results page - * Copy list in search results page - * Copy summary in record detail page (which controls the copy grid). - * Hold summary in record detail page diff --git a/docs/RELEASE_NOTES_NEXT/tpac_google_books_preview.txt b/docs/RELEASE_NOTES_NEXT/tpac_google_books_preview.txt deleted file mode 100644 index c56582572c..0000000000 --- a/docs/RELEASE_NOTES_NEXT/tpac_google_books_preview.txt +++ /dev/null @@ -1,12 +0,0 @@ -TPAC: Google Books preview -========================== - -Setting `ctx.google_books_preview` to `1` in the TPAC `config.tt2` -configuration file will cause the TPAC to check to see, as part of the record -details view, if Google Books has an online preview available. If it does, -then a preview button will be displayed in the book cover image location. -If the user then clicks the preview button, the preview will load below the -title of the book in the record details page. - -By default, this functionality is disabled to protect the privacy of users -who might not want to share their browsing behaviour with Google. diff --git a/docs/RELEASE_NOTES_NEXT/vandelay_default_match_set.txt b/docs/RELEASE_NOTES_NEXT/vandelay_default_match_set.txt deleted file mode 100644 index 836b2e5f9d..0000000000 --- a/docs/RELEASE_NOTES_NEXT/vandelay_default_match_set.txt +++ /dev/null @@ -1,11 +0,0 @@ -Vandelay Default Match Set -========================== -A new org unit setting to specify a default Record Match Set when -importing MARC records through the MARC Batch Import/Export interface. It does -not affect the default match set selected in acquisitions. If this -is set, it will not be possible to leave the Record Match Set field blank; -it may be necessary to define a default match set that replicates the current -default behavior. - -A new "Vandelay" org unit settings group is also created. - diff --git a/docs/RELEASE_NOTES_NEXT/alternate_graphic_fields.txt b/docs/TechRef/alternate_graphic_fields.txt similarity index 100% rename from docs/RELEASE_NOTES_NEXT/alternate_graphic_fields.txt rename to docs/TechRef/alternate_graphic_fields.txt -- 2.43.2