Extension:Cite/Cite.php


 * ''This page is about the extension. See also Help:Footnotes, and Wikipedia:Footnotes for the use in the English Wikipedia.

Cite.php is a Cite extension that adds two parser hooks to MediaWiki,  and  ; these operate together to add citations to pages.

Installation

 * 1) Create a directory called Cite under the existing extensions directory. Place Cite.php, Cite.i18n.php and Cite_body.php extension files in the extensions/Cite directory. You can do so by checking it out from the subversion repository directly:   If you are using MediaWiki version 1.9 or older, use this command instead: This will download an earlier version of Cite.php.
 * 2) Add the following line to LocalSettings.php:

Note: The require_once line needs to be placed near the end of the file. At the end of the configuration but above the closing PHP tag ?> NB It also appears that in some installations this line can't be the very last line before the closing PHP tag. It didn't work for at least one user when it was, but worked fine when it was moved just a few lines higher (above some pre-existing statements). At least one other user, on MediaWiki 1.12, successfully installed this extension with the require_once line as the last line.

Note: Cite.php requires hooks in the main MediaWiki code found in HEAD as of 2005-12-24 23:05:18Z It might operate on earlier versions of MediaWiki, but it won't be operating properly.

Usage
The basic concept of the &lt;ref> tag is that it inserts the text enclosed by the ref tags as a footnote in a designated section, which you indicate with the placeholder tag &lt;references />. The new format cannot be used interchangeably with the old format - you must pick one or the other.

If you forget to include &lt;references /> at the end of the article, or else none of the footnotes will appear.

This page itself uses footnotes, such as the one at the end of this sentence. If you [ view the source] of this page by clicking "Edit this page", you can see a working example of footnotes.

Example
 According to scientists, the Sun is pretty big. &lt;ref>E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.&lt;/ref> The Moon, however, is not so big. &lt;ref>R. Smith, "Size of the Moon", Scientific American, 46 (April 1978): 44-6.&lt;/ref> &#61;=Notes== '''&lt;references/> 

Multiple uses of the same footnote
To give a footnote a unique identifier, use &lt;ref name="name">. You can then refer to the same footnote again by using a ref tag with the same name. The text inside the second tag doesn't matter, because the text already exists in the first reference. You can either copy the whole footnote, or you can use a terminated empty ref tag that looks like this: &lt;ref name="name" />.

In the following example, the same source is cited three times.

 This is an example of multiple references to the same footnote. &lt;ref name&#61;"multiple">Remember that when you refer to the same footnote multiple times, the text from the first reference is used.&lt;/ref> Such references are particularly useful when citing sources, if different statements come from the same source. &lt;ref name&#61;"multiple">This text is superfluous, and won't show up anywhere. We may as well just use an empty tag.&lt;/ref> A concise way to make multiple references is to use empty ref tags, which have a slash at the end. Although this may reduce redundant work, please be aware that if a future editor removes the first reference, this will result in the loss of all references using the empty ref tags. &lt;ref name&#61;"multiple" /> &#61;=Notes== &lt;references/> </tt>

The text above gives the following result in the article (see also section below): This is an example of multiple references to the same footnote. Such references are particularly useful when citing sources, when different statements come from the same source. A concise way to make multiple references is to use empty ref tags, which have a slash at the end. Although this may reduce redundant work, please be aware that if a future editor removes the first reference, this will result in the loss of all references using the empty ref tags.

&lt;references /&gt;
Placing  inserts the full text of all pending inline citations defined by , anywhere on the page. For example, based on the citations above, the code:

will yield:

, which incorporates. It provides an optional parameter to display the reference list in multiple columns. For instance, the English, Hindi and Interlingua Wikipedias use the css selector  to make the reference text smaller than normal text.

Grouped references
This may be disabled by  if desired. However, it is enabled on the foundation wikis.

Example
 According to scientists, the Sun is pretty big &lt;ref>E. Miller, The Sun, (New York: Academic Press, 2005), 23-5.&lt;/ref>. In fact, it is very big &lt;ref group="footnotes">Take their word for it. Don't look directly at the sun!&lt;/ref>. &#61;=Notes== '''&lt;references group="footnotes"/> &#61;=References== '''&lt;references/> </tt> The anonymous group works as before, while the named group reference will show up as.

