Template:Refn

Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
View • Edit • History

The following documentation is transcluded from Template:Refn/doc:

Purpose

This template is used to create explanatory footnotes, as an alternative and complement to the <ref>. Because of a technical limitation, some of the standard wiki 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 (using a link alias like[[wikilink|displayed text]]), template substitution ([[Subst:]]), 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

This template can be used to create a standard efn (explanatory foot note), by using this model:

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

Or to nest a citation or reference inside another footnote, by using one of these models:

{{refn|group=groupname|name=name|Contents of the footnote.<ref>With a citation.</ref>}}

{{refn|group=groupname|name=name|Contents of the footnote.{{cite dragon|issue #|page #}}}}

Other forms of citations

Any other citation template which results in a <ref> tag for a citation or note can be used with this template. This includes, but is not limited to: Template:Cite sourcebook, Template:Cite web, Template:Cite book, Template:Cite journal, Template:Cite dragon, Template:Cite dungeon, Template:Cite lgj, etc.

Parameters

• groupname: if not specified, then the main and nested references will be rendered into the same reference list
• name: Reference name, using the following standard naming rules.

Names for footnotes and groups must

• Names are case-sensitive. Please do not use raNdOM capitalization.
• Names must not be purely numeric; the software will accept something like ":31337" (which is punctuation plus a number), but it will ignore "31337" (purely numeric).
• Names should have semantic value, so that they can be more easily distinguished from each other by human editors who are looking at the wikitext. This means that ref names like "Nguyen 2010" are preferred to names like ":31337".
• Names must be unique. You may not use the same name to define different groups or footnotes. Try to avoid picking a name that someone else is likely to choose for a new citation, such as ":0" or "NYT".
• Please consider keeping reference names short, simple, and restricted to the standard English alphabet and numerals. If spaces are used, the following technical restrictions become relevant:
  • Quotation marks are preferred but optional if the only characters used are letters A–Z, a–z, digits 0–9, and the symbols !$%&()*,-.:;<@[]^_`{|}~. That is, all printable ASCII characters except #"'/=<>?\ and space.
  • Inclusion of any other characters, including spaces, requires that the reference name be enclosed in quotes; for example, name="John Smith". But quote-enclosed reference names may not include a less-than sign (<) or a double straight quote symbol ("), which may however be included by escaping as < and " respectively.
  • The quote marks must be the standard, straight, double quotation marks ("); curly or other quotes will be parsed as part of the reference name.
• 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

Displays 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}} == References == === Notes === <references group="note" /> === Citations === <references />

An example. Another example. A third example. Repeating the first example. References Notes Citations

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.

If the note content contains an equals sign (=), the equals sign will be interpreted as setting off a named parameter and cause an error. This can be worked around by using a numbered parameter, for example: |1={{refn|1+1=2}} |2= |3={{refn|1= 1+1=2}} |4=

See also

• {{r}} (another template supporting nested footnotes)
• {{citeref}} (a different method to create nested links working on citation template anchor level rather than <ref></ref> markup level)

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Refn in articles based on its TemplateData.

TemplateData for Refn

This template is used to create footnotes in the ''Great Library of Greyhawk''' wiki, as an alternative and complement to the <ref> tag.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
content	1 refn	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