Movatterモバイル変換

Help:Cite

From mediawiki.org

Languages:

Note: When you edit this page, you agree to release your contribution under theCC0. SeePublic Domain Help Pages for more info.
Some old revisions for this page were imported under CC BY-SA license. Only new contributions are PD.

Cite makes it possible to add footnotes to a page.

SeeExtension:Cite for technical details.

Usage

The basic concept of the‎<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‎<references/>.

Additional placeholder tags‎<references/> can be inserted in the text, and all‎<ref> tags up to that point, in that group, will be inserted there.

If you forget to include‎<references/> in the article, the footnotes will not disappear, but the references will be displayed at the end of the page.

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

Wikitext	Rendering
The Sun is pretty big.<ref>E. Miller,''The Sun'', (New York: Academic Press, 2005), 23–25.</ref> The Moon, however, is not so big.<ref>R. Smith, "Size of the Moon",''Scientific American'', 46 (April 1978): 44–46.</ref>==Notes==<references/>	The Sun is pretty big.^[1] The Moon, however, is not so big.^[2] Notes ↑E. Miller,The Sun, (New York: Academic Press, 2005), 23–25. ↑R. Smith, "Size of the Moon",Scientific American, 46 (April 1978): 44–46.

Wikitext

Rendering

The Sun is pretty big.<ref>E. Miller,''The Sun'', (New York: Academic Press, 2005), 23–25.</ref> The Moon, however, is not so big.<ref>R. Smith, "Size of the Moon",''Scientific American'', 46 (April 1978): 44–46.</ref>==Notes==<references/>

The Sun is pretty big.^[1] The Moon, however, is not so big.^[2]

Notes

↑E. Miller,The Sun, (New York: Academic Press, 2005), 23–25.
↑R. Smith, "Size of the Moon",Scientific American, 46 (April 1978): 44–46.

Multiple uses of the same footnote

To give a footnote a unique identifier, use‎<refname="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:‎<refname="name"/>.Names are unique within theirgroup, not global—that is, a reference‎<refgroup="note"name="source-a">...‎</ref>can only be re-used as‎<refgroup="note"name="source-a"/>.

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

Wikitext	Result
This is an example of multiple references to the same footnote.<refname="multiple">Remember that when you refer to the same footnote multiple times, the text from the first reference is used.</ref>Such references are particularly useful if different statements come from the same source.<refname="multiple"/> Any reused tag should not contain extra content, that will spawn an error. Only use empty tags in this role.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.<refname="multiple"/>==Notes==<references/>	This is an example of multiple references to the same footnote.^[1] Such references are particularly useful when citing sources, if different statements come from the same source^[1] Any reused tag should not contain extra content, that will spawn an error.Only use empty tags in this role. 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.^[1] Notes ↑^1.0^1.1^1.2Remember that when you refer to the same footnote multiple times, the text from the first reference is used.

Wikitext

Result

This is an example of multiple references to the same footnote.<refname="multiple">Remember that when you refer to the same footnote multiple times, the text from the first reference is used.</ref>Such references are particularly useful if different statements come from the same source.<refname="multiple"/> Any reused tag should not contain extra content, that will spawn an error. Only use empty tags in this role.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.<refname="multiple"/>==Notes==<references/>

This is an example of multiple references to the same footnote.^[1]

Such references are particularly useful when citing sources, if different statements come from the same source^[1] Any reused tag should not contain extra content, that will spawn an error.Only use empty tags in this role.

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.^[1]

Notes

↑^1.0^1.1^1.2Remember that when you refer to the same footnote multiple times, the text from the first reference is used.

Note that identifiers used in thename attribute require alphabetic characters; solely relying on numerals will generate an error message. Quotation marks are always preferred for names, and are mandatory when the name includes a space, punctuation or other mark. It is recommended that names be kept simple and restricted to the ASCII character set.

The`‎<references/>` tag

The‎<references/> tag inserts the text of all the citations which have been defined in‎<ref> tags up to that point in the page.For example, based on the citations above, there should be reference for thenote group.

Wikitext	Result
<referencesgroup="note"/>	↑This footnote is used as an example in the "Usage" section.

The reference listcan have a responsive width (displaying in some cases the references in several columns).In that case, theresponsive attribute is used to configure that behavior.On wikis with the default configuration, this will happen on every page; on others, you need to activate it. On wikis with the default configuration, the responsive behavior can be disabled with<referencesresponsive="0"/>.

