v3.1.2

Changed

• Relax Rails version constraint to not restrict to a single minor release of Rails (e.g. 5.2.x)

v3.1.1

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

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

bug with search pagination

v3.0.2

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
• migration.md removed

Deprecated

• site_section application helper in favor of html_classes

v3.0.1

Fixes date searching bug and incorrect locale string path

v3.0.0

Changes

• Integrate api_bridge
• Improve pagination a11y
• Return docs from other repo
• Add IIIF image helper
• i18n improvements
  • Ensure one canonical path per language
  • Translate facet names
• Sort by title_sort field rather than title
• Reorganize more markup into partials for more granular overriding
• Update title markup and <h#> tags
• Integrate redirection middleware library written for Lewis and Clark Journals
• Adds "sections" which re-use code across multiple routes with overridable templates
  • Configure "sections" with config/sections/(name).yml files
• Remove facets from models and define in config/facets.yml
  • Clarify options by renaming and implementing as flags
• Split Orchid routes into reusable and not
  • Refactor route drawing code
• Fix specific request options overriding app-wide options
• Remove Google fonts from default templates
• Update search result design / styling
• Update generator actions
• Update documentation
• Add i18n support to item show pages metadata and facet summary boxes
• Set Orchid-wide list of Rails internal params
  • Delete from API requests and link query strings
• Add skip nav link for a11y
• Make Orchid compatible with Sprockets 4 in addition to 3
• Add server-side search date filter validation
• Add fixes for deprecated/old gems to generator
• Clarify language in generator and documentation
• Update general description of Orchid in README files
• Make render_overridable check more coherent section override paths

Migration Instructions

metadata method in DisplayHelper altered so final argument is now
a keyword argument, link which defaults to true. Previously, this
was a non-keyword argument.

Provides basic support for IIIF image URLs in views with the helper iiif(partial_image_path, size: "!150,150")

config/private.yml

iiif_path must be added, see example in orchid's private.yml template

config/public.yml

• app_options.media_server_dir is the name of the project's directory
  following the IIIF server path
• app_options.thumbnail_size is the width and height of the image. Use "!" to
  preserve the ratio. Ex: "!200,200"
• app_options.languages must now delimit all languages used in the app, rather
  than only non-default languages

config/initializers/config.rb

Add IIIF_PATH = PRIVATE["iiif_path"] to this file to make IIIF_PATH accessible to application

app/assets/config/manifest.js

Copy app/assets/config/manifest.js to same path in existing apps

Gemfile

Ensure that all Gemfile updates from the generator have been added:

• gem 'sass-rails' … replaced with gem 'sassc-rails', '~> 2.1'
• gem 'chromedriver-helper' replaced with gem 'webdrivers'
• gem 'bootstrap-sass' has version constraint '~> 3.4.1'

v3 Beta

• Integrate api_bridge
• Improve pagination a11y
• Return docs from other repo
• Add IIIF image helper
• i18n improvements
  • Ensure one canonical path per language
  • Translate facet names
• Sort by title_sort field rather than title
• Reorganize more markup into partials for more granular overriding
• Update title markup and <h#> tags
• Integrate redirection middleware library written for Lewis and Clark Journals
• Adds "sections" which re-use code across multiple routes with overridable templates
  • Configure "sections" with config/sections/(name).yml files
• Remove facets from models and define in config/facets.yml
  • Clarify options by renaming and implementing as flags
• Split Orchid routes into reusable and not
  • Refactor route drawing code
• Fix specific request options overriding app-wide options
• Remove Google fonts from default templates
• Update search result design / styling
• Update generator actions
• Update documentation

Configuration Changes for Language Support, Bug Fixes

language update moves all site title configuration into the locale files
THIS IS A BREAKING CHANGE*: projects using the public config file for the following must move the configuration to the locales (such as en.yml):

• project_name
• project_shortname
• project_subtitle

fixes bug with single language selection display
fixes bug with summary boxes
moves documentation to henbit repository
minor CSS change

• minor version bump because only one known production application is affected

Multiple Language Support

Uses Rails internationalization support to make Orchid multiple-language friendly out of the box. By default, ships with English. Instructions for adding more languages and changing the default language can be found in the README.