Template:Visible anchor/doc

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]}}

The template can be used with up to 10 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 Manual of Style: Headers for more information). An optional |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. The redirect {{vanchor}} can also be used.

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.

Examples

Code	Result	Link
{{vanchor|Foo}}	Foo	#Foo
{{vanchor|Bar|Baz}}	Bar	#Bar, #Baz
{{vanchor|Qux|text=This is the text that will be displayed.}}	This is the text that will be displayed.	#Qux

Limitations

Character	Code	Template	Meaning
	" "	—	(double) quotation mark
#	#	—	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.
• 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. |1 =) whitespace and newlines will be trimmed.

TemplateData

This is the  TemplateData for this template used by TemplateWizard,  VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Visible anchor

{
	"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"
		},
		"text": {
			"label": "Display text",
			"description": "Overrides the display of parameter 1, but is not an anchor name. May be formatted.",
			"example": "Properties of CO<sub>2</sub>",
			"type": "content",
			"suggested": true
		}
	},
	"description": "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."
}

Aliases

• {{visanc}}
• {{vanchor}}

See also

• {{Anchor}}
• {{Anchored list}}
• {{Shortcut}}
•  Help:Link § Section linking (anchors) (Shortcut:  WP:ANCHOR)