Template:Refname rules: Difference between revisions
Jump to navigation
Jump to search
Richardpruen (talk | contribs) m (1 revision imported: Wikipedia article on Nicotine templates needed) |
imported>Pol098 (→top: removed what i added about single quotes not working - in practice they do (but bad idea to say so, i think)) |
||
| Line 1: | Line 1: | ||
{{{1|Names for footnotes and groups must follow these rules:}}} | {{{1|Names for footnotes and groups must follow these rules:}}} | ||
* Names are case-sensitive. Please do not use raNdOM capitalization. | * Names are case-sensitive. Please do not use raNdOM capitalization. | ||
* Names {{strong|must not}} be purely numeric; the software will accept something like <code>": | * Names {{strong|must not}} be purely numeric; the software will accept something like <code>":31337"</code> (which is punctuation plus a number), but it will ignore <code>"31337"</code> (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 <code>"Nguyen 2010"</code> are preferred to names like <code>": | * 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 <code>"Nguyen 2010"</code> are preferred to names like <code>":31337"</code>. | ||
* Names must be unique. | * 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 <code>":0"</code> or <code>"NYT"</code>. | ||
* Please consider keeping reference names simple and restricted to the standard [[English alphabet]] and numerals. | * Please consider keeping reference names 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 <code>A–Z</code>, <code>a–z</code>, digits <code>0–9</code>, and the symbols <code style="word-break: break-all;">!$%&()*,-.:;<@[]^_`{|}~</code>. That is, all printable ASCII characters except <code style="word-break: break-all;">#"'/=>?\</code>. | ** Quotation marks are preferred but 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 style="word-break: break-all;">!$%&()*,-.:;<@[]^_`{|}~</code>. That is, all printable ASCII characters except <code style="word-break: break-all;">#"'/=<>?\</code> and space. | ||
** Inclusion of any other characters, {{em|including spaces}}, requires that the reference name be enclosed in quotes; for example, <code>name="John Smith"</code>. | ** Inclusion of any other characters, {{em|including spaces}}, requires that the reference name be enclosed in quotes; for example, <code>name="John Smith"</code>. But quote-enclosed reference names may not include a less-than sign (<code><</code>) or a double straight quote symbol (<code>"</code>), which may however be included by [[Escape sequence|escaping]] as <code>&lt;</code> and <code>&quot;</code> respectively.{{#if: {{{2|}}}| | ||
{{{2}}}}} | |||
** The quote marks must be the standard, straight, double quotation marks (<code>"</code>); curly or other quotes will be parsed as part of the reference name. | ** The quote marks must be the standard, straight, double quotation marks (<code>"</code>); 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.<noinclude> | * You may optionally provide reference names even when the reference name is not required. This makes later re-use of the sourced reference easier.<noinclude> | ||
{{documentation}} | {{documentation}} | ||
</noinclude> | </noinclude> | ||
Latest revision as of 18:06, 10 June 2022
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 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, digits0–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<and"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.
- Quotation marks are preferred but optional if the only characters used are letters
- You may optionally provide reference names even when the reference name is not required. This makes later re-use of the sourced reference easier.
Usage
This template outlines the rules for HTML ids.
There are two unnamed parameters:
- The beginning text; defaults to "Names for footnotes and groups must follow these rules:"
- Additional rules; start each entry on a newline; bullet as needed
Example:
Default:
{{Refname rules}}
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 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, digits0–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<and"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.
With parameters:
{{Refname rules|A custom ID must follow these rules:|
* If CITEREF is used, then spaces in the {{para|ref}} field must be replaced with underscores}}
A custom ID 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 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, digits0–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<and"respectively.- If CITEREF is used, then spaces in the
|ref=field must be replaced with underscores
- 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.