Template:Refn/doc

Purpose

This template is used to create footnotes in the Archive, 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:Editing|]]</ref> (Generates: [[Help:Editing|]] 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 MUST NOT be purely numeric; they should have semantic value so that they can be more easily distinguished from each other by human editors.
• Names must be unique—you may not 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 ! $ % & ( ) * , - . : ; < @ [ ] ^ _ ` { | } ~.
  • The forbidden printable ASCII characters are # " ' / = > ? \ .
• 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. Another example. A third example. Repeating the first example. Notes References

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.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Refn

This template is used to create footnotes in Wikipedia, as an alternative and complement to the <ref> tag.

Template parameters

Parameter		Description	Type	Status
content	1	The content of the footnote.	Content	required
name	name	The name of the footnote. Corresponds to the "name" attribute of the <ref> tag.	String	optional
group	group	The reference group. Corresponds to the "group" attribute on the <ref> tag.	String	optional