citoid

From MediaWiki.org
Jump to: navigation, search

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[edit | edit source]

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

Install and configure Zotero's translation server[edit | edit source]

See: Translation-server installation instructions

Install and configure citoid service[edit | edit source]

Get the code[edit | edit source]

If you want to do an anonymous checkout:

git clone https://gerrit.wikimedia.org/r/p/mediawiki/services/citoid

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

git clone ssh://<user>@gerrit.wikimedia.org:29418/mediawiki/services/citoid

Nodejs[edit | edit source]

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.

sudo apt-get install nodejs npm
nodejs --version # should now print v0.10.x Note: not on Ubuntu Server 12.04 LTS, you end up with v0.6.x

For other systems, see:

JS dependencies[edit | edit source]

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

npm install

Create localsettings.js file[edit | edit source]

Copy localsettings.js.sample to localsettings.js

cp localsettings.js.sample localsettings.js

Run the server[edit | edit source]

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

node server.js

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

curl -d '{"url":"http://link.springer.com/chapter/10.1007/11926078_68", "format":"mediawiki"}' --header "Content-Type: application/json" localhost:1970/url

Install and configure Citoid user scripts[edit | edit source]

Users can make use of citoid user scripts 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 user script than can be used on English Wikipedia in conjunction with VisualEditor and a citoid service running on labs: CiteFromURL user script.

There is one user script for wikitext editing that can be used on English Wikipedia, also using the labs instance: Citoid Wikitext citations.

Install and configure Citoid extension[edit | edit source]

Warning: This feature is currently awaiting changes to Extension:TemplateData to work on all wikis. It currently only works on wikis using the following English Wikipedia templates: Wikipedia:Template:Citation, Wikipedia:Template:Cite web, Wikipedia:Template:Cite book, Wikipedia:Template:Cite journal, and Wikipedia:Template:Cite news.

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[edit | edit source]

  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[edit | edit source]

If you want to do an anonymous checkout:

git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/Citoid

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

git clone ssh://<user>@gerrit.wikimedia.org:29418/mediawiki/extensions/Citoid

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

require_once("$IP/extensions/Citoid/Citoid.php");

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

// Service doesn't need a security certificate, but the https 
// protocol is required in the URL for it to work in FireFox
$wgCitoidServiceUrl = 'https://localhost:1970';

Design and implementation[edit | edit source]

API[edit | edit source]

Currently, to request metadata about a url, use the url endpoint and provide the parameters "url" and "format". "url" will take any URI, including those without protocol (urls with no protocol specified are queried as http). "Format" will take "zotero", "mediawiki" and "mwDeprecated."

For more, see Citoid/API

Current design[edit | edit source]

  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.

Roadmap[edit | edit source]

For more, see Citoid/Roadmap

Planned service improvements[edit | edit source]

A number of improvements to the service are planned. Contributions are welcome! If any of these strike your fancy, please go ahead and do it! Development speed is generally slow so it's unlikely you'll overlap, but if you are worried about overlap feel free to use the talk page, or ping User:Mvolz, on IRC as well.

  • Implement Open Graph in scrape.js (possibly using npm open-graph) .
  • In server.js, add additional endpoint for DOI and /search endpoint that will return a list of results for search terms

including URL, DOI, and title

  • Additional export formats such as "csl", "bibtex" etc- essentially anything zotero has translators for.
  • Serve HTML pages for testing purposes, and automate tests (i.e. check that scrape.js gives the expected output)
  • Make all methods follow the error first best practice and remove try/catch error catching, see Node.js best practices.

Related extensions and services[edit | edit source]