Template:Anchor/Documentation

From GodWiki
< Template:Anchor
Revision as of 17:58, 11 November 2018 by Djonni (talk | contribs) (Category)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The template {{anchor}} inserts one or more HTML fragment identifiers (anchor names) in a page. Those locations can then be linked to using [[#location|…]] syntax.

Examples

1. {{anchor|Foo}}

could be linked to with [[#Foo|…]] from within the same article,
or it could be linked to with [[Article name#Foo|…]] from other articles and from redirects.

2. The template can be used to create up to ten anchors with a single call. For example,

{{anchor|Foo|Bar|baz}}
will create three anchors that can then be linked to with [[#Foo]], [[#Bar]] and [[#baz]].
Specifying more than 10 anchors will cause an error message to be displayed.

Limitations

Character Code Template Meaning
" &quot;
&#34;
N/A (double) quotation mark
# &#35; N/A hash
| &#124; {{!}} pipe
= &#61; {{=}} equals
  • Anchor names that contain any character shown in the table on the right will not work as expected. However, any of these characters can be replaced with the "&#" codes shown for them here. Or, the pipe symbol and equals sign can be worked around with {{!}} and {{=}}, respectively. Markup code such as <sup> and <sub> (superscript and subscript) cannot be used. Most other characters, including white space and punctuation, are not a problem.
  • The template can create a maximum of 10 anchors. Specifying more than 10 anchors will result in an error message.
  • Unlike with most templates, putting each anchor name on separate lines will not work as expected.
  • Anchor names should be unique on a page, and should not duplicate any heading titles. Duplicate anchors will not work as expected since the #location links go to the first anchor with that name. Duplicate anchors result in invalid HTML.
  • If the template is added to a section title then the code will appear in the edit summary when that section is edited, as in "/* {{anchor|Issues}}Limitations */ New issue". So, don't do this.
  • Anchor links are case sensitive in some browsers, so treat all anchor links as case sensitive.