Teamplaid:Refn/documentation

Purpose

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>{{enUici|Help:Footnotes|}}</ref> (Generates: {{enUici|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

{{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 ":1" (which is punctuation plus a number), but it will ignore "1" (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 ":1".
• Names must be unique. You may not use the same name to define different groups or footnotes.
• Please consider keeping reference names simple and restricted to the standard English alphabet and numerals. Failing that, if spaces are used, including the following technical restrictions becomes 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 #"'/=>?\.
  • Inclusion of any other characters, including spaces, requires that the reference name be enclosed in quotes; for example, name="John Smith".
  • The quote marks must be the standard, straight, double quotation 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.
• 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

Substitution

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

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}}
{{Refn|1= 1+1=2}}

TemplateData

This is the WP:TemplateData documentation for this template used by WP:VisualEditor and other tools; see the monthly parameter usage 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.

Paramadairean na teamplaide[Stiùirich an TemplateData]

Is fhearr leis an teamplaid seo fòrmatadh nam paramadairean am broinn na loidhne.

Paramadair		Tuairisgeul	Seòrsa	Staid
content	1 Refn	The content of the footnote.	Susbaint	riatanach
name	name	The name of the footnote. Corresponds to the "name" attribute of the <ref> tag.	Sreang	roghainneil
group	group	The reference group. Corresponds to the "group" attribute on the <ref> tag.	Sreang	roghainneil