Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Islandora Scholar is a suite of modules designed to help Islandora function as an Institutional Repository . However, these modules can be helpful in other contexts. 

Sample Features

  • Integrates with Sherpa/RoMEO.
  • Attach PDFs to citation/thesis records.
  • Objects or PDF datastream of object can be embargoed and embargoes can be managed.
  • CSL for citation display and citation export.
  • Various citation batch ingest options (RIS, EndnoteXMLPMID, DOI, RefWorksXML).
  • Islandora Google Scholar module improves discovery.
  • Citations exposed via OAI-PMH using the Islandora OAI module.

Modules included in Islandora Scholar

(although some features are helpful in other use cases as well). It is unique compared to other Islandora modules in terms of the number of features it provides as well as the vast amount of submodules that it contains. It is helpful to think of Scholar as being a kind of scholarly content solution pack due to the new content models it provides (citation & thesis), but it also differs from other solution packs in that it provides new functionality that may be used with other cmodels as well.

Sample Features

  • New citation & thesis content models
  • Sherpa/RoMEO integration
  • Creation of new objects from EndNote XML or RIS files exported from other systems
  • Creation of new objects from Digital Object Identifiers (DOIs) and PubMed IDs (PMIDs)
  • Suppression of objects from display or disable viewing/downloading of particular datastreams
  • Exporting of collections of bookmarks as RIS, RTF or PDF files
  • User-selectable dynamic citation styling using Citation Style Language (CSL) files
  • Extra HTML metadata to assist with Google Scholar indexing
  • bibliography
  •  bibutils
  • citeproc
  • csl
  • doi
  • endnotexml
  • exporter
  • islandora_google_scholar
  • islandora_scholar_embargo
  • Islandora_populator (from Discovery Garden)

  • pmid
  • ris

Requirements

This module requires the following external modules/libraries:

The ir: namespace must be enabled.  Two content models in Islandora Scholar, thesis and citation, use the ir: namespace rather than the islandora: namespace.

Installation

Islandora Scholar also requires the Citeproc, CSL and Bibutils modules in order to be enabled, but these modules are included in the /modules directory of base Islandora Scholar module.

Please note that that enabling Scholar does not automatically enable the various Scholar submodules. They must be enabled separately, and they have their own separate requirements as well.

Additionally, it is necessary to install the citeproc-php library into the sites/all/libraries directory, such that the mainCiteProc.php file is located at sites/all/libraries/citeproc-php/CiteProc.php.

Finally, the included Bibutils submodule only provides PHP interface to the Bibutils tool itself, which must be installed separately. Follow these instructions for installing Bibutils.

Installation

 Install as usual, see this for further information.

...

 Scholar Core

While "Scholar Core" is not an official community term, it can be a helpful way to keep track of the numerous features Islandora Scholar offers. In this context, "core" features are those that come from the islandora_scholar.module file itself as opposed to coming from one of the numerous submodules which can be enabled or disabled independently of the main Islandora Scholar module.

Citation & Thesis Content Models

Scholar provides two new content models: the citationCModel and the thesisCModel. The citation cmodel is intended for general scholarly works, while the thesis cmodel is for handling electronic theses and dissertations (ETDs). While the datastream structure and default display of these two cmodels is nearly identical, they can be tweaked separately to accommodate the different use cases one may have for theses vs. other scholarly works, such as altered displays or separate metadata forms.

Please note that the citationCModel and thesisCModel are in the "ir" namespace, as opposed to the standard "islandora" namespace that other cmodels have had in the past. Due to this nonstandard namespace, Islandora instances that make use of namespace restrictions will need to enable the "ir" namespace in order for the cmodels to work.

Sherpa/RoMEO

Another feature in Scholar Core is Sherpa/RoMEO integration, which can be used to retrieve the copyright & self-archiving policies of various academic publishers. In order to use this feature you must first configure it in the Scholar configuration menu at '

Configuring Islandora Scholar

...

admin/islandora/solution_pack_config/scholar

...

Image Removed

 

At the top-right there should be three tabs:

Image Removed

 

The DOI Importer configuration page looks like the screenshot below, and contains options for configuring the DOI importer.

Image Removed

 

The PDF Importer configuration page looks like the screenshot below, and contains options for configuring the way PDFs work on the site:

Image Removed 

  • RIS Importer - Creates citation objects from RIS files
  • CSL - Allow for the storage/retrieval/validation of CSL 1.0.1 styles 
    • Add new CSL styles at admin/islandora/tools/csl

Image Removed

  • Pubmed Importer - Creates citation objects from Pubmed IDs
  • Endnote XML Importer - Creates citation objects from Endnote XML

...

' by checking the "Enable RoMEO attempts" checkbox and providing a Sherpa/RoMEO API key. It will also only work on objects that have an identifier field with the type "ISSN" in their MODS record. Once properly set up, Islandora Scholar will use an object's ISSN number to query Sherpa/RoMEO's database of publishers and return the host publisher's copyright/self-archiving policy which shows up in the object's display.

