Template documentation (for the above template, sometimes hidden or invisible)[view] [edit] [history] [refresh]

Description

Template:Anchor inserts one or more HTML anchors in a page. Those locations can then be linked to using [[#link|...]] 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. Anchors can be more suitable for inter-article linking than section titles are. For example:

== {{anchor|Foo}} Section title ==
Here, links via [[Article name#Foo]] would remain valid even if the section were renamed. (Note that the anchor is placed before the section name; otherwise browsers may hide the section title from view.) However, as noted under Limitations below, it may be preferable to use direct HTML rather than the template within section titles:
== <span id="Foo"></span> Section title ==

3. The template can be used to create up to 10 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

  • Anchor names that contain # (i.e., hash), | (i.e., pipe), = (i.e., equal) will not work as expected. Markup code such as <sup></sup> and <sub></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.
  • Putting each anchor name on separate lines, for example
{{anchor
|humpty
|dumpty}}
will probably 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, so you can check for duplicate anchors by consulting 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.

See also

  • Scratchpad:Shortcut – The how-to guide and guideline about how and when to create shortcuts and shortcut boxes. A must-read for anyone handling shortcuts.
  • {{anchor}} – a way to overcome the otherwise permanent fact that section titles are the only way to link to a section
  • {{anchored list}}
  • {{section}}
  • {{shortcut}}
  • {{ombox/shortcut}} – for embedding into message boxes
  • {{policy shortcut}} – for shortcuts to sections of policy pages
  • {{R from shortcut}} – for placement on the redirect page
  • {{shortcut-l}} – for left aligned normal shortcuts
  • {{template shortcut}} – used for shortcuts/redirects to a template page
  • {{template redirect}} – a wrapper that prompts {{template shortcut}} to refer to “redirect(s)” rather than “shortcut(s)”.

The above Template documentation is transcluded from Template:Anchor/doc. (edit | history)
Editors can experiment in this template’s sandbox (create) and testcases (create) pages
Please add categories and interwikis to the /doc subpage.
Subpages of this template
Community content is available under CC-BY-SA unless otherwise noted.