Extension:Cite/Special:Cite.php

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
Cite

Release status: stable

Implementation Special page
Description Adds a special page that provides different citation formats for a particular article
Author(s) Ævar Arnfjörð Bjarmasontalk
Latest version continuous updates
MediaWiki 1.13+
PHP 5.3+
Database changes No
License GPL
Download
Hooks used
SkinTemplateBuildNavUrlsNav_urlsAfterPermalink

SkinTemplateToolboxEnd

Translate the Cite/Special:Cite.php extension if possible

Check usage and version matrix; code metrics

SpecialCite.php is a Cite extension that creates a special page (Special:Cite) and in the main namespace, a toolbox link to it. Given an article name, this extension generates citations to it in a variety of styles.

Synopsis[edit | edit source]

  • Special:Cite/Pagename
  • Special:Cite&page=Pagename&id=number

Example[edit | edit source]

English Wikipedia:

en:Special:Cite/Train provides citation info about the article en:Train, in the format specified by the local English MediaWiki file en:MediaWiki:Cite text

Download[edit | edit source]

You can download the extension directly from the MediaWiki source code repository (browse code). You can get:

One of the extensions tags

Not all extensions have tags. Some extensions have tags for each release, in which case those tags have the same stability as the release. To download a tag

  • Go to the tags list
  • Click the name of the tag you want to download
  • Click "snapshot"
The latest version of one of the extensions branches

Each extension has a master branch containing the latest code (might be unstable). Extensions can have further branches as well.

  • Go to the branches list
  • Click the branch name
  • Click "snapshot"
A snapshot made during the release of a MediaWiki version.

This might be unstable and is not guaranteed to work with the associated MediaWiki version.

After you've got the code, save it into the extensions/Cite directory of your wiki.

If you are familiar with git and have shell access to your server, you can obtain the extension, with all its tags and branches, as follows:

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

Installation[edit | edit source]

This extension is bundled with MediaWiki 1.21 and above. Thus you do not have to download it again.
  • Download and extract the files in a directory called Cite in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository.
  • Add the following code at the bottom of your LocalSettings.php:
require_once( "$IP/extensions/Cite/Cite.php" );
require_once "$IP/extensions/Cite/SpecialCite.php";
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Description[edit | edit source]

Cite is a special page extension that adds a special page Special:Cite, see w:en:Special:Cite. Here a pagename can be filled in, or one can directly use

Special:Cite/pagename

Each normal page (current version only) has a sidebar link to that special page, in addition to the link "permanent link".

The citing style it uses is customizable from the MediaWiki namespace (MediaWiki:Cite_text), for instance:

* ''{{FULLPAGENAME}}'' (last modified {{CURRENTTIME}}, {{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} UTC).
{{SITENAME}}, {{int:sitesubtitle}}. Retrieved <citation>{{CURRENTTIME}}, {{CURRENTDAY}} {{CURRENTMONTHNAME}}
{{CURRENTYEAR}}</citation> from {{fullurl:{{FULLPAGENAME}}|oldid={{REVISIONID}}}}

Might produce:

Main Page (last modified 02:47, 26 November 2005 UTC). Wikipedia, The Free Encyclopedia. Retrieved 21:14, 26 November 2005 from http://en.wikipedia.org/w/index.php?title=Main_Page&oldid=10403

Variables[edit | edit source]

The parser variables e.g. {{CURRENTTIME}}, {{CURRENTMONTH}} etc. will display the time of the last edit to the requested page, to get the current time use <citation>, e.g. <citation>{{CURRENTMONTH}}</citation>.