If a page includes more than one‎<references/> list, each list includes the‎<ref> tags defined after the previous references list.If these references lists are produced by templates, each one lists the ref tags defined before the first references list, and there is an error message saying that there is a ref tag but not a references list.

Grouped references

This may be disabled by$wgAllowCiteGroups=false; if desired.

The following example generates separate reference lists for citations and miscellaneous footnotes:

Wikitext	Result
According to scientists, the Sun is pretty big.<ref>E. Miller,''The Sun'', (New York: Academic Press, 2005), 23–25.</ref> In fact, it is very big.<refgroup="footnotes"> Take their word for it. Don't look directly at the sun!</ref>==Notes==<referencesgroup="footnotes"/>==References==<references/>	According to scientists, the Sun is pretty big.^[1] In fact, it is very big.^{[footnotes 1]} Notes ↑ Take their word for it. Don't look directly at the sun! References ↑E. Miller,The Sun, (New York: Academic Press, 2005), 23–25.

Wikitext

Result

According to scientists, the Sun is pretty big.<ref>E. Miller,''The Sun'', (New York: Academic Press, 2005), 23–25.</ref> In fact, it is very big.<refgroup="footnotes"> Take their word for it. Don't look directly at the sun!</ref>==Notes==<referencesgroup="footnotes"/>==References==<references/>

According to scientists, the Sun is pretty big.^[1] In fact, it is very big.^{[footnotes 1]}

Notes

↑ Take their word for it. Don't look directly at the sun!

References

↑E. Miller,The Sun, (New York: Academic Press, 2005), 23–25.

The anonymous group works as before, while references destined for the named group will only show up in the designated‎<references/> element.

Note that identifiers used in thegroup attribute require alphabetic characters; solely relying on numerals will generate an error message. Quotation marks are always preferred for names, and are mandatory when the name includes a space, punctuation or other mark. It is recommended that names be kept simple and restricted to the ASCII character set.

The rendering of a given group can be customized across the wiki by creatingMediaWiki:Cite_link_label_group-<name> and listing the used signs in the order they appear, separated by spaces or newlines.

For example, ifMediaWiki:Cite_link_label_group-lower-alpha is created with the content

a b c d e f g h i j k l m n o p q r s t u v w x y z

then the first<refgroup="lower-alpha">...</ref> renders^[a], the second one renders^[b], and so on, the 26th renders^[z].

Attempting to use more footnotes in a custom-rendered group than the number of signs defined will fall back to the numeric labels. The 27th will render as simply^[1.27], and so on.

The following group names are often defined as custom groups by the following messages respectively:

group name	message
`upper-alpha`	MediaWiki:Cite link label group-upper-alpha
`lower-alpha`	MediaWiki:Cite link label group-lower-alpha
`upper-roman`	MediaWiki:Cite link label group-upper-roman
`lower-roman`	MediaWiki:Cite link label group-lower-roman
`lower-greek`	MediaWiki:Cite link label group-lower-greek

TheCite link label group pages arenot created by default. If a wiki does not configure them, markup such as<refgroup="lower-alpha">...</ref> will render as^{lower-alpha 1}.

Citing different parts of the same source

When several parts from the same work are used as references in an article, you can cluster them in the reference section.This gives readers a way to identify which references originate from the same source.It also allows you to cite different parts of the same source without repeating the entire source every time.

Wikitext	Result
According to scientists, the Sun is pretty big.<refname="Miller">E. Miller,''The Sun'', (New York: Academic Press, 2005).</ref> In fact, it is very big.<refname="Miller"details="p. 123"</ref> Take their word for it. Don't look directly at the sun!<refname="Miller"details="p. 42"/>==References==<references/>	According to scientists, the Sun is pretty big.^[1] In fact, it is very big.^[1.1] Take their word for it. Don't look directly at the sun!^[1.2] References 1. E. Miller,The Sun, (New York: Academic Press, 2005) 1.1 ↑ p. 123 1.2 ↑ p. 42

Wikitext

Result

According to scientists, the Sun is pretty big.<refname="Miller">E. Miller,''The Sun'', (New York: Academic Press, 2005).</ref> In fact, it is very big.<refname="Miller"details="p. 123"</ref> Take their word for it. Don't look directly at the sun!<refname="Miller"details="p. 42"/>==References==<references/>

According to scientists, the Sun is pretty big.^[1] In fact, it is very big.^[1.1] Take their word for it. Don't look directly at the sun!^[1.2]

References

1. E. Miller,The Sun, (New York: Academic Press, 2005)
1.1 ↑ p. 123
1.2 ↑ p. 42

