View source for Template:Anchor/doc

{{lua|Module:Anchor}}
{{used in system}}
{{Bot use warning|bots=[[User:Cewbot]] ([[Wikipedia:Bots/Requests for approval/Cewbot 6|BRFA]])}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE END OF THIS PAGE, ND INTERWIKIS LINKS TO WIKIDATA -->

The template {{tl|{{lc:{{BASEPAGENAME}}}}}} inserts one or more invisible anchor names ([[Fragment identifier|HTML fragment identifiers]]) in a page.

Anchors are most useful with sections, since links to a section will not work if a section is renamed. However, anchors can be used as needed anywhere in an article.
__TOC__

{{anchor|Above-Foo|Foo bar}}

== Basic format<span class="anchor" id="Foo"></span><span class="anchor" id="In-Foo"></span><span class="anchor" id="Anchor name 1"></span><span class="anchor" id="Anchor name 2"></span> ==
{{shortcut|WP:ANCHORFORMAT}}
{{anchor|Under-Foo}}
{{notice|This template should always be {{strong|[[Wikipedia:Substitution|substituted]] within a section heading when the intended target is a section title}}, otherwise it will cause technical issues.}}

The basic format is {{tlc|anchor|Anchor name}} for parts on a page, and {{tlxs|anchor|Anchor name|nolink=y}} for use in headings.
More than one name can be given, separated by <code>|</code>, which can be useful for alternative spellings such as "humor" and "humour": {{tlc|anchor|humor|humour}}

In general, if the intended target of an anchor is a section title, then [[#Rationale for substitution in the header|it should be placed at the end of the section header]] by [[WP:SUBST|substitution]]:
:<code style="color:darkgreen;"><nowiki>== Section header{{subst:</nowiki>anchor|Anchor name}} ==</code>
which will be saved in the article as:
:<code>== Section header{{code|1={{Anchor|Anchor name}}}} ==</code>

An anchor name can be arbitrary, but the first letter should generally be capitalized in keeping with header style. {{crossref|See [[MOS:HEADINGS|Manual of Style § Section headings]] for more information.}}
Note that anchor names are case sensitive, so <code><nowiki>[[#Anchor name]]</nowiki></code> and <code><nowiki>[[#Anchor Name]]</nowiki></code> are not equivalent.

== Linking to an anchor ==

To link to an anchor from within the same page, use <code><nowiki>[[#Anchor name|display text]]</nowiki></code>. {{#ifeq:{{BASEPAGENAME}}|Visible anchor|&nbsp;Unlike {{tl|Anchor}}, the first parameter will be visible text on the page.|}} To link to an anchor from another page, use <code><nowiki>[[Article name#Anchor name|display text]]</nowiki></code>. {{crossref|See [[WP:ANCHOR|Help:Link § Section linking (anchors)]] for more details.}}

Note that <code><nowiki>#</nowiki>{{var|Anchor name}}</code>, used by the [[MediaWiki]] software to (usually) direct users to sections within a page, is not a [[wikitext]] directive like [[Help:Redirect|<syntaxhighlight lang="wikitext" inline>#REDIRECT</syntaxhighlight>]].

== Limitations ==
{| class="wikitable floatright" style="text-align: center;"
|-
! Character
! [[Character entity reference|Code]]
! Template
! [[Help:Magic words|Magic word]]
! Meaning
|-
| &quot;
| <code>&amp;quot;</code><br /><code>&amp;#34;</code>
| {{N/a}}
| {{N/a}}
| (double)&nbsp;[[quotation mark]]
|-
| &#35;
| <code>&amp;#35;</code><br /><code>&amp;num;</code>
| {{tlx|hash}}
| {{N/a}}
| [[Number sign|hash]]
|-
| &#124;
| <code>&amp;#124;</code><br /><code>&amp;vertbar;</code>
| {{tlx|pipe}}
| {{tlx|!}}
| [[Vertical bar|pipe]]
|-
| &#61;
| <code>&amp;#61;</code><br /><code>&amp;equals;</code>
| {{N/a}}
| {{tlx|{{=}}}}
| [[Equals sign|equals]]
|}
* 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 "&amp;#" codes shown for them here. Or, the pipe symbol and equals sign can be worked around with {{tlx|!}} and {{tlx|{{=}}}}, respectively. Markup code such as {{tag|sup|o}} and {{tag|sub|o}} (superscript and subscript) cannot be used. Most other characters, including white space and punctuation, are not a problem.
* Anchor names must be unique on a page, and must not duplicate any heading titles. Duplicate anchors will not work as expected since the <code><nowiki>#location</nowiki></code> links go to the first anchor with that name. Duplicate anchors result in invalid HTML; you can check for duplicate anchors by running the page through the [[W3C Markup Validation Service]].
* Anchor links are case-sensitive in '''some''' browsers, so treat all anchor links as case-sensitive when creating links to them. For example, if you create the anchor with <code><nowiki>=== Baz{{subst:anchor|Bar}} ===</nowiki></code>, link to it with <code><nowiki>[[pagename#Bar]]</nowiki></code>, not <code><nowiki>[[pagename#bAR]]</nowiki></code>. However, because some browsers are '''not''' case-sensitive, do not create section titles or anchors that differ only in case from others on the page. That is, do not create both <code><nowiki>=== Abcd{{subst:anchor|Baz}} ===</nowiki></code> and <code><nowiki>=== Efgh{{subst:anchor|bAZ}} ===</nowiki></code>.
* If a template is left unsubstituted inside a section title ([[#Rationale for substitution in the header|which should never be done]]), then the template code will appear in the edit summary window each time a section edit of that section begins, as in {{nowrap|1=<code><nowiki>/* Limitations{{anchor|Issues}} */ New issue</nowiki></code>}}. The editor must manually remove the anchor template from the edit summary window, or else when they save the section, the browser may not return to the section and the section link of that edit in the history page won't work.

== Use in tables ==
{{Warning|To see how to set anchors in tables, see {{section link|Help:Tables and locations|Section link or map link to a row anchor}}. Only use this template in tables if you need multiple anchors for the same row.}}
Anchors may be used within tables, subject to certain restrictions. The {{tlx|anchor}} template may be used in the caption and cells of a table, but not those portions of a table that are outside the caption and cells. Unlike in section headings, the template does not have to be substituted. It is used on the table's caption thus:
<syntaxhighlight lang="wikitext">
|+ {{anchor|FooX}} A table caption
</syntaxhighlight>
and the following forms of cell are valid:
<syntaxhighlight lang="wikitext">
! {{anchor|Foo1}} A header cell
! style="background:white;" |{{anchor|Foo2}} A header cell with styling
|{{anchor|Foo3}} A data cell
| rowspan="2" |{{anchor|Foo4}} A data cell spanning two rows
</syntaxhighlight>
You need to ensure that the {{tlx|anchor}} is not in that portion of the markup intended for the classes, styles etc. Thus, {{tlx|anchor}} cannot be placed anywhere on lines that begin with <code><nowiki>{|</nowiki></code> (start of table) or <code><nowiki>|-</nowiki></code> (new row), and the following forms of cell are not valid:
<syntaxhighlight lang="wikitext">
! {{anchor|Foo1}} | A header cell
! style="background: white;" {{anchor|Foo2}} | A header cell with styling
| {{anchor|Foo3}} | A data cell
| rowspan="2" {{anchor|Foo4}} | A data cell spanning two rows
</syntaxhighlight>
If it is necessary for an anchor to be in any of these positions, a different technique is used—the <code>id=</code> attribute. This is placed in that portion of the markup where the classes, styles etc. may be used, as follows:
<syntaxhighlight lang="wikitext">
{| id="FooX" class="wikitable"
|- id="FooY"
! id="Foo1" | A header cell
! style="background: white;" id="Foo2" | A header cell with styling
| id="Foo3" | A data cell
| rowspan="2" id="Foo4" | A data cell spanning two rows
</syntaxhighlight>
The <code>id=</code> attribute may appear before, between or after any other attributes that may be present, but only one <code>id=</code> attribute may be used in each of these areas.

If <code><nowiki>{{anchor}}</nowiki></code> is placed at the start of a vertically centered cell (which is the default for tables) then links to the anchor will jump to the start of the displayed content and not the top of the cell. This may require the reader to scroll up to fully see other cells in the row. It can be avoided by instead placing <code>id=</code> where the row code starts.

== Rationale for substitution in the header<span class="anchor" id="Rationale for placement above header"></span><span class="anchor" id="substitution_reason_anchor"></span><span class="anchor" id="Rationale"></span> ==
<!-- The anchor "Rationale for placement above header" is the old name of this section. -->
{{shortcut|WP:ANCHORSUBST}}

Anchors should never be left unsubstituted within a section header, as this violates [[MOS:HEADINGS]] and causes technical complications. More specifically: if {{tlx|anchor}} is used without substitution, the anchor will be included in page editing history as part of the section name (see [[MOS:SECTIONANCHOR]] for details).

To show why placement in the header is preferred, the following anchor is placed in the Basic format section header:
:<code style="color:darkgreen;"><nowiki>== Basic format<span class="anchor" id="Foo"></span><span class="anchor" id="In-Foo"></span> ==</nowiki></code>

Since the anchor is actually used on this documentation page, the links [[#Basic format]], [[#Foo]] and [[#In-Foo]] all work and can be tested to see the effect.

For contrast, an anchor named [[#Under-Foo]] has also been placed underneath the Basic format section header and can be clicked to illustrate how this placement hides the section title when jumping to the linked target on some web browsers:
:<code>== Basic format ==<br/><nowiki>{{anchor|Under-Foo}}</nowiki></code>

Another anchor named [[#Above-Foo]] has been placed above the section header. This anchor does work correctly for standard desktop skins, but because the anchor is technically not in the section but before it, mobile views will not expand the desired section, and it cannot be edited by [[WP:SECTIONEDIT|editing the section]].
:<code><nowiki>{{anchor|Above-Foo}}</nowiki><br/>== Basic format ==</code>

== Explanations and examples ==

Reasons for the above being best practice are detailed in the following additional, numbered examples, as well as in [[#Limitations|§&nbsp;Limitations]] section:

# <code style="color:darkgreen;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}|Foo<nowiki>}}</nowiki></code> <br /> could be linked to with <code><nowiki>[[#Foo|...]]</nowiki></code> from ''within the same article'' (let's call this article "Qux"), <br /> or it could be linked to with {{nowrap|<code><nowiki>[[</nowiki>Qux#Foo<nowiki>|...]]</nowiki></code>}} from ''other'' articles and from redirects (where the ellipsis after the word "Foo" here means the words chosen to represent that link in the Wikipedia article, which, of course, could be anything).
# Anchors can be more suitable for inter-article linking than section titles are, because anchors are more stable. For example a section title {{nowrap|1=<code>== Foo ==</code>}} within a Wikipedia article titled <code>Qux</code>: <br /> {{nowrap|1=<code style="color:dimgray;"><nowiki>==</nowiki>{{sp}}<code style="color:darkgreen;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}<nowiki>|Foo bar}}</nowiki></code>{{sp}}Foo <nowiki>==</nowiki></code>}} <br /> Here, links via {{nowrap|1=<code><nowiki>[[</nowiki>Qux#Foo bar<nowiki>]]</nowiki></code>}} would remain valid even if the section were renamed: {{nowrap|1=<code><nowiki>== {{anchor|Foo bar}} On foo and its many friends ==</nowiki></code>}}<br /> A drawback of this approach (as detailed in [[#Limitations|§&nbsp;Limitations]] section) is that having a template in the section header causes problems with the edit summary window each time that a section edit is done for this section. The obvious solution is to place the anchor ''before'' the section. This also prevents browsers from hiding the section title from view when jumping to the target.<br /> {{anchor|Example-note}}{{em|Note:}} The anchor name (<code>Foo bar</code>) should be different than the section (<code>Foo</code>) to avoid invalid HTML.
# Within section titles, it may be preferable to simply use direct HTML, which may be achieved by [[WP:substitution|substitution]] like this:<br /> {{nowrap|1=<code style="color:dimgray;"><nowiki>==</nowiki>{{sp}}Foo<code style="color:darkgreen;"><nowiki>{{subst:anchor|Foo bar}}</nowiki></code>{{sp}}<nowiki>==</nowiki></code>}}<br />which is saved into the article as:<br /> {{nowrap|1=<code style="color:dimgray;"><nowiki>==</nowiki>{{sp}}Foo<code style="color:darkgreen;">{{code|1={{anchor|Foo bar}}}}</code>{{sp}}<nowiki>==</nowiki></code>}}<br />This provides the stable, linkable anchor, but without the edit problem.<br /> The [[#Example-note|Note]] above still applies. See [[#Limitations|§&nbsp;Limitations]] for details.
# Here is a more literal example:<br /> Say you wrote an article about a recently discovered Indo-European language called "Yish Yash". The title of your article would probably be "Yish Yash language" (if there were already an article titled "Yish Yash" that covered the culture generally). Now let's say that within your article you wished to have a section titled "The placement of the tongue when producing Yish Yash vowel sounds". You would create a section heading that looked like this:<br />{{nowrap|1=<code><nowiki>== The placement of the tongue when producing Yish Yash vowel sounds == </nowiki></code>}}<br />Let's say that you then finished up writing and saved the new article. Now, say you came across another article on Wikipedia titled "Proto-Indo-European vowels" which happened to have a section on the unique tongue placement used in Yish Yash. You decided it might be useful here for readers to be able to quickly access the section of your article on Yish Yash tongue placement when forming vowels; however, you don't want to send them to the beginning of the whole article on the Yish Yash language (you wanted to target them more specifically). So you create a link in the Proto-Indo European vowel article to the ''section'' within ''your'' article on the placement of the tongue in Yish Yash: you might do so by editing the text of the Proto-Indo-European vowel article and adding something like this to a relevant place within it:<br /><code><nowiki>[[Yish Yash language#The placement of the tongue when producing Yish Yash vowel sounds|Yish Yash tongue placement]] is particularly interesting.</nowiki></code><br />That is some ''really'' long code, but it would create a direct link to the relevant section of the new Yish Yash language article and would look like this in the article on Proto-Indo-European vowels:<br /> "...<span style="color:blue;">Yish Yash tongue placement</span> is particularly interesting..." <br /> Now let's say another editor came along and wished to change the heading of this section of your article for some legitimate reason—perhaps to "Yish Yash vowels and the tongue". They could do so by editing your article and making the section heading look like this:<br />{{nowrap|1=<code><nowiki>== Yish Yash vowels and the tongue ==</nowiki></code>}}<br />Unbeknownst to that editor, this would mean the link in the article on Proto-Indo-European vowels that you created earlier would now go by default to the top of the Yish Yash article instead of your carefully-chosen subsection! However, if an ''anchor'' were placed within the section heading of the Yish Yash article either when you created it or when the other editor came along and changed it—perhaps something like this:<br />{{nowrap|1= <code><nowiki>== The placement of the tongue when producing Yish Yash vowel sounds{{subst:anchor|Tongue}} ==</nowiki></code>}}<br />or like this:<br />{{nowrap|1=<code><nowiki>== Yish Yash vowel–tongue interaction{{subst:anchor|Tongue}} ==</nowiki></code>}}<br />and the text of the article on Proto-Indo-European vowels had been changed by you to something like this:<br />{{nowrap|1=<code><nowiki>[[Yish Yash language#Tongue|Yish Yash tongue placement]] is particularly interesting.</nowiki></code>}}<br />then the link from the Proto-Indo-European article would continue to point to the relevant ''section'' of the Yish Yash article, even if the wording of the section heading there had changed completely and without the reader having to sort it out for themselves. The use of anchors can make for a cleaner, more efficient Wikipedia reading experience where section headings are changed—which they not infrequently are.

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>{
	"description": "Add HTML anchors to a page. Make a link to your anchor with [[#Anchor on same page]] or [[Page you're linking to#Anchor on that page]]. Every anchor on a page must be different. Do not use the characters \" or # or | or =.",
	"params": {
		"1": {
			"label": "First anchor",
			"type": "string",
			"required": true,
			"description": "Name of anchor",
			"example": "Anchor name 1"
		},
		"2": {
			"label": "Second anchor",
			"type": "string",
			"required": false,
			"description": "Name of anchor"
		},
		"3": {
			"label": "Third anchor",
			"type": "string",
			"required": false,
			"description": "Name of anchor"
		},
		"4": {
			"label": "Fourth anchor",
			"description": "To add more than four anchors, go to source editing.",
			"type": "string",
			"required": false
		}
	},
	"format": "inline"
}</templatedata>

== See also ==
* {{Tl|Anchor comment}}
* {{Tl|Anchored list}}
* {{Tl|Shortcut}}
* {{#ifeq:{{BASEPAGENAME}}|Visible anchor|{{tl|Anchor}}|{{tl|Visible anchor}}}}
* {{Tl|Section link}}
* [[WP:ANCHOR]]
* [[WP:TARGET]]
<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, AND INTERWIKIS TO WIKIDATA, THANKS -->
[[Category:Wikipedia XHTML tag-replacing templates]]
[[Category:Wikipedia section templates]]
[[Category:Templates with no visible output]]
}}</includeonly>