Template:Refname rules/doc

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 may not be purely numeric
• Names must be unique—you cannot use the same name to define different groups or footnotes
• Quotes are optional if the only characters used are letters A–Z, a–z, digits 0–9, and the symbols !$%&()*,-.:;<@[]^_`{|}~
• The quote marks must be the standard keyboard marks ("); curly or other quotes will be parsed as part of the reference name.
• Inclusion of any other characters, including spaces, requires that the name be enclosed in double straight quotes (")
• If a name is quoted when defined, it must also be quoted for additional invocations (i.e. name="something" is not the same as name=something).
• Quote-enclosed names may not include a less-than sign (<) or a double straight quote symbol (")
• Please consider keeping names simple and restricted to the standard English alphabet and numerals.
• (You may optionally provide names even when the name is not required.)

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 may not be purely numeric
• Names must be unique—you cannot use the same name to define different groups or footnotes
• Quotes are optional if the only characters used are letters A–Z, a–z, digits 0–9, and the symbols !$%&()*,-.:;<@[]^_`{|}~
• The quote marks must be the standard keyboard marks ("); curly or other quotes will be parsed as part of the reference name.
• Inclusion of any other characters, including spaces, requires that the name be enclosed in double straight quotes (")
• If a name is quoted when defined, it must also be quoted for additional invocations (i.e. name="something" is not the same as name=something).
• Quote-enclosed names may not include a less-than sign (<) or a double straight quote symbol (")
• If CITEREF is used, then spaces in the |ref= field must be replaced with underscores
• Please consider keeping names simple and restricted to the standard English alphabet and numerals.
• (You may optionally provide names even when the name is not required.)