Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.76 KB

README.md

File metadata and controls

48 lines (32 loc) · 2.76 KB
Raw

REST OAI-PMH

This REST OAI_PMH module exposes dublin core field mappings to an OAI-PMH endpoint using Views. For a full description of the module visit: https://www.drupal.org/project/rest_oai_pmh

To submit bug reports and feature suggestions, or to track changes visit: https://www.drupal.org/project/issues/rest_oai_pmh

Install

Install via composer require drupal/rest_oai_pmh

Visit https://www.drupal.org/node/1897420 for further information.

Enable

When you enable this module a REST endpoint will be exposed, and any user that accesses your site that has the "Access GET on OAI-PMH" permission and can view the entities exposed to the endpoint will have access to your OAI-PMH endpoint.

Configure

  1. If you haven't already, set the Dublin Core Metatag mappings for the entities you want to expose to OAI-PMH. This can be done with the RDF module, Metatag's Dublin Core module, or a custom module/theme overriding this module's template. The mapping is how the endpoint will print metadata for the records and sets.
  2. Create a an Entity Reference View display for each set you want exposed to OAI-PMH. Optionally, in your View you can provide a contextual filter to an Entity Reference field. If you do so, the entities in that field will be used as the sets.
  3. In the Drupal permissions admin UI, grant anonymous users the "Access GET on OAI-PMH" permissions" permission if you want anonymous users (i.e. OAI-PMH Harvesters) to be able to access the endpoint. You'll also want to be sure anonymous users can view published content. Screenshot of permissions field
  4. Go to the REST OAI-PMH configuration form at /admin/config/services/rest/oai-pmh and supply your system configuration.

MODS

Configure

A simple view ("Article MODS Mapping") and twig template (mods.html.twig) using Drupal's Article content type has been included as an example.

  1. Modify the template mods.html.twig found in the module's templates folder to suit the specific needs for the repository.
  2. Create a View to map entity fields to their MODS element.
    • The View should have a contextual filter for content ID.
    • For each field you wish to display, add it to the list of fields and create a label for the field, setting it to the variable name used within the twig template.
  3. Set the View machine name and display name in the REST OAI-PMH configuration form (/admin/config/services/rest/oai-pmh). To use the simple View included, set the "View Machine Name" to be article_mods_mapping and set the "View Display Name" to be default.

Future Development

  • The only supported OAI-PMH metadata formats currently is oai_dc. Plan to cross-walk oai_dc mapping into METS/MODS eventually