primo-explore-hathitrust-availability

Features

When search results are displayed, a record's OCLC numbers are passed to the HathiTrust Bib API. If at least one item with free full-text access is found, a link to the HathiTrust record is appended to the availability section.

$3

!screenshot

Install

1. Make sure you've installed and configured primo-explore-devenv.
2. Navigate to your template/central package root directory. For example:
``
cd primo-explore/custom/MY_VIEW_ID
`
3. If you do not already have a package.json file in this directory, create one:
`
npm init -y
`
4. Install this package:
`
npm install primo-explore-hathitrust-availability --save-dev
`

Usage

Once this package is installed, create a file 'custom.module.js' and add hathiTrustAvailability as a dependency
for your custom module definition, and then add the hathi-trust-availability directive to the prmSearchResultAvailabilityLineAfter component. For example:

`javascript
var app = angular.module('viewCustom', ['hathiTrustAvailability']);

app.component('prmSearchResultAvailabilityLineAfter', {
template: ''
});
`
Note: If you're using the --browserify build option, you will need to first import the module with:

`javascript
import 'primo-explore-hathitrust-availability';
`

The idea here is to allow multiple custom components to be added to the prmSearchResultAvailabilityLineAfter rather than attempting to redefine it.

$3


The default availability message is "Full Text Available at HathiTrust". You can override this by setting the msg attribute:

`html
>
`

$3


By default, the component will display full-text links for any resource. If you want it avoid looking for full-text availability on records for which you already have an online copy, you can add a hide-online=tue attribute to the component:

`html

`

As of version 2.6 you can optionally suppress full-test links for journals:

`html

`

$3

If you want to display full-text links to any HathiTrust record, regardless of copyright status, use the ignore-copyright attribute:

`html

`

If you're a partner institution and you want the availability links to use HathiTrust's automatic login, add your SAML IdP's entity ID:

`html
ignore-copyright="true"
entity-id="https://shibboleth.umich.edu/idp/shibboleth"
>
`

Notes


* If you have custom ccs give it a name other than 'custom1.css' so it is not overwritten.
* See instructions in primo-explore-devenv on running locally
* To deploy: run gulp create-package to create a primo compatible package and upload your view in the interface.

Development

$3

1. Clone the repo
2. Run npm install
3. Run npm test`