Importers

Scholar provides options for importing objects from various sources. The RIS Importer and EndNoteXML Importer submodules allow users to take citation data files exported from other sources (such as RefWorks, EndNote or Zotero) and turn them into Islandora objects using the standard Islandora importer interface (similar to using the zip importer). The DOI Importer and PMID Importer submodules work in much the same way, but instead of using files exported by other citation managers they use Digital Object Identifier (DOI) or PubMed ID (PMID) strings.

Citation Collection & Citation Style Management

The Islandora Bibliography submodule extends the Islandora Bookmark module to allow it to handle collections of scholarly citations, which can be dynamically restyled with the help of the Citeproc and CSL submodules, as well as exported in RIS, RTF or PDF format with the Exporter submodule.

In order to access new citation styles, go to the Zotero CSL Repository and download whatever CSL files you want to use. You can then upload your CSL files using the CSL admin page at admin/islandora/tools/csl and choose a default style to display on your citation & thesis object pages. If you want your users to be able to dynamically choose any available citation style from the citation/thesis object display interface, make sure to check the "Let users choose display CSL" checkbox at the bottom of the Islandora Scholar admin page at admin/islandora/solution_pack_config/

...

scholar.

Google Scholar Integration

Getting indexed by Google Scholar is a primary concern for any institutional repository due to the extreme popularity of Google Scholar. Most people will get to the documents in your IR via Google Scholar, but Google Scholar has many requirements for repositories who want to be indexed. The Islandora Google Scholar submodule pulls relevant information from the MODS record of citation & thesis cmodels and turns it into meta tags and embeds it into the HTML of the display page. See the meta tags with the "citation_" prefix in the screenshot below:

Image Added

Reading embedded HTML meta tags in the head of an object's display page is the primary way that Google Scholar learns about your repository and its contents, so this relatively small submodule is actually one of the most important features of Scholar!

Scholar Embargoes

The Scholar Embargo submodule is very similar (and can even be used in conjunction with) the Islandora IP Embargo module. Scholar Embargo allows you to suppress the display of objects in collections entirely, or allow the objects to display but disable a specified datastream on an object. Embargoes may be indefinite (meaning that they will persist until manually lifted) or temporary (meaning that they will persist until the specified expiration date chosen by an administrator, with email notifications 10 days before and on the day of an embargoes expiration).

The two primary types of embargoes are object embargoes and datastream embargoes. Objects with an "object embargo" will behave as if they don't exist for public users; they won't display in collections or search results, and will yield an access denied page when public users attempt to access them directly by PID. Only privileged users will be able to see them (more on that below). Datastream embargoes allow the object to display normally in collections and search results, but a particular datastream (specified when the embargo is placed) will be unavailable to public users to view or download. For citation and thesis objects this will be the 'PDF' datastream, but Scholar Embargoes can be applied to any content model, extending the list of possible datastreams. In order to put a Scholar Embargo on content models other than citations and theses, you must enable them from the "Embargo Settings" tab of the Islandora Scholar Embargoes admin menu at admin/islandora/solution_pack_config/embargo (example below).

Image Added

You may also use the "Manage Embargoed Items" tab in the Islandora Scholar Embargo admin menu to see all objects that are currently under embargo (very useful!).

Image Added

It is worth noting that the current best practice in the world of institutional repositories seems to be exposing the object display and metadata, but blocking the viewing or downloading of the full text record (typically a PDF file). This is so users can know what information is in the system through collection displays or search results, even if the system blocks them from fully accessing it. Many faculty and students like to check to make sure their records are in the repository and still embargoed, and when they can't find their record they may misunderstand and think it hasn't been loaded.

In order to manage embargoes on objects, you must grant the "Manage embargo on any objects" permission to the appropriate user roles under the Islandora Scholar Embargo section of admin/people/permissions. This will allow a user to place object and datastream embargoes on objects, as well as remove or update datastream embargoes. Due to issues with the connection between Drupal permissions and the way Scholar Embargo implements its embargo policies through XACML, currently only the object's owner will be able to remove or update object embargoes even if a user has the "Manage embargo on any objects" permission. This is because the XACML policy works independently of Drupal permissions, and the embargo XACML policy will block everyone except the object's owner from managing the object at all once embargoed. A fix for this is in the works and should be part of the Islandora 7.x-1.8 release.

 

...

On the main page, you can set the content models for objects to be embargoed. When a content model is selected, users will be provided with the option of setting a date for the embargo to be lifted, or to embargo an object indefinitely. 

Image Removed

 

From a tab at the upper right tab you can manage embargoed objects:

Image Removed

 

On this tab a table will show you a list of objects that are currently embargoed:

Image Removed

 

  • Islandora Google Scholar - Provides meta tags to help indexing in Google Scholar and Zotero
  • Citation Exporter - Exports a collection of citations to either an RIS/RTF/PDF file
  • DOI Importer - Creates citation objects from DOIs (requires registration with CrossRef)

...