Customization
The format of the output of  and   is almost completely customizable through MediaWiki messages, that can be modified, for example, through the MediaWiki namespace depending on the configuration of the wiki.

For a list of messages that control the output of  and   and the values, if any, that are passed to them ($1, $2, $3 ...), see the code in CVS for an up-to-date listing of their default contents.


 * cite_reference_link_key_with_num
 * key
 * num
 * cite_reference_link_prefix
 * cite_reference_link_suffix
 * cite_references_link_prefix
 * cite_references_link_suffix
 * cite_reference_link
 * ref ID
 * backlink ID
 * count to display
 * cite_references_link_one
 * Used to format the source list that

The ^ replaces the up arrows and putting $3 in the last line between the sup /sup tags fixes the links w/ a b c... vice 2.1, 2.2, 2.3, etc...

Fatal error: Call to undefined function wfloadextensionmessages
Fatal error: Call to undefined function wfloadextensionmessages in /home/extensions/Cite/Cite.php on line 32.

This error was received once extension was added. $wgExtensionMessagesFiles works only with version 1.11. Update your version. or download 1.10 branches extensions

Apache error
PHP logs an error in the Apache error log: (MediaWiki 1.6.8, PHP 4.4.4, Apache 1.3.37) [error] PHP Notice: Use of undefined constant __METHOD__ - assumed '__METHOD__' in extensions/Cite/Cite.php on line 609 [error] PHP Notice: Use of undefined constant __METHOD__ - assumed '__METHOD__' in extensions/Cite/Cite.php on line 612
 * I was able to fix this by placing single quotes around __METHOD__</tt> on both lines (609 & 612)
 * This is because the __METHOD__ is only available since PHP 5, using '__METHOD__' is not a correct fix. --Løde

Version 1.6.8
It doesn't work with version 1.6.8! I eventually got cite.php working with "13660" but not "13826" versions. My error messages appeared at the top of the page:

Warning: Cannot modify header information - headers already sent by (output started at /****/wiki/extensions/Cite.i18n.php:399) in /****/OutputPage.php on line 575

Warning: Cannot modify header information - headers already sent by (output started at /****/wiki/extensions/Cite.i18n.php:399) in /****/wiki/includes/OutputPage.php on line 576

Misrendered anchor link character
??? appears in rendered pages instead of ↑ &mdash; it might be possible to fix this by replacing the up arrow character with &amp;#8593; (the corresponding HTML entity; rendered &#8593;). Alternatively, the caret (^) can probably be used as a substitute.

Templates

 * Using  in templates breaks numbering:Issue with MediaWiki regarding in what order things are parsed
 * Using  within a template will create correctly numbered reference mark but it will be missing from the output of a   on the calling page (example) unless the  references tag is transcluded too!
 * It's impossible to pass template arguments to, e.g.  :Issue with MediaWiki, see bug 4529
 * Template substitution misrenders inside  tag.

HTML parameters

 * The citation links generated by &lt;ref&gt; and the backlinks generated by &lt;references&gt; have an empty  attribute
 * Issue with MediaWiki, not this extension. MediaWiki will generate output like  when given input like


 * Missing name=</tt> anchors for backwards compatibility ( 5567 )
 * The generated &lt;a href="#_note-n"&gt;</tt> links should have a name="_ref-n"</tt>.
 * The generated &lt;a href="#_ref-n"&gt;</tt> links should have a name="_note-n"</tt>.
 * This currently seems to be working.

HTML commenting-out doesn't work
Commenting out  with HTML comments   hides the citation but the reference still appears on the list
 * This would appear to be a parser error…
 * Seems to be fixed with the new parser. —81.241.208.92 14:16, 2 February 2008 (UTC)

ParserFunctions
cite.php cannot be nested properly in ParserFunctions. For example, " " will return both "true" and "false" as references regardless of the result of the ParserFunction. However, ParserFunctions work perfectly inside &lt;ref&gt; tags.

