Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 3.37 KB

README.md

File metadata and controls

76 lines (48 loc) · 3.37 KB

Islandora Badges

Introduction

Islandora Badges displays various metrics (and other) badges on objects. Each badge is created by a submodule. Available badges include:

  • Altmetrics: display social media interactions
  • Scopus: Citation counts via the Scopus database
  • Web of Science: Citation counts via Web of Science
  • oaDOI: Provides a link to a fulltext document for objects without a PDF datastream, via the oadoi.org API

Badges will only display on objects that have a DOI (digital object identifier). The xpath to the DOI field is configurable.

Requirements

This module requires the following modules/libraries:

Installation

Install as usual, see this for further information.

Configuration

Configuration path is admin/islandora/tools/badges (Administration > Islandora > Islandora Utility Modules > Islandora Badges Configuration).

There are two administration fields:

  • DOI XPath
    • The XPath to the DOI element e.g. /mods:mods/mods:identifier[@type="doi"]
    • A default is included and should serve most repositories, but you can change it if yours is located elsewhere.
  • Content models
    • Choose which CModels are able to display badges (Currently only applies to Altmetrics)

Submodules

These modules provide the actual badges:

Troubleshooting/Issues

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

Future development:

  • Make the Altmetric API Key a configurable variable
  • Allow other kinds of identifiers (besides DOI) to be used
  • Remove the restriction that limits badges to Citation objects
  • Add more badges

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.

Notes

Originally forked from William Panting's Islandora Altmetrics module by Mark Jordan and Brandon Weigel at the second iCampBC in July 2016. Much thanks to Mark for continued help and mentorship as I use this module to learn coding. Thanks also to Marcus Barnes for demonstrating how to assign array data to variables, which allowed me to figure out the Web of Science branch.

License

GPLv3