Skip to content

Latest commit

 

History

History
242 lines (185 loc) · 8.47 KB

CHANGELOG.md

File metadata and controls

242 lines (185 loc) · 8.47 KB
Raw

Orchid Changelog

All notable changes to Orchid will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased - unreleased

Fixed

  • displays flash message if API is down, instead of pages throwing errors
  • Fix removed Sprockets 4.x app/assets/config/manifest.js lines
  • Adjust hierarchy of headers to meet accessibility guidelines

Added

  • keyboard navigation for collapsible filter panels
  • role=button added to anchor tags styled as a button
  • buttons can be activated with spacebar
  • panels displayed uncollapsed if javascript is not ebabled
  • modernizr files added to vendor directory
  • more Orchid favicons and icons generated by setup

Changed

  • updates jquery 1.x to 3.x
  • rails g setup is now rails g orchid_setup
  • check_response method added to items_controller
  • updated documentation on assets and updating modernizr
  • changed instructions on how to install rails and generate a new app

Migration

  • modify existing app's application.js
    • change //= require jquery to //= require jquery3
    • apps will continue to function with older jquery if not modified
  • add errors.api and search.results.error to locale files
  • check items_overrides and views/items for changes related to display items when API is unavailable
  • update existing apps' app/assets/config/manifest.js to include Sprockets 3.x and 4.x defaults like the updated template to be copied by the generator https://github.com/CDRH/orchid/commit/b90a3f4063352c2220aa12184bbb933799a9d601

v3.1.1 - splitting templates, fixing languages

Fixed

  • bug with locales yaml creation
  • es locale file will be copied into app if Spanish requested
  • thumbnail size in public.yml requires quotation marks for newer psyche yaml gem

Added

  • partials for browse, browse_facet, index, and search_preset header content for easier overriding
  • displays language toggle options in respective languages, therefore English instead of en, Español instead of es, etc
  • helper method language_toggle_link moves logic for language links out of view
  • documentation for api connection and controller inheritance
  • adds partials for easier overriding:
    • browse_header
    • browse_facet_header
    • index_header
    • search_preset_header
    • analytics (head)
    • language (head)

Changed

  • language documentation clarified and expanded
  • references to APP_OPTS["languages"] changed to use all_languages

Migration

  • rename languages and ALL_LANGUAGES to all_languages in public.yml file

v3.1.0 - search_preset, improved section links, and misc display

Fixed

  • bug with search pagination when small result set
  • section sort reflects section configuration by default

Added

  • search_preset functionality and documentation
  • title display accommodates italics and other markup

Changed

  • render_overridable calls with full path to partials
  • "search_path" changed to route_path to allow overrides

Removed

  • Reference to @site_section which was no longer in use

Migration

  • check overridden partials / views for render_overridable calls without path to views directory
    • Ex: render_overridable "items", "sort" instead of render_overridable "sort"

v3.0.3 - pagination bugfix

Fixed

  • bug with search pagination

v3.0.2 - html_classes for styling and minor fixes

Added

  • Adds more classes to html element via html_classes helper to increase granularity for styling
  • Merged migration.md into CHANGELOG.md

Changed

  • Class beginning with section_ may have a different value than previously
  • Altered documentation substantially, split into parts and augmented existing

Removed

  • class row removed from <div class="search_form">
  • migration.md removed

Deprecated

  • site_section application helper in favor of html_classes

v3.0.1 - date search bug and incorrect locale path

Fixed

  • bug with date search
  • incorrect locale path

v3.0.0 - sections, facet config, iiif, and more

Fixed

  • improved pagination a11y
  • fix specific options overriding app-wide options

Added

  • basic support for IIIF image URLs
  • i18n support for item show pages metadata and facet summaries
  • manifest.js file for Sprockets 4 support
  • integrated api_bridge into Orchid from deprecated gem
  • facet translation i18n
  • added redirection / rewriting middleware
  • added configurable "sections" to re-use code across multiple routes
  • "skip" link for a11y
  • server side date filter validation

Changed

  • metadata method in DisplayHelper altered to use keyword arg
  • public and private config file alterations (explanation below)
  • altered behavior of language configuration settings and UI
  • sort by title_sort rather than title
  • reorganized some files for more granular overriding
  • split up routes into reusable / not reusable and refactored
  • search result styling
  • generator actions
  • documentation improved
  • gems used by generator (were deprecated)
  • render_overridable check more coherent section override paths

Removed

  • facets from models and define in config/facets.yml
  • google fonts from default templates

Migration

  • update metadata method calls to use keyword arg, "link"
  • add iiif_path to config/private.yml
  • add app_options.media_server_dir and app_options.thumbnail_size to config/public.yml
  • change app_options.languages to list ALL site languages, not just non-default
  • add IIIF_PATH = PRIVATE["iiif_path"] to config/intitializers/config.rb
  • copy app/assets/config/manifest.js to your application (same path)
  • change Gemfile
    • sass-rails to 'sassc-rails', '~> 2.1'
    • replace chromedriver-helper with webdrivers
    • add version constraint to 'bootstrap-sass', '~> 3.4.1'
    • remove api_bridge
  • migrate facets config in models to config/facets.yml format
  • add facet translations if using multi-language app

v2.1.0 - Configuration Changes for Language Support, Bug Fixes

Fixed

  • bug with single language selection display
  • bug with summary boxes

Changed

  • moves title configuration to locale files
  • minor CSS change

Migration

  • copy config/locales/en.yml to application
  • fill in project_name, project_shortname and project_subtitle in config/locales file

v2.0.0 - Multiple Language Support

Added

  • relocates text throughout site to en.yml file
  • specify language_default and languages in config.public.yml

Migration

  • copy config/locales/en.yml to your app
  • review overridden partials / views / helpers for strings which should be changed to match localization support
  • redo facets.rb to match multiple language support
    • (1.1.1 style will continue to work if you do not change them)
    • define with Facets.facet_info instead of @facet_info

v1.1.1 - Fix date filtering; Gem updates

Fixed

  • regularized date filter removal like facet removal
  • updated gems to address Sprockets vulnerability

v1.1.0 - Rails 5.2.0

Changed

  • updates Orchid to support Rails 5.2

v1.0.0 - Enable Customization

Added

  • draw and override routes before and after Orchid defaults
  • overridable controller

Changed

  • extensive changes to views
  • asset inclusion in top level directory
  • configuration now includes public and private yaml files
  • sorting options now configurable for search / browse
  • reorganized flash messages
  • changes to SCSS
  • dependency versions bumped

Migration

  • there are no notes for migrating to this version

v0.1.0 - Initial Launch