v4.4.0

Upgrade Notes

See notes for v4.4.0.rc1.

Thanks for @srappel and @ewlarson for their help with testing.

v4.4.0.rc1

New Features

Support for OpenLayers, COGs and PMTiles

COG Example

PMTiles

Full details in PR#1331

Clover IIIF Manifest Viewer

Full details in PR#1336

Baseline support for OpenIndexMaps Specification 1.0.0

Full details in PR#1233

Upgrade Notes

Complete these steps to upgrade your GeoBlacklight install from v4.1 to v4.2:

• Bump your Gemfile to: gem "geoblacklight", "4.4.0.rc1" and run bundle
• Vite Ruby has been adopted as a new frontend asset builder
  • Add gem "vite_rails", "~> 3.0" to your Gemfile.
  • Run bundle install.
  • Review the new base.html.erb template
  • Add the vite_client_tag and vite_javascript_tag entries to your local base.html.erb file these lines
  • Copy https://github.com/geoblacklight/geoblacklight/blob/main/lib/generators/geoblacklight/templates/package.json to the root of the project or update your existing package.json file.
  • Copy https://github.com/geoblacklight/geoblacklight/blob/main/lib/generators/geoblacklight/templates/vite.json to config/vite.json.
  • Copy https://github.com/geoblacklight/geoblacklight/blob/main/lib/generators/geoblacklight/templates/vite.config.ts to the root of the project.
  • Copy https://github.com/geoblacklight/geoblacklight/blob/main/lib/generators/geoblacklight/templates/clover.js to app/javascript/entrypoints/clover.js
  • Copy https://github.com/geoblacklight/geoblacklight/blob/main/lib/generators/geoblacklight/templates/ol.js to app/javascript/entrypoints/ol.js
  • Install the new vite javascript dependencies by running: yarn install
• config/locales/geoblacklight.en.yml has new clipboard entries — if you have customized this file, please add them to your local file
• settings.yml has new entries for cogs and pmtiles here and here
• New dct_references_s key/values have been added for: cogs, pmtiles, and iiif_manifests
  • If you've customized your item viewer preferences, you'll need to update
    • lib/geoblacklight/constants.rb here
    • lib/geoblacklight/item_viewer.rb here and here

What's Changed

• update error message and test by @the-codetrane in #1309
• Allow more recent versions of Blacklight and update CI testing matrix by @eliotjordan in #1328
• Support for OpenLayers, COGs, and PMTiles by @eliotjordan in #1331
• Add COG and PMTiles to web services modal by @eliotjordan in #1332
• Drop Faraday v1 by @ewlarson in #1335
• Use Clover for IIIF Manifests by @eliotjordan in #1336
• put geoblacklight version in a meta tag by @kgjenkins in #1337
• Add test for version tag by @eliotjordan in #1338
• Moves OpenIndexMap test fixtures to repo by @srappel in #1339
• add baseline support for OpenIndexMaps Specification 1.0.0 by @srappel in #1333
• GBL Icons: Update geoblacklight-icons.json file by @ewlarson in #1340
• update readme to point to external docs #1345 by @mradamcox in #1348
• Updates to test app generation by @eliotjordan in #1347
• Web services: add copy to clipboard feature by @ewlarson in #1341
• Bump GeoCombine dependency to v0.9 by @thatbudakguy in #1351
• Package frontend javascript as npm package by @eliotjordan in #1356
• Add Northwestern icon by @karenmajewicz in #1357

New Contributors

• @srappel made their first contribution in #1339
• @mradamcox made their first contribution in #1348

Full Changelog: v4.1.1...v4.4.0.rc1

v4.1.1

What's Changed

• Add Citation to Clipboard by @the-codetrane in #1307
• Remove development.sqlite3 file by @eliotjordan in #1311
• update OSM tile URL by @kgjenkins in #1304
• Update the name of the UC Berkeley svg icon by @eliotjordan in #1319
• use integers in index map style by @kgjenkins in #1317

New Contributors

• @the-codetrane made their first contribution in #1307

Full Changelog: v4.1.0...v4.1.1

v4.1.0

GeoBlacklight v4.1.0

New Features

New Display Note Field

GBL v4.1 includes official support for OpenGeoMetadata's Display Note field. This new field allows you to embed custom notes within the solr document to provide tips, info, warnings, or notices to users within the interface.

Full details in PR#1294

IIIF Sidebar Static Maps

A feature from the B1G/BTAA Geoportal, when IIIF or IIIF Manifest files are displayed in the default viewer, we now include a static map in the sidebar to contextualize the main item geographically.

Full details in PR#1295

Upgrade Notes

Complete these configuration steps to upgrade your GeoBlacklight install from v4.0 to v4.1:

