annotator-meltdown-zotero by emory-lits-labs

Overview

Search for and include Zotero citations in annotator.js annotations edited with annotator-meltdown. This plugin uses the Zotero web API to search for items and embed them in your annotation. It will add an editable in-text citation link, and a works cited with a full, structured citation generated by Zotero. When annotations are saved, a structured version of each identifiable citation (currently in TEI) will be added to the annotation as extra data.

The calling application is responsible for providing user or group ids and access tokens to the plugin.

See how it works in this simple demo.

Don't have a Zotero account yet?

Installation

This annotator plugin requires some additional javascript and CSS dependencies. A minified version of the combined javascript and CSS dependencies excluding Bootstrap are provided for convenience.

Include the appropriate CSS and Javascript files:

<!-- font awesome -->
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css"/>
<!-- bootstrap -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js" integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous">
<!-- annotator-meltdown -->
<script type="text/javascript" src="http://emory-lits-labs.github.io/annotator-meltdown/build/0.3.0-pre/annotator.meltdown.min.js"></script>
<link rel="stylesheet" type="text/css" href="http://emory-lits-labs.github.io/annotator-meltdown/build/0.3.0-pre/annotator.meltdown.min.css" />
<!-- annotator-meltdown-zotero -->
<script type="text/javascript" src="http://emory-lits-labs.github.io/annotator-meltdown-zotero/build/0.1.0/annotator.meltdown.zotero.min.js"></script>
<link rel="stylesheet" type="text/css" href="http://emory-lits-labs.github.io/annotator-meltdown-zotero/build/0.1.0/annotator.meltdown.zotero.min.css" />

To use this plugin in your Annotator project, configure annotator-meltdown as documented and then include the annotator-meltdown-zotero module and configure it with user or group id and tokens, as appropriate for your use.

    var app = new annotator.App();
    app.include(annotator.ui.main,{
      viewerExtensions: [
        annotatormeltdown.viewerExtension
      ],
      editorExtensions: [
        annotatormeltdown.getEditorExtension({min_width: '500px'})
      ]
    })
    .include(annotatorMeltdownZotero, {  // enable annotator-meltdown-zotero
        // specify *either* a group id or a user id; provide a token for private access
        // group_id:  ,
        // user_id: ###, token: '',
        // disabled_message: 'optional custom message could go here',
    });
    app.start();

Dependencies

annotator-meltdown (and all of its dependencies)
jquery.rest
bootstrap for modal window
jquery-ui for autocomplete

Authors and Contributors

Created by Rebecca Sutton Koeser (@rlskoeser), 2016. Originally developed for readux.