About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


changelog

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
changelog [2019/06/13 09:47]
demiankatz [Release 6.0 - coming 7/15/2019]
changelog [2019/09/16 09:08] (current)
demiankatz [Release 6.0.1 - coming September 16, 2019]
Line 3: Line 3:
 // When adding a new release, see the [[changelog:​release_checklist|release checklist]]. // // When adding a new release, see the [[changelog:​release_checklist|release checklist]]. //
  
-===== Release 6.0 - coming ​7/15/2019 =====+===== Release 6.1 - currently under development ===== 
 + 
 +New features: 
 + 
 +  * [[configuration:​combining_search_types#​multi-column_search|Combined Multi-Column Search]] now optionally supports search types (author, title, subject, etc.). 
 +  * Users can now change their email addresses in their accounts (though this feature is disabled by default -- see the config.ini change_email setting and [[https://​github.com/​vufind-org/​vufind/​pull/​1401|pull request #1401]] for details). 
 +  * Added "​Email"​ authentication method to allow login by receiving a link in an email (see [[https://​github.com/​vufind-org/​vufind/​pull/​1409|pull request #1409]]). 
 +  * Added "​PasswordAccess"​ authentication method to allow login using a single credential rather than a username/​password combination (see [[https://​github.com/​vufind-org/​vufind/​pull/​1394|pull request #1394]]). 
 +  * Added "​RecommendLinks"​ recommendation module, offering a simple mechanism for displaying a static link list. 
 +  * It is now possible to limit site permissions on a global or controller-specific basis through configuration files, making it easier to manage protected content. See [[https://​github.com/​vufind-org/​vufind/​pull/​1395|pull request #1395]] for details. 
 +  * Improved support for running VuFind behind a reverse proxy (such as Apache'​s mod_proxy); see [[https://​github.com/​vufind-org/​vufind/​pull/​1429|pull request #1429]] for details. 
 +  * Hierarchical [[configuration:​facets|facets]] sort options can now be configured independently for search results, home page listings and advanced search options; see [[https://​github.com/​vufind-org/​vufind/​pull/​1389|pull request #1389]]. 
 +  * Various Alma ILS driver improvements (including the ability to use Alma as an [[configuration:​openurls|OpenURL]] resolver). 
 +  * ILS drivers can now differentiate between electronic and physical holdings (see the [[development:​plugins:​ils_drivers#​getholding|getHolding]] driver method documentation for details). This is currently supported by the Alma driver. 
 +  * The Solr search configuration in [[configuration:​search_customization|searchspecs.yaml]] now supports munge rules for Dismax queries (see [[https://​github.com/​vufind-org/​vufind/​pull/​1419|pull request #1419]]). 
 +  * Upgraded to [[indexing:​solrmarc|SolrMarc]] 3.3, fixing some bugs and adding some new syntax features. 
 + 
 +Possible backward compatibility breaks: 
 + 
 +  * :!: Be sure to run a database upgrade to reflect table changes (see also the [[development:​architecture:​database_schema#​release_61|database changelog]]). 
 +  * :!: The new email login capability adds some new features to the authentication logic along with some minor refactoring;​ if you have custom authentication code, you should review [[https://​github.com/​vufind-org/​vufind/​pull/​1409|pull request #1409]] to be sure you are not impacted by it. 
 +  * The title_sort field MARC indexing rule has been made more explicit, instead of using a custom method. In the unlikely event that you have customized the getSortableTitle method in SolrMarc, you may need to adjust your settings. See [[https://​github.com/​vufind-org/​vufind/​pull/​1393|pull request #1393]]. 
 +  * The default controller permission is now "​null"​ rather than "​false"​ -- this is functionally identical, but it is a change needed to support the new configuration options in [[https://​github.com/​vufind-org/​vufind/​pull/​1395|pull request #1395]]. In the unlikely situation that you have customized a controller with an accessPermission property of false, you will be unable to override it with the new configuration settings unless you change the value to null first. 
 +  * Also related to [[https://​github.com/​vufind-org/​vufind/​pull/​1395|pull request #1395]]: if you have extended a controller simply to change its accessPermission value, you should now be able to use the new permissionBehavior.ini controllerAccess setting instead to reduce the amount of custom code in your instance. 
 +  * The mechanism for detecting when VuFind is in lightbox mode has been unified; this should not impact downstream code, but if you encounter lightbox problems, see [[https://​github.com/​vufind-org/​vufind/​pull/​1405|pull request #1405]]. 
 +  * The HierarchicalFacetHelper::​sortFacetList method'​s signature has changed slightly, but in a backward-compatible way. In the very unlikely event that you have extended this service, you may need to make adjustments. See [[https://​github.com/​vufind-org/​vufind/​pull/​1389|pull request #1389]]. 
 +===== Release 6.0.1 - 9/16/2019 ===== 
 + 
 +  * Minor bug fix release. 
 +  * Includes some minor security improvements. 
 + 
 +===== Release 6.0 - 7/15/2019 =====
  
 New features: New features:
Line 17: Line 48:
   * New settings have been added to searchbox.ini to support optgroup grouping in the [[/​configuration:​combining_search_types#​combined_search_handler_drop-downs|combined search handler]] drop down menu.   * New settings have been added to searchbox.ini to support optgroup grouping in the [[/​configuration:​combining_search_types#​combined_search_handler_drop-downs|combined search handler]] drop down menu.
   * Added a new "​ComponentParts"​ tab to the record view (disabled by default), which can be enabled in combination with [[indexing:​hierarchies_and_collections#​simple_links_between_containers_and_child_records|simple container linking]] to display whole/part relationships in more detail. See [[https://​github.com/​vufind-org/​vufind/​pull/​1339|pull request #1339]].   * Added a new "​ComponentParts"​ tab to the record view (disabled by default), which can be enabled in combination with [[indexing:​hierarchies_and_collections#​simple_links_between_containers_and_child_records|simple container linking]] to display whole/part relationships in more detail. See [[https://​github.com/​vufind-org/​vufind/​pull/​1339|pull request #1339]].
 +  * Added a new recommendation module for linking to third-party searches (for example, to direct to an external site when an internal search yields no results). See [[https://​github.com/​vufind-org/​vufind/​pull/​1385|pull request #1385]] for details.
   * An example of batch-loading XML records from OJS is now included (see [[https://​github.com/​vufind-org/​vufind/​pull/​1352|pull request #1352]]).   * An example of batch-loading XML records from OJS is now included (see [[https://​github.com/​vufind-org/​vufind/​pull/​1352|pull request #1352]]).
-  * Significant improvements (and new configuration settings) for the SierraRest ILS driver.+  * Significant improvements (and new configuration settings) for the Alma and SierraRest ILS drivers.
   * Addition of simple "​lint_marc"​ [[administration:​command_line_utilities|command line utility]] for detecting errors in MARC files.   * Addition of simple "​lint_marc"​ [[administration:​command_line_utilities|command line utility]] for detecting errors in MARC files.
 +  * The ability for the user to set a preferred home library can now be disabled through the set_home_library setting in config.ini (see [[https://​github.com/​vufind-org/​vufind/​pull/​1347|pull request #1347]]).
  
 Possible backward compatibility breaks: Possible backward compatibility breaks:
  
 +  * :!: VuFind now requires PHP 7.1 or newer; make sure your server can support this before upgrading!
   * :!: The Solr schema has changed, so records must be reindexed after an upgrade. See the [[development:​architecture:​solr_index_schema#​changelog|index schema changelog]] for more details.   * :!: The Solr schema has changed, so records must be reindexed after an upgrade. See the [[development:​architecture:​solr_index_schema#​changelog|index schema changelog]] for more details.
   * :!: Be sure to run a database upgrade to reflect table changes (see also the [[development:​architecture:​database_schema#​release_60|database changelog]]).   * :!: Be sure to run a database upgrade to reflect table changes (see also the [[development:​architecture:​database_schema#​release_60|database changelog]]).
Line 28: Line 62:
   * :!: Facet labels are now displayed based on a labelSections configuration setting instead of through hard-coded activateAllFacets() methods in the Search Params classes. This makes it easier to ensure that facet fields are labeled correctly in all contexts. Be careful that you remove any references to activateAllFacets from custom code/​templates,​ as the method no longer exists. See [[https://​github.com/​vufind-org/​vufind/​pull/​1291|pull request #1291]] for details.   * :!: Facet labels are now displayed based on a labelSections configuration setting instead of through hard-coded activateAllFacets() methods in the Search Params classes. This makes it easier to ensure that facet fields are labeled correctly in all contexts. Be careful that you remove any references to activateAllFacets from custom code/​templates,​ as the method no longer exists. See [[https://​github.com/​vufind-org/​vufind/​pull/​1291|pull request #1291]] for details.
   * :!: Record tabs are now configured through a RecordTabs.ini file, instead of through the Zend Framework module.config.php files. This makes configuration significantly less complicated -- see [[https://​github.com/​vufind-org/​vufind/​pull/​1370|pull request #1370]]. If you have any custom tab configurations,​ you should move them out of your local module'​s configuration and into a local copy of RecordTabs.ini.   * :!: Record tabs are now configured through a RecordTabs.ini file, instead of through the Zend Framework module.config.php files. This makes configuration significantly less complicated -- see [[https://​github.com/​vufind-org/​vufind/​pull/​1370|pull request #1370]]. If you have any custom tab configurations,​ you should move them out of your local module'​s configuration and into a local copy of RecordTabs.ini.
 +  * :!: The signature of the getHolding ILS driver method has been changed to include an options array, and the return format has been adjusted to support optional pagination. Custom drivers may need to be adjusted for compatibility with these changes. See [[https://​github.com/​vufind-org/​vufind/​pull/​1358|pull request #1358]] for details.
   * :!: Several methods deprecated in earlier releases have been removed; see [[https://​github.com/​vufind-org/​vufind/​pull/​1314|pull request #1314]] for details.   * :!: Several methods deprecated in earlier releases have been removed; see [[https://​github.com/​vufind-org/​vufind/​pull/​1314|pull request #1314]] for details.
   * :!: OAI-PMH server classes are now defined as top-level services so they can be more easily extended/​overridden. This has changed the constructor signature and added an init method. Additionally,​ responses are now constructed in a different way for improved performance,​ replacing the showResponse() method with a createResponse() method. If you have customized OAI-PMH server code, you will have to adjust to match; see [[https://​github.com/​vufind-org/​vufind/​pull/​1237|pull request #1237]] and [[https://​github.com/​vufind-org/​vufind/​pull/​1356|pull request #1356]] for details.   * :!: OAI-PMH server classes are now defined as top-level services so they can be more easily extended/​overridden. This has changed the constructor signature and added an init method. Additionally,​ responses are now constructed in a different way for improved performance,​ replacing the showResponse() method with a createResponse() method. If you have customized OAI-PMH server code, you will have to adjust to match; see [[https://​github.com/​vufind-org/​vufind/​pull/​1237|pull request #1237]] and [[https://​github.com/​vufind-org/​vufind/​pull/​1356|pull request #1356]] for details.
   * :!: As noted above, [[https://​github.com/​vufind-org/​vufind/​pull/​1209|pull request #1209]] changes the default format determination rules for MARC records; if you have customized this or have a custom marc.properties,​ you may wish to double-check that the new method is being used and meets your needs.   * :!: As noted above, [[https://​github.com/​vufind-org/​vufind/​pull/​1209|pull request #1209]] changes the default format determination rules for MARC records; if you have customized this or have a custom marc.properties,​ you may wish to double-check that the new method is being used and meets your needs.
 +  * :!: The constructor signature of the VuFind\Record\Router has changed, because it no longer depends upon the VuFind\Record\Loader (see [[https://​github.com/​vufind-org/​vufind/​pull/​1364|pull request #1364]]).
 +  * :!: Buttons for performing actions on records have been re-styled for consistency and easier customization;​ if you have changed markup or styles on these controls, you may need to revise your customizations. See [[https://​github.com/​vufind-org/​vufind/​pull/​1379|pull request #1379]] for details.
 +  * The VuFindSearch\Query\QueryInterface has been expanded to account for text normalization. Custom subclasses are unlikely, but if you have built one, it will need adjustment. See [[https://​github.com/​vufind-org/​vufind/​pull/​1391|pull request #1391]] for details.
   * The custom Java indexing code for tracking record changes has been updated to use java.time.LocalDateTime instead of java.util.Date for clarity; see [[https://​github.com/​vufind-org/​vufind/​pull/​1349|pull request #1349]] for details.   * The custom Java indexing code for tracking record changes has been updated to use java.time.LocalDateTime instead of java.util.Date for clarity; see [[https://​github.com/​vufind-org/​vufind/​pull/​1349|pull request #1349]] for details.
   * All static factory methods have been replaced with standard reusable Zend Framework factory classes. This shouldn'​t break anything, but if you have overridden any factories, you should review whether you can eliminate that local code and simply reuse an existing class.   * All static factory methods have been replaced with standard reusable Zend Framework factory classes. This shouldn'​t break anything, but if you have overridden any factories, you should review whether you can eliminate that local code and simply reuse an existing class.
Line 36: Line 74:
   * The '​vufindrecord'​ route definition has been removed (see [[https://​github.com/​vufind-org/​vufind/​commit/​7db90be10938005e3bf069722e62d7f420e81408|this commit]]); this was intended for legacy compatibility after standardizing the name of the default record source from '​VuFind'​ to '​Solr'​ in release 3.0 and is very unlikely to still be needed in correctly upgraded instances.   * The '​vufindrecord'​ route definition has been removed (see [[https://​github.com/​vufind-org/​vufind/​commit/​7db90be10938005e3bf069722e62d7f420e81408|this commit]]); this was intended for legacy compatibility after standardizing the name of the default record source from '​VuFind'​ to '​Solr'​ in release 3.0 and is very unlikely to still be needed in correctly upgraded instances.
  
 +[[changelog:​release-6-0|Press Release]]
 ===== Release 5.1.1 - 5/6/2019 ===== ===== Release 5.1.1 - 5/6/2019 =====
  
changelog.1560433665.txt.gz · Last modified: 2019/06/13 09:47 (external edit)