Extension:Citoid
 Release status: stableCategory:Stable extensions |
|
|---|---|
| Implementation | User interfaceCategory:User interface extensions |
| Description | Enables the Citoid service to be used within VisualEditor. |
| Author(s) | |
| Latest version | 0.3.0 |
| Compatibility policy | Snapshots releases along with MediaWiki. Master is not backward compatible.Category:Extensions with release branches compatibility policy |
| Composer | mediawiki/citoid Category:Extensions supporting Composer |
| License | MIT License |
| Download | Category:Extensions in Wikimedia version control |
|
|
| Quarterly downloads | 4 (Ranked 86th) |
| 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 following required extensions installed:
The following additional extensions are not required to run Citoid, but are recommended if you have imported citation templates from one of the Wikipedias:
Installation
- Download and move the extracted
Citoidfolder to yourextensions/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 |
$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 and you should use $wgCitoidServiceUrl instead. |
 | This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |
 | This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |