Winter sprint 2023
The latest sprint resulted in several new outcomes: a metadata field, multiple documentation pages, a release of the Sidecar Images plugin, and a dockerized container for GeoBlacklight.
Seven members of the GeoBlacklight Community participated in a one-week sprint for the week of February 27 - March 3, 2023. We focused on organizing the open issues for OpenGeoMetadata as well as how to plan for upcoming challenges with adopting the beta version of Blacklight 8.0.
The sprint resulted in several new outcomes: a metadata field, multiple documentation pages, a release of the Sidecar Images plugin, and a dockerized container for GeoBlacklight.
New metadata field, "Display Note", added to OpenGeoMetadata, version Aardvark.
Many institutions using GeoBlacklight have implemented custom fields to display warnings or tips to users. These fields are used to highlight important information about a resource that users need to be aware of before accessing or using it. For example, a warning might indicate that the resource is incomplete or may be difficult to use due to technical limitations. A tip might provide guidance on how to use the resource effectively, such as suggesting specific software or tools that are compatible with the data.
The main downside of custom fields is that they are not interoperable; when we share metadata across institutions, this information is lost. Another drawback is that custom fields require local development time to implement as opposed to functionality that comes with GeoBlacklight out-of-the-box.
During the sprint, we devised a single field to capture this information, called "Display Note". This versatile field is inspired by website widgets known variably as callouts (general usage), admonitions (Python Markdown), or alerts (Bootstrap). Callouts are generally highlighted in colors and/or icons that indicate the type of information being offered, such as a red background for a Warning.
Details about the new field:
- Multiplicity: this field is an array that can have multiple values
- Syntax: type of callout: text of callout
- Example value:
[ "Warning: This text (starting with 'This text') will be displayed in a red box", "Info: This text (starting with 'This text') will be displayed in a blue box", "Tip: This text (starting with 'This text') will be displayed in a green box", "This is text without a tag and it will be assigned the default 'note' style" ]
Right now, the field can be added to your GeoBlacklight Solr instance as a simple string field. In the next sprint, we plan to add functionality to GeoBlacklight that will automatically read the first part of the field (ex. Warning:) and display the text with highlight background prominently on the page.
Versioning and roadmaps
We have a new Technology Matrix that maps out our GeoBlacklight release plans and technology dependencies. This matrix takes into account compatiblity with the Blacklight Project, which recently pre-released a beta version 8.0..
New Release of GeoBlacklight Sidecar Images Plugin
We upgraded the GeoBlacklight Sidecar Images Plugin, which can display image thumbnails on search result pages. The plugin now uses the same rake tasks as GeoBlacklight for running the test suite.
New Dockerized version of GeoBlacklight
Developers from Harvard University have created a built instance of GeoBlacklight in a Docker context. This will allow new and existing users to test and develop an instance of GeoBlacklight within the Docker environment.
Thank you to everyone who participated during this sprint! Please consider joining up at the next community sprint coming in June 2023.