Template:Visible anchor

{{{1}}}

Template documentationviewedithistorypurge

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

{{visible anchor|anchor 1|anchor 2|text=display text|lang=language code}}

The template can be used with up to 30 anchor names. Anchor names are case sensitive, so {{Visible anchor|Anchor name 1}} and {{Visible anchor|Anchor Name 1}} are not equivalent. When making an anchor, in general capitalize the first letter of the anchor name, and follow the same capitalization guidelines as headers (see Wikipedia:Manual of Style § Section headings for more information). An optional <syntaxhighlight lang="wikitext" inline style="display: none;" />|text= parameter can be added in order to specify the text to display in the anchor. By default, the value of the first parameter is used. A second optional <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang= parameter can be added to mark up the resulting visible text with the specified ISO 639 language code or IETF language tag (such as used by {{lang}}).

Linking to anchors

Link to an anchor in the same article using just the anchor name, e.g. [[#Anchor name]]. (In the Visual Editor, type #Anchor name into the link field.)

From a different article, link to an anchor by specifying the article name, followed by a #, then the anchor name. e.g. [[Article name#Anchor name]].

The # will be visible in the link text. To prevent this, give the link a display title in the typical manner: After a pipe character (|) in the wikitext ([[#Anchor name|Anchor name]]), or by editing the text of the link in the Visual Editor.

Destination highlighting

When a link to an anchor is followed, the destination anchor's visible text will typically be highlighted with a shaded background. (May vary based on the reader's browser or selected wiki skin.) For example:

This text anchor will be highlighted after following this link which targets it.

Specifying a language

To aid screen readers and other assistive technologies properly identify text in foreign languages or dialects, an ISO 639-1 language code or IETF language tag can be given with the <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang= parameter to add the language code as an attribute to the HTML of the displayed text. Note that unlike the {{lang}} template, no italicization or text formatting is applied to the text.

Examples

Code	Result	Link
{{vanchor|Foo}}	Foo	#Foo
{{vanchor|Bar|Baz}}	Bar	#Bar, #Baz
{{vanchor|Qux|text=Display text}}	Display text	#Qux
{{vanchor|Corge|Grault|lang=en-US}}	Corge	#Corge, #Grault

Limitations

Character	Code	Template	Meaning
"	" "	—N/a	quotation mark
#	#	—N/a	hash
|	|	{{!}}	pipe
=	=	{{=}}	equals

• Just like {{Anchor}}, This template should not be used within section headings, otherwise it will cause accessibility and technical issues. See Template:Anchor § Always substitute inside section headers for more information.
• 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 30 anchors. Specifying more than 30 anchors will result in an error message.
• If positional parameters (parameters without specifying 1=, 2=, etc.) are used, whitespace and newlines will be preserved. If you instead specify the name of the parameters (e.g. <syntaxhighlight lang="wikitext" inline style="display: none;" />|1=), whitespace and newlines will be trimmed.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Visible anchor in articles based on its TemplateData.

TemplateData for Visible anchor

<templatedata> { "params": { "1": { "label": "Anchor name, and text to display", "description": "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", "type": "string", "required": true }, "2": { "label": "Second anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string", "suggested": true }, "3": { "label": "Third anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "4": { "label": "Fourth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "5": { "label": "Fifth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "6": { "label": "Sixth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "7": { "label": "Seventh anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "8": { "label": "Eighth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "9": { "label": "Ninth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "10": { "label": "Tenth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "11": { "label": "Eleventh anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "12": { "label": "Twelfth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "13": { "label": "Thirteenth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "14": { "label": "Fourteenth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "15": { "label": "Fifteenth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "16": { "label": "Sixteenth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "17": { "label": "Seventeenth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "18": { "label": "Eighteenth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "19": { "label": "Nineteenth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "20": { "label": "Twentieth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "21": { "label": "Twenty-first anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "22": { "label": "Twenty-second anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "23": { "label": "Twenty-third anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "24": { "label": "Twenty-fourth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "25": { "label": "Twenty-fifth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "26": { "label": "Twenty-sixth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "27": { "label": "Twenty-seventh anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "28": { "label": "Twenty-eighth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "29": { "label": "Twenty-ninth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "30": { "label": "Thirtieth anchor name", "description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.", "type": "string" }, "text": { "label": "Display text", "description": "Overrides the display of parameter 1, but is not an anchor name. May be formatted.", "example": "Properties of CO₂", "type": "content", "suggested": true }, "lang": { "label": "Language code", "description": "Applies the specified ISO 639 or IETF language tag as an attribute to the HTML of the displayed text. Useful for screen readers and other assistive technologies.", "example": "en-US; fr; etc.", "type": "line" } }, "description": "The template {{{1}}} inserts one or more HTML anchors in a page. Those locations can then be linked to using ... syntax. Unlike , the first parameter will be visible text on the page." } </templatedata>

See also

Shortcut templates

Template	Shortcut	Result
{{Shortcut}}	{{Sh}}
{{Shortcut compact}}	{{Hsh}}
{{Shortcut mini}}	{{Msh}}	WP:THISWP:THIS 📌
{{Template shortcut}}	{{Tsh}}
{{Template redirect}}	{{Tlr}}
{{Short URL box}}	{{Urlb}}
{{Shortcut-style further links}}	{{Msh}}

• {{Anchor}} – Creates an HTML anchor that can be linked to
  • {{Visible anchor}} – Highlights the linked text, like this.
• {{Section link}} – Link to an anchor or section
• {{R for convenience}} – For placement on the redirect page
  • {{R from shortcut}} – For shortcut boxes
  • {{R to redirect template}} – For template redirects
• Help:Link § Section linking (anchors)

The above documentation is transcluded from Template:Visible anchor/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.