Extension:Citoid

MediaWiki extensions manual

Citoid Release status: stable
Implementation	User interface
Description	Enables the Citoid service to be used within VisualEditor .
Author(s)	Marielle Volz Moriel Schottlender Ed Sanders
Latest version	0.3.0
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.
Parameters $wgCitoidFullRestbaseURL $wgWBCitoidFullRestbaseURL $wgCitoidServiceUrl $wgCitoidIsbnScannerEnabled
Hooks used BeforePageDisplay GetPreferences ResourceLoaderGetConfigVars
License	MIT License
Download	Download extension Git [?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball
Translate the Citoid extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

Citoid is a MediaWiki extension that enables the Citoid service, which generates a citation given a URL or other identifier, to be used within VisualEditor .

This page covers only how to download and install the Citoid extension; for all information on how to actually use Citoid, please see the Citoid page.

Prerequisites

In order to run this extension, you must have the following required extensions installed:

• VisualEditor
• TemplateData
• Cite

The following additional extensions are not required to run Citoid, but are recommended if you have imported citation templates from one of the Wikipedias:

• Scribunto
• TemplateStyles
• ParserFunctions

Installation

• Download and move the extracted Citoid folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:

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

• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'Citoid' );
  

• Configure as required.
• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

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

// If the wiki is being served over https, the https protocol is required in the citoid service URL; otherwise the browser will block the request.
$wgCitoidServiceUrl = 'http://localhost:1970';

Option	Default value	Useful for…	Documentation
$wgCitoidServiceUrl	false	Sysadmins	Full or relative url where citoid is deployed with no trailing slash i.e. http://localhost:1970 , https://en.wikipedia.org/api/rest_v1/data/citation, or /api/rest_v1/data/citation For version of mediawiki 1.44.0 and above, the trailing /api in http://localhost:1970/api will be ignored as the restful pattern is supported naively as of citoid 1.2.0; older configs should be updated to remove the trailing /api as backwards compatibility may be removed at some point. If your version of citoid < 1.2.0, you must use versions of mediawiki < 1.44.0, as higher versions are not compatible.
Deprecated $wgCitoidFullRestbaseURL	false	Sysadmins	Despite its name, full or relative partial url to use a citoid service running behind restbase or using a restful pattern, excluding the restbase version number i.e. https://en.wikipedia.org/api/rest_ or /api/rest_ (including the trailing _). On Wikimedia wikis, Citoid is now served behind Rest Gateway and not Restbase so "restbase" is currently a misnomer. This config is deprecated since 1.46 and you should use $wgCitoidServiceUrl instead.