• Bump your Gemfile to: gem "geoblacklight", "~> 4.1" and run bundle
• Update your settings.yml file for the changes listed below
• Add the new display note partial to your catalog_controller.rb configuration

After these files have been updated, restart your Rails application server to pick up the changes.

Please note: If upgrading from a v3.X release to 4.X, please follow the detailed Upgrading to GeoBlacklight v4.0 guide.

Settings.yml

Note: Our configuration settings.yml file now has a detailed page within GeoBlacklight's documentation site: https://geoblacklight.org/docs/configuration/settings/

We've added a few new blocks to the default settings.yml file. The new keys and changes are listed below. Please update your local application settings.yml file to reference the new changes.

FIELDS:
  :DISPLAY_NOTE: 'gbl_displayNote_sm'

We added a new field for the v4.1 display note feature.

DISPLAY_NOTES_SHOWN:
  ...

This block configures the display notes enabled in your application.

RELATIONSHIPS_SHOWN:
  ...

This block was updated to allow parent/child, ancestor and descendant

SIDEBAR_STATIC_MAP:
  ...

This block controls the display of a static map in the sidebar of catalog#show pages. The map contextualizes IIIF images by showing a map and bounding geom for the current item.

CatalogController.rb

Add the new show_default_display_note file into your catalog_controller.rb file config.show.partials like so:

    # solr field configuration for document/show views
    # This sets the metadata to display below the map viewer.
    # To move metadata above the map viewer,
    # remove the lines deleting and re-adding the :show partial
    config.show.display_type_field = "format"
    config.show.partials.delete(:show)
    config.show.partials << "show_default_display_note"
    config.show.partials << "show_default_viewer_container"
    config.show.partials << "show_default_attribute_table"
    config.show.partials << "show_default_viewer_information"
    config.show.partials << :show

Locales changes

Some translation key/values were added or changed in config/locales/geoblacklight.en.yml for this release. If you override this translation file locally, please update your file as necessary.

View the translation file diff for the complete set of changes.

What's Changed

• Update template.rb by @ewlarson in #1254
• Replace rubocop with standardrb by @eliotjordan in #1244
• Fix invalid aardvark fixtures; Add CI job to validate them going forward by @mcritchlow in #1263
• Add icon for the University of Arizona by @thatbudakguy in #1268
• add displayNote test record by @kgjenkins in #1278
• Update README.md by @dl-maura in #1276
• SVG Logo: American Geographical Society Library - UWM Libraries by @ewlarson in #1280
• add gbl_displayNote_sm to validation file by @rmseifried in #1282
• Remove redundant heredoc delimiter quotes by @thatbudakguy in #1287
• Add SVG icon for University of Nebraska by @thatbudakguy in #1286
• Add SVG icon for Rutgers University by @thatbudakguy in #1285
• Update GeoCombine to v0.8.0 by @thatbudakguy in #1288
• Support for new OMG Aardvark Display Note field by @ewlarson in #1294
• Add support for static sidebar maps like the BTAA Geoportal. by @ewlarson in #1295
• Relationships - Add ancestor/descendant options by @ewlarson in #1296
• Settings: prepend the new v4.1 settings.yml additions by @ewlarson in #1300

New Contributors

• @mcritchlow made their first contribution in #1263
• @dl-maura made their first contribution in #1276

Full Changelog: v4.0.0...v4.1.0

v3.8.0

Summary

This release backports icons for newer OpenGeoMetadata provider institutions, CI fixes, and dependency updates.

Upgrading

If you use Ruby 2.6 or Rails 5, GeoBlacklight no longer tests for compatibility with these end-of-life versions. Consider upgrading to Ruby 3 and Rails 7.

If you use GitHub Actions CI and encounter errors about being unable to build native extensions for the patron gem as a dependency of faraday v1, have a look at 9fab342 and the related ticket actions/runner-images#37.

Changes

Icons

• University of Nebraska
• Rutgers University
• American Geographical Society Library - UWM Libraries
• University of Arizona
• George Mason University

CI Fixes

• Add cURL headers for building faraday 1.x dependency on patron
• Unpin bundler from v2.1.1 in CI
• Drop Ruby 2.6 support
• Drop Rails 5 support
• Always publish coverage data
• Fix coverage badge and simplify coverage checking
• Re-add pull-request trigger; don't run push checks on branches other than main

Dependencies

• Update GeoCombine to v0.8.0
• Support Faraday v1 and v2

Full Changelog: v3.7.0...v3.8.0

v4.0.0

Update Notes

Please see the GeoBlacklight 4.0 Upgrade Guide

What's Changed

