Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 3.41 KB

README.md

File metadata and controls

66 lines (44 loc) · 3.41 KB
Raw

iDC Citation and Export Metadata Module

This module will do / does a few things:

  • provide an endpoint to get bibliographic citations for repository items in Islandora
    • This feature is not yet implemented, but the wiring for it is.
  • currently this provides support for metadata export
    • Field Formatters for CSV export (in /src/Plugin/Field/FieldFormatters)

Bibliographic Citations

Bibliographic citations are available at the following endpoint:

https://islandora-idc.traefik.me/citation

And needs to be supplied a nid parameter, like so: https://islandora-idc.traefik.me/citation?nid=99

This endpoint will return JSON that looks like this:

[
  {
    "nid": "99",
    "field_citable_url": "https://islandora-idc.traefik.me/node/99",
    "citation_apa": "<div class=\"csl-bib-body\">\n  <div class=\"csl-entry\">Adams, A. E. (2020). <i>Zoo Animal A</i>. Chicago Zoo. https://islandora-idc.traefik.me/node/99</div>\n</div>",
    "citation_chicago": "<div class=\"csl-bib-body\">\n  <div class=\"csl-entry\">Ansel Easton Adams. 2020. <i>Zoo Animal A</i>. 1. Chicago Zoo. https://islandora-idc.traefik.me/node/99.</div>\n</div>",
    "citation_mla": "<div class=\"csl-bib-body\">\n  <div class=\"csl-entry\">A. E. Adams. <i>Zoo Animal A</i>. Chicago Zoo, 1 Jan. 2020, https://islandora-idc.traefik.me/node/99.</div>\n</div>"
  }
]

Metadata Export

Metadata export is performed via a few tools. One is the Views Data Export Drupal module, which provides the functionality to do the export itself, where the data is exported using a CSV serializer. Views Data Export helps create a REST endpoint through which a Solr query can be sent and data can be serialized into CSV. A file link is returned and the user can download the results.

The endpoint for Repository Items is available at the path /export_items.

The endpoint for Collection Objects is available at the path /export_collections.

Right now the export uses batch functionality, which means it will create a file on the server and share with the user a file link. We may decide to do this another way, but if you are exported files with thousands of entries, we will want to use some sort of batch functionality. Admittedly, the current flow is a little odd and we may want to change it.

Example metadata export queries

Export all the collection objects that have the word ‘zoo’ in them:

https://islandora-idc.traefik.me/export_collections?query=zoo

Export all the repository items that have the word ‘zoo’ in them:

https://islandora-idc.traefik.me/export_items?query=zoo

Export single item:

https://islandora-idc.traefik.me/export_items?query=(its_nid:82)

Export all repository items, down through sub collections:

https://islandora-idc.traefik.me/export_items?query=(itm_field_member_of:33)

You'll end up with all the repository item descendents of the collection, including those that are part of any of its sub collections.

Export all direct descendants of a collection:

https://islandora-idc.traefik.me/export_items?query=(its_field_member_of:33)

You'll end up with all the items directly in the collection specified.

Field Formatters

There are a few field formatters, which help format particular fields during export. This enables us to export fields in the format we want for our particular export.

TODO: add information about the formatters