This feature doesn't yet work on wikis outside testwiki,German Wikipedia and the beta cluster, which is why the above example is a mock. You can follow the project update atm:WMDE Technical Wishes/Sub-referencing.

Separating references from text

In-text references make it easy to copy the text to another page; on the other hand, they make it hard to read.References containing a lot of data, quotes or elaborate citation templates can make up a significantly larger fraction of the source than the text that will actually be visible.To avoid this, you can move some or all of the references into the‎<references/> section, to the place where they will actually appear to the reader.

Wikitext	Result
According to scientists, the Sun is pretty big.<refname="miller"/> The Moon, however, is not so big.<refname="smith"/>==Notes==<references><refname="miller">E. Miller,''The Sun'', (New York: Academic Press, 2005), 23–25.</ref><refname="smith">R. Smith, "Size of the Moon",''Scientific American'', 46 (April 1978): 44–46.</ref></references>	According to scientists, the Sun is pretty big.^[1] The Moon, however, is not so big.^[2] Notes ↑E. Miller,The Sun, (New York: Academic Press, 2005), 23–25. ↑R. Smith, "Size of the Moon",Scientific American, 46 (April 1978): 44–46.

Wikitext

Result

According to scientists, the Sun is pretty big.<refname="miller"/> The Moon, however, is not so big.<refname="smith"/>==Notes==<references><refname="miller">E. Miller,''The Sun'', (New York: Academic Press, 2005), 23–25.</ref><refname="smith">R. Smith, "Size of the Moon",''Scientific American'', 46 (April 1978): 44–46.</ref></references>

According to scientists, the Sun is pretty big.^[1] The Moon, however, is not so big.^[2]

Notes

↑E. Miller,The Sun, (New York: Academic Press, 2005), 23–25.
↑R. Smith, "Size of the Moon",Scientific American, 46 (April 1978): 44–46.

Thus, the code above will have the same output as thefirst example above, although the numbering and order of the references will not in general be the same.

If agroup is set with‎<referencesgroup>, it doesnot also need to be specified on each child‎<ref/>.

Substitution and embedded parser functions

