/islandora_solr_metadata

Provides an interface to construct configurations used for displaying metadata on Islandora objects.

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

Islandora Solr Metadata Build Status

Introduction

Provides an interface to construct configurations used for displaying metadata on Islandora objects.

Requirements

This module requires the following modules/libraries:

Installation

Install as usual, see this for further information.

Configuration

The Islandora Solr Metadata module is used by selecting it to be the default metadata display viewer at Administration » Islandora » Metadata Display (admin/islandora/metadata).

Configuration

General configuration and metadata field configurations is available at Administration » Islandora » Solr Index » Solr Index (admin/islandora/search/islandora_solr/metadata).

Configuration

Notes

  • To use Solr Metadata with Scholar's citation/thesis cModels, please enable the Use Standard Metadata Display option in Administration » Islandora » Solution pack configuration » Scholar (/admin/islandora/solution_pack_config/scholar).

Configuration

Customization

The backbone of this module is to allow users to select fields indexed in their Solr as what drives metadata displays. This allows for the creation of heterogenous displays pulled from many sources from something that is already easily available.

The Islandora Solr Metadata module uses templates to fuel the markup displayed when it's the defined viewer for an object. As such these are overwritable to alter the display of the metadata as seen fit.

For a more indepth look at the metadata display framework and an example module implementation see the Islandora wiki.

It's to be noted that you can have a content model associated with more than one configuration at a time. Similarly, on objects with two content models, two or more configurations could respond to display the markup for the object. These cases are handled by merging the displays based around the weight. Take for example the case where you have two responding configurations where the first configuration contains the a and c fields and the second the b and d fields. The metadata display output would then be in the following order: a, b, c, d. As such, it's at the discretion of the user, through the creation of configurations, to determine how they want their metadata to be displayed.

Documentation

This module's documentation is also available at our wiki.

Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

Maintainers/Sponsors

Current maintainers:

Development

If you would like to contribute to this module, please check out CONTRIBUTING.md. In addition, we have helpful Documentation for Developers info, as well as our Developers section on the Islandora.ca site.

License

GPLv3