Template: Refname rules

Template documentation[view] [edit] [history] [purge]

Usage

This template outlines the rules for HTML ids.

There are two unnamed parameters:

1. The beginning text; defaults to "Names for footnotes and groups must follow these rules:"
2. 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
• 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 A–Z, a–z, digits 0–9, and the symbols ! $ % & ( ) * , - . : ; < @ [ ] ^ _ ` { | } ~.
  • The forbidden printable ASCII characters are # " ' / = > ? \ .
• Inclusion of any other characters, including spaces, requires that the reference name be enclosed in quotes: name="John Smith".
• The quote marks must be the standard straight keyboard 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.
• 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.

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
• 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 A–Z, a–z, digits 0–9, and the symbols ! $ % & ( ) * , - . : ; < @ [ ] ^ _ ` { | } ~.
  • The forbidden printable ASCII characters are # " ' / = > ? \ .
• Inclusion of any other characters, including spaces, requires that the reference name be enclosed in quotes: name="John Smith".
• The quote marks must be the standard straight keyboard 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.
• If CITEREF is used, then spaces in the |ref= field must be replaced with underscores
• 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.

See also

The above documentation is transcluded from Template:Refname rules/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.