Since Cite's‎<ref> tag is parsed before MediaWiki's parser functions (e.g.{{#ifexpr:…}}) or variables (e.g.{{PAGENAME}}) or beforesubst:, these will not work inside of citation references.Instead, you have to use themagic word{{#tag:…}}.

Wikitext	Result
Foo<ref>This is not working, see{{cite journal\|url=https://www.google.com\|author=\|date=\|accessdate={{subst:#time:Y-m-d\|now}}\|title=Search}}</ref> bar baz…Foo{{#tag:ref\|Whereas this does, see{{cite journal\|url=https://www.google.com\|author=\|date=\|accessdate={{subst:#time:Y-m-d\|now}}\|title=Search}}}} bar baz…<references/>	Foo^[1] bar baz…Foo^[2] bar baz… ↑This is not working, see"Search" . Retrieved on [[{{subst:#time:Y-m-d\|now}}]]. ↑Whereas this does, see"Search" . Retrieved on2021-03-11.

Wikitext

Result

Foo<ref>This is not working, see{{cite journal|url=https://www.google.com|author=|date=|accessdate={{subst:#time:Y-m-d|now}}|title=Search}}</ref> bar baz…Foo{{#tag:ref|Whereas this does, see{{cite journal|url=https://www.google.com|author=|date=|accessdate={{subst:#time:Y-m-d|now}}|title=Search}}}} bar baz…<references/>

Foo^[1] bar baz…Foo^[2] bar baz…

↑This is not working, see"Search" . Retrieved on [[{{subst:#time:Y-m-d|now}}]].
↑Whereas this does, see"Search" . Retrieved on2021-03-11.

Adding an automatic heading before the references list

Up to MediaWiki 1.28, one could use the system messageMediaWiki:Cite references prefix to define a wiki-wide heading which would be automatically inserted before each references list. In MediaWiki 1.29,this system message was removed. A hacky way to enter a headline now is to add the following code toMediaWiki:Common.js:

$(document).ready(function(){$('.mw-references-wrap').before('<h2>References</h2>');});

Note that this adds the header unconditionally, i.e. if you already have the header it gets added again thus creating duplicated headers.

If you only need atext heading (no link or other active elements) you could add the following toMediaWiki:Common.css (Chrome 4, IE9, FF 3.5, Safari 3.1, Opera 7):

.mw-references-wrap::before{content:"Blue references";color:#0645ad;text-decoration:none;background:none;font-style:italic;font-size:100%;font-weight:bold;line-height:1.6;direction:ltr;font-family:sans-serif;}

Merging two texts into a single reference

A typical Wikisource issue are references that span multiple pages in the source material.These can be merged using a‎<refname="name"> tag for the first part of the reference, and tagging the following parts with a tag‎<reffollow="name"> using the same name.

Example:

Wikitext	Result
This is an example of merging multiple texts into the same footnote.<refname="main">Remember that all the texts will be included into the reference containing the name="…" attribute.</ref><reffollow="main">Simply include the additional text in a tag with the follow="…" attribute, matching the first ref's name.</ref>==References==<references/>	This is an example of merging multiple texts into the same footnote.^[1] References ↑Remember that all the texts will be included in the reference containing the name="…" attribute. Simply include the additional text in a tag with the follow="…" attribute, matching the first ref's name.

Wikitext

Result

This is an example of merging multiple texts into the same footnote.<refname="main">Remember that all the texts will be included into the reference containing the name="…" attribute.</ref><reffollow="main">Simply include the additional text in a tag with the follow="…" attribute, matching the first ref's name.</ref>==References==<references/>

This is an example of merging multiple texts into the same footnote.^[1]

References

↑Remember that all the texts will be included in the reference containing the name="…" attribute. Simply include the additional text in a tag with the follow="…" attribute, matching the first ref's name.

When using this syntax, take care that the "follow" part of the footnote is included on the same page as the first part of the reference.

Note that reference names cannot start with a number, so always include some text like,<refname="p32"> and<reffollow="p32">.

Customization

The format of the output of‎<ref> and‎<references> is almost completely customizable through MediaWikimessages, 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‎<ref> and‎<references> and the values, if any, that are passed to them ($1, $2, $3 ...), seean up-to-date listing of the default values that can be obtained directly from MediaWiki.

To understand what each parameter means, you can look up the message ontranslatewiki.net.

Set references to use ^ and letters

To replace the default uparrow (↑) with caret (^), modify the followingsystem message.All of these pages can be found onSpecial:AllMessages.

MediaWiki:Cite reference backlink symbol

From	To
↑	^

MediaWiki:Cite references link many format

Replacing $2 with $3 changes the links from 1.0, 1.1, 1.2 to a, b, c etc…

From	To
<sup>[[#$1\|$2]]</sup>	<sup>[[#$1\|$3]]</sup>

Searching for these pages for the first time will result in no matches.Simply click "Create this page" to edit the code. The changes will not show up until a page with references is rebuilt.

Set reference and reference number highlighting

Starting withMediaWiki 1.26 the selectors for highlighting are now incorporated intoCite/modules/ext.cite.css. Thus that portion of the CSS code below no longer needs to be added manually.

Add the following code to theMediaWiki:Common.css page.

/* make the Cite extension list of references look smaller and highlight clicked reference in blue */ol.references{font-size:90%;}ol.referencesli:target{background-color:#ddeeff;}sup.reference:target{background-color:#ddeeff;}

Hide square brackets around footnote numbers

New approach - Square brackets are wrapped in a span like[, so customization can be accomplished using site-wide or user-specific CSS.The recommended rule for sites wishing to omit square brackets is to hide the brackets visually, but leave them in the enabled HTML so that they're included when copying and pasting content:

.reference.cite-bracket{font-size:0;}

Old approach - Customize theMediaWiki:cite_reference_link message to omit square brackets.This can also be done by adding a span around the brackets, but this is already available now, see above.

Note that customizations using this older approach may interfere with the new styles unless the span is added.

Broken references

If the‎<ref> or‎<references/> tags are used incorrectly, the Cite extension will add an error message to the page, and will add the page itself to the "Pages with reference errors" category.These error messages will appear in the user interface language, either in the article content or in the References section.For example:

Wikitext	Result
This is an example of a references error message.<refbroken>Intended text.</ref>==Notes==<references/>	This is an example of a references error message.^[1] Notes ↑Intended text.Cite error: Invalid parameter "broken" in`<ref>` tag. The supported parameters are: dir, follow, group, name.

See thespec for Parsoid's Cite error representation.

Movatterモバイル変換

Usage

Multiple uses of the same footnote

The‎<references/> tag

Grouped references

Citing different parts of the same source

Separating references from text

Substitution and embedded parser functions

Adding an automatic heading before the references list

Merging two texts into a single reference

Customization

Set references to use ^ and letters

Set reference and reference number highlighting

Hide square brackets around footnote numbers

Broken references

See also

The`‎<references/>` tag