Brontekst bekijken van Sjabloon:Anchor/doc

{{Documentation subpage}}
{{high-use|20,000+}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS LINKS AT THE END OF THIS PAGE -->

The template <nowiki>{{</nowiki>[[{{ns:Template}}:{{BASEPAGENAME}}|{{lc:{{BASEPAGENAME}}}}]]<nowiki>}}</nowiki> inserts one or more [[HTML element#Anchor|HTML anchor]]s in a page. Those locations can then be linked to using <code><nowiki>[[#location|…]]</nowiki></code> syntax. {{#ifeq:{{BASEPAGENAME}}|Visible anchor|&nbsp;Unlike {{tl|Anchor}}, the first parameter will be visible text on the page.|}}

=== Examples ===

1. <code style="color:darkgreen;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}|Foo<nowiki>}}</nowiki></code> 
: could be linked to with <tt><nowiki>[[#Foo|…]]</nowiki></tt> from within the same article, 
: or it could be linked to with {{nowrap|<tt><nowiki>[[</nowiki>''<small>Article name</small>''#Foo<nowiki>|…]]</nowiki></tt>}} from other articles and from redirects.

2. Anchors can be more suitable for inter-article linking than section titles are. For example: 
:{{nowrap|1=<code style="color:dimgray;"><nowiki>==</nowiki><span>{{sp}}</span><code style="color:darkgreen;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}<nowiki>|Foo}}</nowiki></code><span>{{sp}}</span>Section title <nowiki>==</nowiki></code>}} 
:Here, links via {{nowrap|1=<tt><nowiki>[[</nowiki>''Article name''#Foo<nowiki>]]</nowiki></tt>}} would remain valid even if the section were renamed. Consider using {{tlsp|anchor comment}} after the section title to generate a [[HTML]] comment alerting other editors to the purpose of anchors used in this manner. See [[#Limitations|Limitations]] for the editing problems this use introduces. 
:The following is an example of what '''not''' to do: 
:{{nowrap|1=<code style="color:dimgray;"><nowiki>==</nowiki> Section title<span>{{sp}}</span><code style="color:darkred;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}<nowiki>|Bar}}</nowiki></code><span>{{sp}}</span><nowiki>==</nowiki></code>}} 
:Here, the link {{nowrap|1=<tt><nowiki>[[</nowiki>''Article name''#Bar<nowiki>]]</nowiki></tt>}} would take the user to the section, but could undesirably hide the section title from view.

3. The template can be used to create up to ten anchors with a single call. For example, 
: {{nowrap|1=<code style="color:darkgreen;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}<nowiki>|Foo|Bar|baz}}</nowiki></code>}} 
:will create three anchors that can then be linked to with <tt><nowiki>[[#Foo]]</nowiki></tt>, <tt><nowiki>[[#Bar]]</nowiki></tt> and <tt><nowiki>[[#baz]]</nowiki></tt>. 
:Specifying more than 10 anchors will cause an error message to be displayed.{{#ifeq:{{BASEPAGENAME}}|Visible anchor| <br /> 
<br />
4. If the text to be displayed must differ from the anchor (e.g. because it contains brackets for linking), the <code style="color:darkgreen;">text</code> parameter can be used: 
: {{nowrap|1=<code style="color:darkgreen;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}<nowiki>|Foo|text=[[Foo]]}}</nowiki></code>}} 
: this will result in a link that constitutes an anchor of its own.|}}

=== Limitations ===

{|class="wikitable" style="float:right"
!Character
![[Character entity reference|Code]]
!Template
!Meaning
|-
|&quot;
|<code>&amp;quot;</code> <br /><code>&amp;#34;</code>
|{{N/a}}
|(double)&nbsp;[[quotation mark]]
|-
|&#35;
|<code>&amp;#35;</code>
|{{N/a}}
|[[Number sign|hash]]
|-
|&#124;
|<code>&amp;#124;</code>
|{{tl|!}}
|[[Vertical bar|pipe]]
|-
|&#61;
|<code>&amp;#61;</code>
|{{tl|{{=}}}}
|[[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 {{tl|!}} and {{tl|{{=}}}}, 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.
* The template can create a maximum of 10 anchors. Specifying more than 10 anchors will result in an error message.
* Unlike with most templates, putting each anchor name on separate lines will not work as expected; for example: 
:<code style="color:darkred;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}
:|humpty<br />|dumpty<nowiki>}}</nowiki></code>
* Anchor names should be unique on a page, and should 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]].
* If the template is added to a section title then the code will appear in the edit summary when that section is edited, as in {{nowrap|1="<code><nowiki>/* {{anchor|Issues}}Limitations */ New issue</nowiki></code>"}}. This can be fixed by deleting the template code from the edit summary before the changes are saved. However, this fix breaks the section link in the article revision history. Consider using {{tlsp|anchor comment}} after the section title to generate a HTML comment alerting other editors to the purpose of anchors used in this manner, so they do not move the anchor out of the section heading when they notice the deleterious effects on their edit summary.
* Anchor links are case sensitive in some browsers, so treat all anchor links as case sensitive.

=== See also ===
* {{#ifeq:{{BASEPAGENAME}}|Visible anchor|{{tl|Anchor}}|{{tl|Visible anchor}}}}
* {{tl|Anchored list}}
* {{tl|Anchor comment}}
* {{tl|Shortcut}}
* [[WP:ANCHOR]]
* [[WP:TARGET]]

<includeonly>

<!-- CATEGORIES AND INTERWIKIS LINKS HERE, THANKS -->
[[Category:Wikipedia formatting and function templates]]

</includeonly>