Template: Refn: Difference between revisions

From A Wiki of Ice and Fire
Jump to: navigation, search
Mindset (talk | contribs)
No edit summary
Abjiklam (talk | contribs)
m put documentation in its own page
 
Line 1: Line 1:
<includeonly>{{#if:{{{name|}}}|{{#tag:ref|{{{1|{{{refn|}}}}}}|name={{{name|}}}|group={{{group|}}}}}|{{#tag:ref|{{{1|{{{refn|}}}}}}|group={{{group|}}}}}}}</includeonly><noinclude>===Purpose===
<includeonly>{{#if:{{{name|}}}|{{#tag:ref|{{{1|{{{refn|}}}}}}|name={{{name|}}}|group={{{group|}}}}}|{{#tag:ref|{{{1|{{{refn|}}}}}}|group={{{group|}}}}}}}</includeonly><noinclude>{{documentation}}</noinclude>
This template is used to create footnotes as an alternative and complement to the <nowiki>{{ref}}</nowiki> tag and <nowiki><ref group="N"></nowiki> tag.
 
The primary purpose of this template is to permitting nesting of references, necessary when providing a reference within a footnote.
 
Because of a technical limitation, some of the standard markup elements that are often used in the article prose do not work within a set of <nowiki>{{ref}}</nowiki> tags, including but not limited to the pipe trick, template substitution, and another "nested" set of <nowiki>{{ref}}</nowiki> tags.
 
===Usage===
<pre><nowiki>{{refn|group="groupname"|name="name"|Contents of the footnote, including <ref> tags if needed|allowlinebreak=yes}}</nowiki></pre>
 
:* '''groupname''': Usually "N", to place the footnote within the Notes section of the page. If not specified, then the main and nested references will be rendered into the same reference list.
:* '''name''': Reference name
 
===Errors===
If the reference or note content is missing, a Cite error will be generated.
 
Currently, this template may not be used more than once within list-defined references. Doing so will result in Cite errors.
 
==See Also==
* [[Template:References]]
* [[Template:Ref]]
* [[Template:Notes]]
 
[[Category:Cross-reference templates]]
</noinclude>

Latest revision as of 15:24, 4 November 2023