Template:Visible anchor/doc

From Nordic Larp Wiki
Jump to navigation Jump to search

The template {{Visible anchor}} 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.

Usage

1. {{visible anchor|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. Here's an example using the vhanchor shortcut:

{{vanchor|foo|bar|baz}}
Visible as: foo
Linkable as:[[#foo]], [[#bar]] and [[#baz]].
Note how only the first parameter is made visible in the rendered text.

Limitations

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 possible duplicate anchors (see below).
  • 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.
  • 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
    {{vanchor
    |humpty
    |dumpty}}
    will not work as expected.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Visible anchor

The template {{Visible anchor}} 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.

Template parameters

ParameterDescriptionTypeStatus
Anchor name, and text to display1

This will become an anchor. The characters ", #, | and = must be escaped; see the main template page for details. Do not try to use formatting; you can put formatting in the "text" parameter instead.

Example
start-of-content
Stringrequired
Second anchor name2

This will become an anchor. The characters ", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.

Stringsuggested
Third anchor name3

This will become an anchor. The characters ", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.

Stringoptional
Fourth anchor name4

This will become an anchor. The characters ", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.

Stringoptional
Fifth anchor name5

This will become an anchor. The characters ", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.

Stringoptional
Sixth anchor name6

This will become an anchor. The characters ", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.

Stringoptional
Seventh anchor name7

This will become an anchor. The characters ", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.

Stringoptional
Eighth anchor name8

This will become an anchor. The characters ", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.

Stringoptional
Ninth anchor name9

This will become an anchor. The characters ", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.

Stringoptional
Tenth anchor name10

This will become an anchor. The characters ", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.

Stringoptional
Display texttext

Overrides the display of parameter 1, but is not an anchor name. May be formatted.

Example
Properties of CO<sub>2</sub>
Contentsuggested

Aliases

See also