Template:Refn

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Documentation icon Template documentation[view] [edit] [history] [purge]

Purpose

This template is used to create footnotes in Wikipedia, as an alternative and complement to the <ref> tag. Because of a technical limitation, some of the standard Wikipedia markup elements that are often used in the article prose do not work within a set of <ref>...</ref> tags, including but not limited to the pipe trick, template substitution and another "nested" set of <ref>...</ref> tags. For example, the following does not work as expected:

  1. <ref>[[Help:Footnotes|]]</ref> (Generates: [[Help:Footnotes|]] instead of a wikilink)
  2. <ref>{{SUBST:TODAY}}</ref> (Generates: {{SUBST:TODAY}} instead of the date that the edit was made)
  3. <ref>Explanatory footnote<ref>Citation</ref></ref> (Generates: Cite error: A <ref> tag is missing the closing </ref> (see the help page). </ref>)

Replacing the outermost <ref>...</ref> set with {{Refn}} allows for the use of the markup elements listed above.

Usage

{{refn|group=groupname|name=name|Contents of the footnote}}

  • groupname: Groupname per WP:REFGROUP; if not specified, then the main and nested references will be rendered into the same reference list
  • name: Reference name per WP:REFNAME

Names for footnotes and groups must follow these rules:

  • Names are case-sensitive
  • Names may not be purely numeric
  • Names must be unique—you cannot use the same name to define different groups or footnotes
  • Quotes are optional if the only characters used are letters A–Z, a–z, digits 0–9, and the symbols !$%&()*,-.:;<@[]^_`{|}~
  • The quote marks must be the standard keyboard marks ("); curly or other quotes will be parsed as part of the reference name.
  • Inclusion of any other characters, including spaces, requires that the name be enclosed in double straight quotes (")
  • If a name is quoted when defined, it must also be quoted for additional invocations (i.e. name="something" is not the same as name=something).
  • Quote-enclosed names may not include a less-than sign (<) or a double straight quote symbol (")
  • Please consider keeping names simple and restricted to the standard English alphabet and numerals.
  • (You may optionally provide names even when the name is not required.)

Examples

Footnotes with citations

Markup Renders as
An example.{{refn|group=note|name=first|A note.<ref>An included reference.</ref>}}
Another example.{{refn|group=note|Another note.<ref>Another included reference.</ref>}}
A third example.{{refn|group=note|The third note.<ref>The reference in the third note.</ref>}}
Repeating the first example.{{refn|group=note|name=first}}

==Notes==
{{reflist|group=note}}

==References==
{{reflist}}
An example.[note 1]

Another example.[note 2] A third example.[note 3] Repeating the first example.[note 1]

Notes
  1. ^ a b A note.[1]
  2. ^ Another note.[2]
  3. ^ The third note.[3]
References
  1. ^ An included reference.
  2. ^ Another included reference.
  3. ^ The reference in the third note.

Substitution

The first example shows that substitution does not work in a regular <ref>...</ref> tag (the accessdate does not appear correctly). The second example shows that the accessdate is substituted correctly within {{refn}}.

Markup Renders as
<ref>{{cite web |accessdate={{Subst:TODAY}} |title=Languages |work=Apache HTTP Server |agency=Ohloh |publisher= Black Duck Software |url=https://www.ohloh.net/p/apache/analyses/latest/languages_summary}}</ref>
{{reflist}}
[1]
  1. ^ "Languages". Apache HTTP Server. Black Duck Software. Ohloh. Retrieved {{Subst:TODAY}}.  Check date values in: |accessdate= (help)

{{refn|{{cite web |accessdate={{Subst:TODAY}} |title=Languages |work=Apache HTTP Server |agency=Ohloh |publisher= Black Duck Software |url=https://www.ohloh.net/p/apache/analyses/latest/languages_summary}}}}
{{reflist}}
[1]
  1. ^ "Languages". Apache HTTP Server. Black Duck Software. Ohloh. Retrieved 4 April 2014. 

Errors

If the reference or note content is missing, then "Cite error: Invalid <ref> tag; refs with no name must have content." will be displayed.

List defined references

Currently, this template may not be used more than once within list-defined references. Doing so will result in Cite errors; see bug 20707http://bugzilla.wikimedia.org/show_bug.cgi?id=20707.

See also

Group name Reference list template In-text citation template
{{reflist}}
{{reflist}} {{refn}} for nested references
lower-alpha {{notelist}} {{efn}}
upper-alpha {{notelist-ua}} {{efn-ua}}
lower-roman {{notelist-lr}} {{efn-lr}}