• Update to 4.x by @eliotjordan in #1136
• Disable ESRI Specs by @eliotjordan in #1145
• Silence new cops warning by @eliotjordan in #1141
• Fix coverage badge and simplify coverage checking by @eliotjordan in #1140
• Remove publisher_sort by @tpendragon in #1151
• Ensure webmock doesn't open endless file sockets by @hackartisan in #1150
• Update settings key from ISO_TOPIC_CATEGORY to THEME by @tpendragon in #1152
• changed reference from master to main by @XanderGardner in #1154
• Add microdata to search results' title and description by @thanyabegum in #1143
• Updated index map colors to an accessible color palette by @mferrarini in #1157
• Only run CI on push by @eliotjordan in #1162
• Move map and attributes table above metadata details by @hackartisan in #1153
• Require blacklight 7.12 by @hackartisan in #1164
• Copy leaf and branch icons to have new titles by @hackartisan in #1166
• Rather than maintain our own, let new users use the Rails generated w… by @mejackreed in #1033
• Update configuration, copy fields, and specs / comments by @hackartisan in #1167
• Multivalued year sorting: specs and schema change to sort missing values last by @ewlarson in #1169
• Remove some debug by @cbeer in #1171
• Always publish coverage data by @cbeer in #1172
• Remove unused #render_facet_links helper by @cbeer in #1174
• Use a custom IconFacetItemComponent to add icons to the facets by @cbeer in #1173
• Use Geo3D and dedicated field for overlap ratio by @eliotjordan in #1159
• Install webpacker in test app by @eliotjordan in #1176
• Support Faraday 1.0 & 2.0 at the same time. by @tpendragon in #1170
• Re-add pull_request trigger by @eliotjordan in #1182
• Use a bbox filter field facet class to obviate Blacklight overrides by @ewlarson in #1163
• Vendorized JS/CSS: update libraries/packages by @ewlarson in #1180
• Update IIIF fixture reference by @eliotjordan in #1184
• Ensure oembed iframe is the same height as its container by @eliotjordan in #1186
• Update tms fixture by @eliotjordan in #1189
• Add Leaflet.Fullscreen plugin by @ewlarson in #1188
• Create index map legend to indicate what each color means by @mferrarini in #1165
• Remove enumerated theme values by @karenmajewicz in #1192
• Add fixture descriptions to README document by @eliotjordan in #1190
• Added CU Boulder svg using icomoon by @XanderGardner in #1193
• Color contrast adjustments by @mferrarini in #1196
• Update Capybara config to fix Selenium deprecation by @eliotjordan in #1198
• Combine download and export cards into dropdown button by @thanyabegum in #1194
• Replaces SPATIAL_EXTENT with GEOMETRY by @karenmajewicz in #1201
• Header Icons: Aardvark updates by @ewlarson in #1202
• Use a different export format I18n key for export links. by @tpendragon in #1205
• Update item view fields on catalog_controller.rb by @karenmajewicz in #1207
• Minor updates to Fixtures by @karenmajewicz in #1206
• Update cornell_html_metadata.json by @ewlarson in #1211
• CSS Fix - Relation cards bottom margin by @ewlarson in #1213
• Move web services link out of show tools to a button by @hackartisan in #1208
• Update multiple-downloads.json by @rmseifried in #1216
• Adjust GitHub actions matrix build by @thatbudakguy in #1214
• Appease rubocop by @cbeer in #1219
• Bug fix: allow all Aardvark relationship fields to browse suppressed records by @ewlarson in #1222
• Blacklight 7.25 compatible filter changes by @barmintor in #1224
• Leaflet: v1.8.0 release by @ewlarson in #1228
• Allow and test with Rails 7 by @cbeer in #1220
• I18n: fix missing GeoTIFF file download translation by @ewlarson in #1234
• GBL permitted params by @ewlarson in #1236
• update links to former gbl wiki by @kgjenkins in #1241
• Update template.rb by @ewlarson in #1243
• Rake - Add geoblacklight:index:seed[:remote] argument option to index test fixtures remotely from GitHub by @ewlarson in #1246
• Update README.md by @ewlarson in #1248
• Add zenodo DOI badge to README by @thatbudakguy in #1249
• GitHub Actions: Bump Ruby to 2.7 by @ewlarson in #1250
• George Mason University - Add SVG Icon by @ewlarson in #1252
• Create readme.md for schema directory by @karenmajewicz in #1253

New Contributors

• @tpendragon made their first contribution in #1151
• @hackartisan made their first contribution in #1150
• @thanyabegum made their first contribution in #1143
• @mferrarini made their first contribution in #1157
• @rmseifried made their first contribution in #1216
• @thatbudakguy made their first contribution in #1214
• @barmintor made their first contribution in #1224

Full Changelog: v3.6.0...v4.0.0

