Template:Anchor/doc

From OpenStreetMap Wiki
Jump to: navigation, search

The template {{anchor/doc}} inserts one or more HTML anchors in a page. Those locations can then be linked to using [[#link|...]] syntax. See Template:VisAnchor for adding one visible and clickable anchor to a page.

Examples

1. {{anchor/doc|foo}}

could be linked to with [[#foo|...]] from within the same article,
or it could be linked to with [[articlename#foo|...]] from other articles and from redirects.

2. Anchors can be more suitable for inter-article linking than section titles are. For example,

== <code style="color:green;">{{anchor/doc|foo}} Section title ==</code>
Here, links via [[articlename#foo]] would remain valid even if the section were renamed. Consider using Template:Tlsp beneath the section title to generate an HTML comment alerting other editors to the purpose of anchors used in this manner.

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

{{anchor/doc|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; {{Sharp}} hash (sharp sign, number sign)
| &#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=o and sub=o (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, for example:
    {{anchor/doc
    |humpty
    |dumpty}}

    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 #links go to the first anchor with that name. Duplicate anchors also result in invalid HTML; you can check for duplicate anchors by running the page through the W3C Markup Validation Service.
  • 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". This can be fixed by deleting the template code from the edit summary before the changes are saved. Consider using Template:Tlsp beneath the section title to generate an HTML comment alerting other editors to the purpose of anchors used in this manner, so they do not move the anchor out of the section heading when they notice the deleterious effects on their edit summary.
  • Anchor links are case sensitive in some browsers, so treat all anchor link as case sensitive.