テンプレート:Refn/doc

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:

<ref>[[Help:Footnotes|]]</ref> (Generates: [[Help:Footnotes|]] instead of a wikilink)
<ref>{{SUBST:TODAY}}</ref> (Generates: {{SUBST:TODAY}} instead of the date that the edit was made)
<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
Quotation marks are optional if the only characters used are letters A–Z, a–z, digits 0–9, and the symbols ! $ % & ( ) * , - . : ; < @ [ ] ^ _ ` { | } ~ .
Inclusion of any other characters, including spaces, requires that the reference name be enclosed in quotes: name="John Smith".
The quote marks must be the standard straight keyboard marks ("); curly or other quotes will be parsed as part of the reference name.
Quote-enclosed reference names may not include a less-than sign (<) or a double straight quote symbol ("). These may be escaped with < and ", respectively.
Please consider keeping reference names simple and restricted to the standard English alphabet and numerals.
You may optionally provide reference names even when the reference name is not required. This makes later re-use of the sourced reference easier.

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.0 ^1.1 A note.^[1]
↑ Another note.^[2]
↑ The third note.^[3]

References

↑ An included reference.
↑ Another included reference.
↑ 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]

↑ "Languages". Apache HTTP Server. Black Duck Software. Ohloh. Retrieved {{Subst:TODAY}}. {{cite web}}: Check date values in: |accessdate= (help); Unknown parameter |template doc demo= ignored (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}}