Template:Visible anchor/doc

From MattWiki
Jump to: navigation, search

The template {{visible anchor}} ({{vanchor}} for short) inserts one or more HTML anchors in a page. Those locations can then be linked to using [[#link|...]] syntax. Unlike {{Anchor}}, the first parameter will be visible text on the page.


1. {{vanchor|foo}}

Visible as: foo
Linkable as: [[#foo|...]] from within the same article, [[articlename#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,

Visible as: foo
Linkable as:[[#foo]], [[#bar]] and [[#baz]].


Character Code Template Meaning
" "
N/A (double) quotation mark
# # N/A hash
| | {{!}} pipe
= = {{=}} equals
  • This template should not be used within section headings. Doing so will result in broken links in edit summaries, as well as duplicate anchors (see below).
  • 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.
  • As with other templates which use positional parameters, putting each anchor name on separate lines, for example
    will not work as expected.
  • Anchor names should be unique on a page, and should not duplicate any heading titles. Duplicate anchors won't 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 "/* {{vanchor|Limitations|Issues}} */ New issue". This can be fixed by replacing the template code with its first parameter in the edit summary before the changes are saved: "/* Limitations */ New issue".


See also