v4.0.0-rc3

What's Changed

• Allow and test with Rails 7 by @cbeer in #1220
• I18n: fix missing GeoTIFF file download translation by @ewlarson in #1234
• GBL permitted params by @ewlarson in #1236

Full Changelog: v4.0.0-rc2...v4.0.0-rc3

v3.7.0

What's Changed

• Support Rails 7 in geoblacklight 3.x by @cbeer in #1230

Full Changelog: v3.6.0...v3.7.0

v4.0.0-rc2

What's Changed

• Adjust GitHub actions matrix build by @thatbudakguy in #1214
• Appease rubocop by @cbeer in #1219
• Bug fix: allow all Aardvark relationship fields to browse suppressed records by @ewlarson in #1222
• Blacklight 7.25 compatible filter changes by @barmintor in #1224
• Leaflet: v1.8.0 release by @ewlarson in #1228

New Contributors

• @thatbudakguy made their first contribution in #1214
• @barmintor made their first contribution in #1224

Full Changelog: v4.0.0-rc1...v4.0.0-rc2

v4.0.0-rc1

What's Changed

• Update to 4.x by @eliotjordan in #1136
• Disable ESRI Specs by @eliotjordan in #1145
• Silence new cops warning by @eliotjordan in #1141
• Fix coverage badge and simplify coverage checking by @eliotjordan in #1140
• Remove publisher_sort by @tpendragon in #1151
• Ensure webmock doesn't open endless file sockets by @hackartisan in #1150
• Update settings key from ISO_TOPIC_CATEGORY to THEME by @tpendragon in #1152
• changed reference from master to main by @XanderGardner in #1154
• Add microdata to search results' title and description by @thanyabegum in #1143
• Updated index map colors to an accessible color palette by @mferrarini in #1157
• Only run CI on push by @eliotjordan in #1162
• Move map and attributes table above metadata details by @hackartisan in #1153
• Require blacklight 7.12 by @hackartisan in #1164
• Copy leaf and branch icons to have new titles by @hackartisan in #1166
• Rather than maintain our own, let new users use the Rails generated w… by @mejackreed in #1033
• Update configuration, copy fields, and specs / comments by @hackartisan in #1167
• Multivalued year sorting: specs and schema change to sort missing values last by @ewlarson in #1169
• Remove some debug by @cbeer in #1171
• Always publish coverage data by @cbeer in #1172
• Remove unused #render_facet_links helper by @cbeer in #1174
• Use a custom IconFacetItemComponent to add icons to the facets by @cbeer in #1173
• Use Geo3D and dedicated field for overlap ratio by @eliotjordan in #1159
• Install webpacker in test app by @eliotjordan in #1176
• Support Faraday 1.0 & 2.0 at the same time. by @tpendragon in #1170
• Re-add pull_request trigger by @eliotjordan in #1182
• Use a bbox filter field facet class to obviate Blacklight overrides by @ewlarson in #1163
• Vendorized JS/CSS: update libraries/packages by @ewlarson in #1180
• Update IIIF fixture reference by @eliotjordan in #1184
• Ensure oembed iframe is the same height as its container by @eliotjordan in #1186
• Update tms fixture by @eliotjordan in #1189
• Add Leaflet.Fullscreen plugin by @ewlarson in #1188
• Create index map legend to indicate what each color means by @mferrarini in #1165
• Remove enumerated theme values by @karenmajewicz in #1192
• Add fixture descriptions to README document by @eliotjordan in #1190
• Added CU Boulder svg using icomoon by @XanderGardner in #1193
• Color contrast adjustments by @mferrarini in #1196
• Update Capybara config to fix Selenium deprecation by @eliotjordan in #1198
• Combine download and export cards into dropdown button by @thanyabegum in #1194
• Replaces SPATIAL_EXTENT with GEOMETRY by @karenmajewicz in #1201
• Header Icons: Aardvark updates by @ewlarson in #1202
• Use a different export format I18n key for export links. by @tpendragon in #1205
• Update item view fields on catalog_controller.rb by @karenmajewicz in #1207
• Minor updates to Fixtures by @karenmajewicz in #1206
• Update cornell_html_metadata.json by @ewlarson in #1211
• CSS Fix - Relation cards bottom margin by @ewlarson in #1213
• Move web services link out of show tools to a button by @hackartisan in #1208
• Update multiple-downloads.json by @rmseifried in #1216

New Contributors

• @tpendragon made their first contribution in #1151
• @hackartisan made their first contribution in #1150
• @thanyabegum made their first contribution in #1143
• @mferrarini made their first contribution in #1157
• @rmseifried made their first contribution in #1216

Full Changelog: v3.6.0...v4.0.0-rc1