Documentation icon Pang-bô͘ bûn-su[chhâ-khòaⁿ] [pian-chi̍p] [le̍k-sú] [kun-sin]

Purpose siu-kái

This template is used to create footnotes in Wikipedia, as an alternative and complement to the <ref>. 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: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 Pang-bô͘:Tlp allows for the use of the markup elements listed above.

Usage siu-kái

{{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

Pang-bô͘:Refname rules

Examples siu-kái

Footnotes with citations siu-kái

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. 1.0 1.1 A note.[1]
  2. Another note.[2]
  3. The third note.[3]
References
  1. An included reference.
  2. Another included reference.
  3. The reference in the third note.

Substitution siu-kái

The first example shows that substitution does not work in a regular <ref>...</ref> tag (the |access-date= does not appear correctly). The second example shows that the |access-date= is substituted correctly within {{refn}}.

Markup Renders as
<ref>{{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}}</ref>
{{reflist}}

[1]

  1. "Languages". Apache HTTP Server. Black Duck Software. Ohloh. {{Subst:TODAY}} khòaⁿ--ê. 
{{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]

  1. "Languages". Apache HTTP Server. Black Duck Software. Ohloh. 4 April 2014 khòaⁿ--ê. 

Errors siu-kái

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


Pang-chān:Footnotes

See also siu-kái

  • {{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)

Pang-chān:Cite errors/Cite error group refs without references

Pang-bô͘:Wikipedia referencing

TemplateData siu-kái

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

See the monthly error report for this template.

TemplateData for Refn

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

模板參數[編輯模板資料]

此模板以參數行內格式為優先。

參數描述類型狀態
content1 refn

The content of the footnote.

內容必填
namename

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

字串非必填
groupgroup

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

字串非必填