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.
MediaWiki	>= 1.43
Composer	mediawiki/citoid
License	MIT License
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Parameters $wgCitoidFullRestbaseURL $wgWBCitoidFullRestbaseURL $wgCitoidServiceUrl $wgCitoidIsbnScannerEnabled
Hooks used BeforePageDisplay GetPreferences ResourceLoaderGetConfigVars
Quarterly downloads	24 (Ranked 116th)
Public wikis using	848 (Ranked 299th)
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 VisualEditor extension installed, and enable the VisualEditor citation tool .

The following additional extensions are not required to run Citoid, but are recommended:

• Scribunto
• TemplateStyles
• Cite
• TemplateData
• 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/api';

Option	Default value	Useful for…	Documentation
$wgCitoidServiceUrl	false	Sysadmins	Full url to use the native citoid api , i.e. http://localhost:1970/api. Only used if VisualEditorFullRestbaseURL is null.
$wgCitoidFullRestbaseURL	false	Sysadmins	Full url to use a citoid service running behind restbase, i.e. https://en.wikipedia.org/api/rest_ (including the trailing _). Overwrites default, which is to use VisualEditorFullRestbaseURL (now deprecated). Does not need to be set if you are running citoid behind the same restbase instance as parsoid/VisualEditor; mostly useful for point to a cross domain restbase citoid installation.