Template:Refn/doc

Add links
From Rail announcements

Purpose

This template is used to create footnotes in Wikipedia, as an alternative and complement to the <syntaxhighlight lang="HTML" inline>Cite error: Closing </ref> missing for <ref> tag</syntaxhighlight> tags, including but not limited to the pipe trick, template substitution and another "nested" set of <syntaxhighlight lang="HTML" inline>[1]</syntaxhighlight> tags. For example, the following does not work as expected:

  1. <syntaxhighlight lang="HTML" inline>[2]</syntaxhighlight> (Generates: [[Help:Footnotes|]] instead of a wikilink)
  2. <syntaxhighlight lang="HTML" inline>[3]</syntaxhighlight> (Generates: {{SUBST:TODAY}} instead of the date that the edit was made)
  3. <syntaxhighlight lang="HTML" inline>Cite error: Closing </ref> missing for <ref> tag</ref></syntaxhighlight> (Generates: Cite error: A <ref> tag is missing the closing </ref> (see the help page). </ref>)

Replacing the outermost <syntaxhighlight lang="HTML" inline>[4]</syntaxhighlight> 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. 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 &lt; and &quot; 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 Renders as 
An example.[note 1]
Another example.[note 2]
A third example.[note 3]
Repeating the first example.[note 1]

<div style="color: #000000; background: none; overflow: hidden; page-break-after: avoid; font-size: 1.17em; font-weight: bold; margin-top: 0.3em; margin-bottom: 0; line-height: 1.6; padding-top: 0.5em; padding-bottom: 0;">Notes</div>
<div class="reflist   " >

    

  1. ↑ 1.0 1.1 A note.[5]

    2. 

  2. ↑ Another note.[6]

    3. 

  3. ↑ The third note.[7]

    4. 

</div>

<div style="color: #000000; background: none; overflow: hidden; page-break-after: avoid; font-size: 1.17em; font-weight: bold; margin-top: 0.3em; margin-bottom: 0; line-height: 1.6; padding-top: 0.5em; padding-bottom: 0;">References</div>
<div class="reflist   " >

    

  1. ↑ ...

    2. 

  2. ↑ [[Help:Footnotes|]]

    3. 

  3. ↑ {{SUBST:TODAY}}

    4. 

  4. ↑ ...

    5. 

  5. ↑ An included reference.

    6. 

  6. ↑ Another included reference.

    7. 

  7. ↑ The reference in the third note.

    8. 

</div>

Other forms of citations

Markup Renders as 
An example.[note 1]
Another example.[2]
A third example.[note 2]
Repeating the first example.[note 1]
Repeating the second example.[2]
A fourth example with citation templates.[4]

<div style="color: #000000; background: none; overflow: hidden; page-break-after: avoid; font-size: 1.17em; font-weight: bold; margin-top: 0.3em; margin-bottom: 0; line-height: 1.6; padding-top: 0.5em; padding-bottom: 0;">Notes</div>
<div class="reflist   " >

    

  1. ↑ 1.0 1.1 A note.[1]

    2. 

  2. ↑ A second note.[3]

    3. 

</div>

<div style="color: #000000; background: none; overflow: hidden; page-break-after: avoid; font-size: 1.17em; font-weight: bold; margin-top: 0.3em; margin-bottom: 0; line-height: 1.6; padding-top: 0.5em; padding-bottom: 0;">References</div>
<div class="reflist   " >

    

  1. ↑ The reference in the first note.

    2. 

  2. ↑ 2.0 2.1 Another reference, but without a note.

    3. 

  3. ↑ The reference in the second note.

    4. 

  4. ↑ Smith (2005), The Solar System, quoted in Jones 2020, p. 25.

    5. 

</div>

Substitution

The first example shows that substitution does not work in a regular <syntaxhighlight lang="HTML" inline>[1]</syntaxhighlight> tag (the |access-date= does not appear correctly). The second example shows that the |access-date= is substituted correctly within {{refn}}.

Markup Renders as 
[2]
<div class="reflist   " >

    

  1. ↑ ...

    2. 

  2. ↑ "Languages". Apache HTTP Server. Black Duck Software. Ohloh. Retrieved {{Subst:TODAY}}. {{cite web}}: Check date values in: |access-date= (help)

    3. 

</div>

{{refn|{{cite web |access-date={{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]
<div class="reflist   " >

    

  1. ↑ "Languages". Apache HTTP Server. Black Duck Software. Ohloh. Retrieved 4 April 2014.

    2. 

</div>

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:

Markup Renders as 
{{refn|1+1=2}}

Cite error: There are <ref> tags on this page without content in them (see the help page). 

{{refn|1= 1+1=2}}

[1]

  1. ↑ 1+1=2


{{#section:Help:footnotes|pregroup}}

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 Wikipedia, as an alternative and complement to the <ref> tag.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
content1 refn

The content of the footnote.

Contentrequired
namename

The name of the footnote. Corresponds to the "name" attribute of the <ref> tag.

Stringoptional
groupgroup

The reference group. Corresponds to the "group" attribute on the <ref> tag.

Stringoptional


Retrieved from "https://wiki.railannouncements.co.uk/index.php?title=Template:Refn/doc&oldid=1007"