Blank Special:Version

 * It seems that the following code causes v1.9.2's Special:version page to go blank:

'author' => 'Ævar Arnfjörð Bjarmason',
 * Changing it to this fixes it (apologies if it's 'translated' wrong):

'author' => 'AEvar Arnfjord Bjarmason',

Rendering
Contents of non-first named  are not rendered, even if all prior tags with same name are empty.

Missing preview
There is no preview for inline citations. This is especially annoying when editing only a section of a page. (Bug 5492)

Users without edit privileges can't see references if sysops can
The following combination of $wgGroupPermissions makes references invisible to users who aren't logged in (Bug 11224). This bug started sometime after Mediawiki 1.9.3. and persists to 1.11.0 $wgGroupPermissions['*']['edit'] = false; $wgGroupPermissions['sysop']['edit'] = true;

Workaround
A current work-around is to set $wgGroupPermissions['*']['edit'] = false; and not grant any editing rights to sysops. Users who are sysops would then need to be part of another group with editing privileges.

Partial fix available
This bug was partially fixed in revision 36333. Reinstall Cite.php and the references would become visible (thus the above workaround is not necessary). However, some bogus behaviour persists: all reference hyperlinks are linked to the first footnote below (instead of their corresponding numbers), and all backwards hyperlinks from footnotes jump to the first reference in the text (instead of their corresponding numbers).

Grouping references
If I do  Blah   Walla. </tt>, I get:
 * Blah [1][2][3][4] Walla.

instead of
 * Blah[1] – [4] Walla.

This should really be supported; it looks better and it's more normal. Other citation programs (like BibTeX) do this automatically, so it should be possible. --Slashme 06:50, 14 August 2008 (UTC)

Criticisms
The major criticism regarding Cite.php is that it renders the editing of references much more tedious. Moreover, because many casual Wikipedia users are not familar with the cryptic Wikitext tags that they find with the use of Cite.php, it is likely that the net effect of Cite.php is often to deter new users from making edits to reference sections. Although Wikipedia supposedly got its name from the Hawaiian word "wiki-wiki", meaning "quick-quick", Cite.php is arguably neither quick nor easy for the average Wikipedia user.


 * A possible solution would be to have the actual reference section contain all of the references with given names, then throughout the article, simply reference by name, instead of the full citation. This would also reduce confusion concerning multiple uses of a reference having different text, but only showing the first instance (causing confusion with sections are shifted around, the displayed reference might change, while the text hasn't). I.e.:

Some text that needs a ref. Another sentence that uses a ref, followed by another usage of the first ref.


 * Using cite.php makes citing page numbers harder. Each reference usually cites a different page of the book/journal/article, but there is no way to indicate a different page number when using a self-closing tag.  As such, all  simply refer to the work as a whole, rather than to a specific page number in the work (unless the author makes each page number a seperate reference).  Perhaps a future revision of cite.php could allow a page number argument to be passed to the reference like so .  This would dramatically increase the reputability of the citations, because they could then be checked/verified, and the citations would be a more useful resource.

Past problems

 * The extension didn't generate id attributes that could be uniformly styled with CSS2 attribute selectors: Issue in Cite.php, see bug 4579
 * Using multibyte characters, colons, spaces and other values that need to be encoded according to the HTML spec breaks internal links:Issue with MediaWiki, not this extension, see bug 4461.
 * Using  in image captions breaks the XHTML output:Issue with MediaWiki, not this extension, see bug 1887.

Comparing ref/note style and Cite.php style
They are actually very similar.


 * To make a single use footnote:
 * Ref/note
 *   at the in-text place.
 *  # text of note at the proper place in the Notes list.
 * Cite.php
 *   at the in-text place.
 * (Only needed once per article)  under the Notes heading.
 * To make a multiple use footnote:
 * Ref/note
 * With strict ref/note style this was impossible, but a number of alternative forms had been created, for the details of which, see the appropriate pages.
 * Cite.php
 *   at each in-text place.
 * Alternatively    A self-closing tag on every use after name=foo has been defined.
 * (Only needed once per article)  under the Notes heading; exactly the same as to make a single-use note.