Template:Anchor/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:Anchor (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page.

Contents 1 Usage 1.1 Description 1.2 Examples 1.3 Limitations 2 See also

[edit] Usage

[edit] Description

The template {{anchor}} inserts one or more HTML anchors in a page. Those locations can then be linked to using [[#link|...]] syntax.

[edit] Examples

1. {{anchor|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,

==Section title==

{{anchor|foo}}

Here, links via [[articlename#foo]] would remain valid even if the section were renamed.

3. 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.

[edit] Limitations

• Anchor names that contain # (hash), | (pipe), = (equal) will not work as expected. Most other characters, including white space and punctuation are not a problem.
• Do not place anchors in the middle of other wiki syntax. For example, ==Heading{{anchor|foo}}== does not work as expected, because it breaks links to the normal heading, and it makes the revision history harder to read. Instead, put ==Heading== on one line, and {{anchor|foo}} on the next.
• The template can create a maximum of 10 anchors. Specifying more than 10 anchors will result in an error message.
• Put names on a single line. 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.
• Unlike section headings, anchors may not work on some (very old) browsers. This is because section headings are tagged with the more backward-compatible <a name="heading" id="heading"></a>. Such tagging cannot be achieved with templates.

[edit] See also

• {{Visible anchor}}