Template:Ref/doc

From Len'en Wiki
Jump to navigation Jump to search
This is a documentation subpage for Template:Ref.
It contains usage information, categories and other content that is not part of the original template page.

{{Ref}} is used to create footnotes in the Len'en Wiki, as an simplified alternative and complement to the <ref> tag. Because of a technical limitation, some 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>[[Help:Footnotes|]]</ref> (Generates: [[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 {{Ref}} allows for the use of the markup elements listed above.

Usage[edit source]

{{Ref|group=groupname|name=name|Contents of the footnote}} (the tag equivalent to this is <ref name="name" group="groupname">content</ref>)

Note that the parameters are optional:

  • |groupname=: To group the footnotes into separate lists, for example to separate explanatory notes from references, or to list references for tables, image captions, infoboxes and navboxes. The sequence of footnote labels is independent in each group. The {{Reflist}} will also need to be defined with the same group name in order to show the grouped list.
  • |name=: With this, you can cite the same source more than once on a page by using named footnotes. The syntax to define a named footnote is: {{ref|name=name|Contents of the footnote}}
    To invoke the named footnote: {{Ref|name=name}}
    (The tag equivalent is <ref name="name">content</ref>, with the named footnote invoked as <ref name="name" />)

Rules[edit source]

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 other 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 &lt; and &quot;, 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[edit source]

Footnotes with citations[edit source]

Markup:
An example.{{ref|group=note|name=first|A note.{{ref|An included reference.}}}}
Another example.{{ref|group=note|Another note.{{ref|Another included reference.}}}}
A third example.{{ref|group=note|The third note.<ref>The reference in the third note.</ref>}}
Repeating the first example.{{ref|group=note|name=first}}

==Notes==
{{reflist|group=note}}

==References==
{{reflist}}
Will be rendered as:

An example.[note 1]

Another example.[note 2] A third example.[note 3] Repeating the first example.[note 1]

Notes[edit source]

  1. 1.0 1.1 A note.[1]
  2. Another note.[2]
  3. The third note.[3]

References[edit source]

  1. An included reference.
  2. Another included reference.
  3. The reference in the third note.

Substitution[edit source]

The first example shows that substitution does not work in a regular <ref>...</ref> tag (the accessdate does not appear correctly). The second example shows that the accessdate is substituted correctly within {{ref}}.

Markup:
<ref>{{Subst:EE}}</ref>
{{reflist}}
Rendered as:

[1]

  1. {{Subst:EE}}
{{ref|{{Subst:EE}}}}
{{reflist}}

[1]

Errors[edit source]

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:
{{ref|1+1=2}}
Rendered as:

Cite error: Invalid <ref> tag; refs with no name must have content

{{ref|1= 1+1=2}}
[1]
  1. 1+1=2

See also[edit source]