Skip to content

Blacklight 5.0.0

Compare
Choose a tag to compare
@jcoyne jcoyne released this 30 Jan 01:03

Commit History | Milestone

Major Changes

Bootstrap 3 (#640)

Blacklight 5.x updates the views and helpers to use Bootstrap 3.x. As part of this update, we've tweaked the default theme to align closer with Bootstrap conventions. This is a major change, and applications that have overridden the Blacklight / Bootstrap 2.x themes will need to be updated.

screen shot 2014-01-10 at 9 29 35

MARC-specific code extracted into blacklight-marc (#606)

We've extracted the library / MARC-format specific code from Blacklight into a separate gem, http://github.com/projectblacklight/blacklight_marc. Going forward, this gem will be a home for additional MARC-specific features that wouldn't make sense in the Blacklight core.

Remove deprecated code and views

Deprecated methods and templates have been marked as deprecated in Blacklight 4.x releases and have been removed in Blacklight 5.x.

Other methods have been marked as deprecated in Blacklight 5.x (to be removed in Blacklight 6.x):

  • Blacklight.solr (use #blacklight_solr accessor instead)
  • config.show and config.index parameters have been re-organized to use consistent methods

Features

#640 (and #642, #643, #651, #667, #671, #675, #677, #713, #720) Convert front end to Bootstrap 3 and improve default Blacklight theme.

#606 Refactor MARC-specific code from Blacklight into a separate blacklight-marc gem

#665 Add interface for building the Solr request parameters (instead of modifying a ruby hash directly)

#683 Allow blacklight's catalog configuration to control partials to render for index and show views

#680 Simple schema.org support in the Blacklight configuration

#721 Search results view type picker

#716 Add :collapse to add_facet_field configuration to determine if the facet should be displayed collapsed (the default) or expanded

#697 Add :accessor to add_index/show_field configuration to call a method on the SolrDocument instead of looking in a solr field for a value.

Improvements

#657 Improve the AJAX modal (details in ticket)

#656 Use a 303 See Other redirect to redirect from catalog#update to the catalog#show page (triggered by the search context javascript)

#655 Catalog controller routes should be configurable

#684 page_entries_info should use Rails-formatted numbers

#681 update blacklight-jetty to use Solr 4.6.0

#711 RSolr can be configured to use POST requests instead of PUT

#714 Ensure view types persist between searches

#729 Better support for different index views

#658 Remove zebra_stripe.js

Upgrade guide

  1. Update your application to the terminal Blacklight 4.x release (4.7.0, as of this writing) to receive notices of deprecated behaviors used in your local application.

  2. remove the line @import 'bootstrap-responsive'; from app/assets/stylesheets/blacklight.css.scss. This file has been removed in Bootstrap 3.

  3. The FeedbackController (deprecated in 4.x) has been removed. If your application used this feature from Blacklight, consider a 3rd party implementation or roll your own.

  4. Update your Gemfile to use Blacklight 5.0.0.

         gem 'blacklight', ' ~> 5.0'
    
  5. Add the blacklight-marc gem to your Gemfile. If you are not using MARC-flavor metadata, you can omit them gem, and remove any references to Blacklight::Solr::Document::Marc from your SolrDocument class.

  6. Update your CatalogController configuration to:

    • rename config.show.html_title to config.show.title_field

    • rename config.show.heading to config.show.title_field

    • rename config.show.display_type to config.show.display_type_field

    • rename config.index.show_link to config.index.title_field

    • rename config.index.record_display_type to config.index.display_type_field

      Note: config.show can be omitted if the fields to render are the same