Releases: CDRH/orchid
v3.1.2
v3.1.1
Fixed
- bug with locales yaml creation
- es locale file will be copied into app if Spanish requested
- thumbnail size in
public.ymlrequires 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_linkmoves logic for language links out of view - documentation for api connection and controller inheritance
- adds partials for easier overriding:
browse_headerbrowse_facet_headerindex_headersearch_preset_headeranalytics(head)language(head)
Changed
- language documentation clarified and expanded
- references to
APP_OPTS["languages"]changed to useall_languages
Migration
- rename
languagesandALL_LANGUAGEStoall_languagesinpublic.ymlfile
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_overridablecalls with full path to partials"search_path"changed toroute_pathto allow overrides
Removed
- Reference to
@site_sectionwhich was no longer in use
Migration
- check overridden partials / views for
render_overridablecalls without
path to views directory- Ex:
render_overridable "items", "sort"instead ofrender_overridable "sort"
- Ex:
v3.0.3
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
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_sortfield rather thantitle - 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).ymlfiles
- Configure "sections" with
- 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_diris the name of the project's directory
following the IIIF server pathapp_options.thumbnail_sizeis the width and height of the image. Use "!" to
preserve the ratio. Ex: "!200,200"app_options.languagesmust 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 withgem 'sassc-rails', '~> 2.1'gem 'chromedriver-helper'replaced withgem '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_sortfield rather thantitle - 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).ymlfiles
- Configure "sections" with
- 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_nameproject_shortnameproject_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.