Citoid

Citoid is a node.js service which currently locates citation data given an URL. It has a companion extension of the same name which aims to provide use of the citoid service to VisualEditor. Neither the service nor the extension are presently production ready. Ultimately, the goal is for the citoid service to provide citations given any search term, such as URL, DOI, title of the work, etc.

Installation
Citoid requires a working installation of Zotero's translation server.

Install and configure Zotero's translation server
See: Translation-server installation instructions

Get the code
If you want to do an anonymous checkout:

Or if you plan to hack citoid, then please follow the Gerrit 'getting started' docs and use an authenticated checkout url instead, such as:

Nodejs
Install nodejs 0.10 and npm. When you are using Ubuntu and depending on OS version you will not end up with the most recent version of nodejs.

For other systems, see:
 * http://nodejs.org/download/
 * https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager
 * (debian squeeze, wheezy) https://gist.github.com/x-Code-x/2562576

JS dependencies
Install the JS dependencies. Run this command in the citoid directory:

Create localsettings.js file
Copy localsettings.js.sample to localsettings.js

Run the server
You should be able to start the citoid web service from the citoid directory using:

This will start the citoid service on port 1970. To test it, try a sample query:

Install and configure Citoid gadgets
Users can make use of citoid gadgets if user javascript is enabled on your wiki using the $wgAllowUserJs option. You can also install VisualEditor gadgets on a site-wide basis.

There is currently one gadget than can be used on English Wikipedia in conjunction with VisualEditor and a citoid service running on labs: CiteFromURL Gadget.

Install and configure Citoid extension
Warning: This feature is not ready for production.

In order to have citoid functioning on your wiki in conjunction with VisualEditor, you'll need the following: VisualEditor and Parsoid, VisualEditor's Citation Tool, and the Citoid extension.

It is recommended that you have the following extensions in your extension folder: Extension:VisualEditor, Extension:Scribunto, Extension:Cite, Extension:TemplateData, and Extension:ParserFunctions, and Extension:Citoid.

VisualEditor and Citation Tool

 * 1) Set up MediaWiki: Manual:Installation_guide
 * 2) Set up Parsoid: Parsoid/Setup
 * 3) Set up VisualEditor: Extension:VisualEditor
 * 4) Set up Citation Tool: VisualEditor/Citation tool

Citoid extension
If you want to do an anonymous checkout:

Or if you plan to hack citoid, then please follow the Gerrit 'getting started' docs and use an authenticated checkout url instead, such as:

Then add the following line to your wiki's  after you have downloaded the extension:

Set the location to your citoid service instance in your wiki's

Current design

 * 1) Queries Zotero translator-server for translator.
 * 2) If no translator found, follow a single redirect (for the case of shortened URLs- this is not done initially because in many cases the redirect will be to a log-in url).
 * 3) Query Zotero translator-server for translators again.
 * 4) If no translator found, send to a naive scraper that pulls out the title only.

Potential design
The following is a potential design and does not indicate what is currently implemented:

A rough description of how the service works is as follows:


 * 1) [client js] Front-end JS (i.e. VisualEditor) makes query for reference
 * 2) [node js] citoid considers cache and either responds with the previously stored result or…
 * 3) [third party] Query against third party APIs and return citation.

A rough implementation:


 * ISBN/ISSN: - > WorldCat Search API
 * DOI: -> Send accept header to CrossRef.
 * If 204, resolve URL and send to Zotero.
 * If 404 or 406, fail.
 * URL: -> If DOI, send to DOI: handler. Else, send to Zotero.
 * Other text -> WorldCat Search API

Related extensions and services

 * Zotero translation server -- xpcshell-based Zotero translation server, and https://github.com/zotero/zotero-node, an abandoned and old nodejs equivalent
 * Zotero field mappings, including vs. some cite templates
 * en:Category:Citation_templates
 * en:Help:Citation tools
 * VisualEditor/Citation tool
 * Sample cite-tool definition on Wikipedia Beta
 * Restface (node.js restful api)