Editing Template:Refn/doc

From Guild of Archivists
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
===Purpose===
===Purpose===
This template is used to [[GoArch:Citation guidelines|create footnotes in the Archive]], as an alternative and complement to the {{tag|ref|o}} tag. [[:mw:Extension:Cite/Cite.php#Substitution and embedded parser functions|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 {{tag|ref}} tags, including but not limited to [[w:Help:Pipe trick|the pipe trick]], [[w:Wikipedia:Substitution|template substitution]] and another "nested" set of {{tag|ref}} tags. For example, the following does not work as expected:
This template is used to [[Help:Footnotes|create footnotes in Wikipedia]], as an alternative and complement to the {{tag|ref|o}} tag. [[:mw:Extension:Cite/Cite.php#Substitution and embedded parser functions|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 {{tag|ref}} tags, including but not limited to [[Help:Pipe trick|the pipe trick]], [[Wikipedia:Substitution|template substitution]] and another "nested" set of {{tag|ref}} tags. For example, the following does not work as expected:
# {{tag|ref|content=<nowiki>[[Help:Editing|]]</nowiki>}} (Generates: <nowiki>[[Help:Editing|]]</nowiki> instead of a wikilink)
# {{tag|ref|content=<nowiki>[[Help:Footnotes|]]</nowiki>}} (Generates: <nowiki>[[Help:Footnotes|]]</nowiki> instead of a wikilink)
# {{tag|ref|content=<nowiki>{{SUBST:TODAY}}</nowiki>}} (Generates: <nowiki>{{SUBST:TODAY}}</nowiki> instead of the date that the edit was made)
# {{tag|ref|content=<nowiki>{{SUBST:TODAY}}</nowiki>}} (Generates: <nowiki>{{SUBST:TODAY}}</nowiki> instead of the date that the edit was made)
# {{tag|ref|content=<nowiki>Explanatory footnote<ref>Citation</ref></nowiki>}} (Generates: <span style="font-weight: bold; color: #CC0000;">Cite error: A &lt;ref&gt; tag is missing the closing &lt;/ref&gt; (see the [[:Help:Cite errors/Cite error included ref|help page]]).</span> &lt;/ref&gt;)
# {{tag|ref|content=<nowiki>Explanatory footnote<ref>Citation</ref></nowiki>}} (Generates: <span style="font-weight: bold; color: #CC0000;">Cite error: A &lt;ref&gt; tag is missing the closing &lt;/ref&gt; (see the [[:Help:Cite errors/Cite error included ref|help page]]).</span> &lt;/ref&gt;)
Line 10: Line 10:
{{tld|refn|2=group=groupname|3=name=name|4=Contents of the footnote|allowlinebreak=yes}}
{{tld|refn|2=group=groupname|3=name=name|4=Contents of the footnote|allowlinebreak=yes}}


:* '''groupname''': Groupname per [[w:WP:REFGROUP|WP:REFGROUP]]; if not specified, then the main and nested references will be rendered into the same reference list
:* '''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 [[w:WP:REFNAME|WP:REFNAME]]
:* '''name''': Reference name per [[WP:REFNAME]]


Names for footnotes and groups must follow these rules:
{{refname rules}}
* Names are case-sensitive
* Names MUST NOT be purely numeric; they should have semantic value so that they can be more easily distinguished from each other by human editors.
* Names must be unique—you may not use the same name to define different groups or footnotes
* Quotation marks are optional if the only characters used are letters <code>A–Z</code>, <code>a–z</code>, digits <code>0–9</code>, and the symbols <code>! $ % & ( ) * , - . : ; < @ [ ] ^ _ ` { | } ~</code>.
** The forbidden printable ASCII characters are <code> # " ' / = > ? \ </code>.
* Inclusion of any other characters, {{em|including spaces}}, requires that the reference name be enclosed in quotes: <code>name="<var>John Smith</var>"</code>.
* The quote marks must be the standard straight keyboard marks (<code>"</code>); curly or other quotes will be parsed as part of the reference name.
* Quote-enclosed reference names may not include a less-than sign (<code><</code>) or a double straight quote symbol (<code>"</code>). These may be escaped with <code>&amp;lt;</code> and <code>&amp;quot;</code>, respectively.
* Please consider keeping reference names simple and restricted to the standard [[English alphabet]] and numerals.
* 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===
===Examples===
Line 31: Line 21:
Another example.{{refn|group=note|Another note.<ref>Another 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>}}
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}}  
Repeating the first example.{{refn|group=note|name=first}}


==Notes==
==Notes==
Line 47: Line 37:


{{fake heading|sub=3|References}}
{{fake heading|sub=3|References}}
{{reflist|close=1}}
}}
====Substitution====
The first example shows that substitution does not work in a regular {{tag|ref}} tag (the accessdate does not appear correctly). The second example shows that the accessdate is substituted correctly within {{tl|refn}}.
{{markup
|<nowiki><ref>{{cite web |accessdate={{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}}</nowiki>
|<ref>{{cite web |accessdate={{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|template doc demo=true}}</ref>
{{reflist|close=1}}
|<nowiki>{{refn|{{cite web |accessdate={{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}}</nowiki>
|{{refn|{{cite web |accessdate=4 April 2014 |title=Languages |work=Apache HTTP Server |agency=Ohloh |publisher= Black Duck Software |url=https://www.ohloh.net/p/apache/analyses/latest/languages_summary}}}}
{{reflist|close=1}}
{{reflist|close=1}}
}}
}}
Line 52: Line 56:
===Errors===
===Errors===
If the reference or note content is missing, then "Cite error: Invalid {{tag|ref|open}} tag; refs with no name must have content." will be displayed.
If the reference or note content is missing, then "Cite error: Invalid {{tag|ref|open}} tag; refs with no name must have content." will be displayed.
===See also===
{{#lst:Help:Cite errors/Cite error group refs without references|rlt}}
{{Wikipedia referencing}}


== TemplateData ==
== TemplateData ==
Line 80: Line 89:
"name",
"name",
"group"
"group"
]
],
"format": "inline"
}
}
</templatedata>
</templatedata>
Please note that all contributions to Guild of Archivists may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see GoArch:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://archive.guildofarchivists.org/wiki/Template:Refn/doc"