mediawiki.org

Extension:Cite - MediaWiki

This page documents the extension. For how to use it, see help on citing.

This extension comes with MediaWiki 1.21 and above. Thus you do not have to download it again. However, you still need to follow the other instructions provided.

MediaWiki extensions manual
Cite
Release status: stable
Implementation Tag
Description Allows footnotes for citing sources and helps for correctly citing content in offline media
Author(s) Ævar Arnfjörð Bjarmasontalk
Latest version Continuous updates
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.34+
PHP 7.0+
License GNU General Public License 2.0 or later
Download
Help Help:Extension:Cite
Example Wikipedia:Footnotes
  • $wgCiteDefaultBacklinkAlphabet
  • $wgCiteReferencePreviewsConflictingNavPopupsGadgetName
  • $wgCiteResponsiveReferencesThreshold
  • $wgCiteResponsiveReferences
  • $wgCiteSubReferencing
  • $wgCiteBacklinkCommunityConfiguration
  • $wgCiteReferencePreviews
  • $wgCiteUseLegacyBacklinkLabels
  • $wgCiteVisualEditorOtherGroup
  • $wgCiteReferencePreviewsConflictingRefTooltipsGadgetName
Quarterly downloads 282 (Ranked 14th)
Public wikis using 14,146 (Ranked 6th)
Translate the Cite extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The Cite extension allows a user to create references as footnotes on a page. It adds two parser hooks to MediaWiki, ‎<ref> and ‎<references />; these operate together to add citations to pages.

See the help page for using the Cite extension for further information.

  • Download and move the extracted Cite 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/Cite
  • Add the following code at the bottom of your LocalSettings.php file: 
    wfLoadExtension( 'Cite' );
  • Configure as required.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.


Vagrant installation:

  • If using Vagrant, install with vagrant roles enable cite --provision
$wgCiteBookReferencing

Enables an experimental feature for sub-references when set to true, see the help page. Default value: false

$wgCiteResponsiveReferences

Default setting for responsive display of references. When set to true, the references section will be displayed in multiple columns. See the usage documentation. Default value: true

$wgCiteVisualEditorOtherGroup

When set to true, the Cite toolbar button can be moved under the Insert menu. This is used on Wikivoyage sites. See the original feature request. Default value: false.

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.