Skip to content

Widget to generate and display a citation based on a DOI in any web page, using the Crosscite Citation Formatter (unsupported).

License

Notifications You must be signed in to change notification settings

datacite/citation-widget

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

citation-widget

Widget to generate and display a citation based on a DOI in any web page, using the Crosscite Citation Formatter. Optionally adds schema.org JSON-LD metadata to the head element of the same page using Content negotiation.

NOTE: The code is for example purposes and is not among DataCite's officially supported tools and services. This code is available "as is", without guarantee that it will be maintained in the future.

Widget setup

Pre-requisites

  • You have a live website, and have access to add/edit HTML code including <script> tags on the page that you would like to embed the widget into
  • You are able host the citation-widget.js on your server, or copy the source code into your page.

Note: you cannot link to the .js file on github, as github will prevent it being loaded.

Basic setup

Copy and paste the code below into a page on your website that you'd like the widget to appear on. Edit the code to include your ORCID API client ID and the URL of the page that you've pasted the code into.

<script src="http://[YOUR SERVER LOCATION FOR THE SCRIPT]/citation-widget.js"></script>
<div id="citation" data-doi='[THE DOI THAT YOU WOULD LIKE TO GENERATE A CITATION FOR]' data-generate-schema='true'></div>

If you cannot host the .js file, then you can copy and paste the contents of citation-widget.js in between the script tags.

Configuration options

The following configuration options are available and can be added to the div tag as data- tag attributes.

Tag attribute Allowed values Default Description
data-doi Required Full DOI URL or prefix/suffix only
data-generate-schema true, false Set to true if you would like to insert schema.org metadata into the head of your web page. This should be used in DOI landing pages only. For more information, see https://support.datacite.org/docs/how-do-i-expose-my-datasets-to-google-dataset-search

Example

An example is in citation-widget.html. To view it, clone this repository locally and open citation-widget.html in a browser.

About

Widget to generate and display a citation based on a DOI in any web page, using the Crosscite Citation Formatter (unsupported).

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published