View source for Template:Anchor/doc

The template {{tlg|anchor}} inserts one or more invisible HTML fragment identifiers (anchor names) in a page. Those locations can then be linked to using <code><nowiki>[[#Location|...]]</nowiki></code> syntax. Note that <code><nowiki>#Location</nowiki></code> here is not a browser instruction like <code><nowiki>#REDIRECT</nowiki></code>—the word “Location” can be any word you wish to associate with any part of an article in which you decide to place the {{tlg|code=yes|nolink=yes|anchor}} template, and can be entirely arbitrary; also, the first letter of the location is usually capitalised to reflect the common capitalisation used in section headers.

{{anchor|Foo|Foo bar}}
== Usages ==

<code><nowiki>{{</nowiki>anchor|Foo|Foo bar}}

== Examples ==</code>

[[#Examples]], [[#Foo]] and [[#Foo bar]] all work.

== Best practices ==

Reasons for the above being best practice are detailed in the following additional, numbered examples, as well as in {{section link||Limitations}}:

* {{tlg|code=yes|nolink=yes|anchor|Foo}} could be linked to with <code><nowiki>[[#Foo|...]]</nowiki></code> from within the same article (let’s call this article “Qux”), or it could be linked to with {{nowrap|<code><nowiki>[[</nowiki>Qux#Foo<nowiki>|...]]</nowiki></code>}} from other articles and from redirects.


* 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 an article titled                       {{code|Qux}}:
:: {{nowrap|<code><nowiki>== {{anchor|Foo bar}} Foo ==</nowiki></code>}}
: Here, links via {{nowrap|<code><nowiki>[[Qux#Foo bar]]</nowiki></code>}} would remain valid even if the section were renamed. A drawback of this approach (as detailed in {{section link||Limitations}}) 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. Note: The anchor is placed before the section name; otherwise browsers may hide the section title from view. Also, the anchor name ({{code|Foo bar}}) should be different than the section ({{code|Foo}}) to avoid invalid HTML.


* Within section titles, it may be preferable to simply use direct HTML, which may be achieved by substitution like this:
:: {{nowrap|<code><nowiki>== {{subst:anchor|Foo bar}} Foo ==</nowiki></code>}}
: which is saved into the article as:
:: {{nowrap|<code><nowiki>== <span id="Foo bar"></span> Foo ==</nowiki></code>}}
: This provides the stable, linkable anchor, but without the edit problem. The note above still applies. See {{section link||Limitations}} for details.


* The template can be used to create multiple anchors with a single call. For example:
:: {{nowrap|<code><nowiki>{{anchor|Foo|Bar|baz}}</nowiki></code>}}
: will create three anchors that can then be linked to with <code><nowiki>[[#Foo]]</nowiki></code>, <code><nowiki>[[#Bar]]</nowiki></code> and <code><nowiki>[[#baz]]</nowiki></code>.

=== Limitations ===

{|class="wikitable"
! Character
! Code
! Template
! Meaning
|-
| "
| {{code|&amp;quot;}}<br>{{code|&amp;#34;}}
|
| double quotation mark
|-
| #
| {{code|&amp;#35;}}
|
| hash
|-
| &#124;
| {{code|&amp;#124;}}
| {{tlg|code=yes|nolink=yes|!}}
| pipe
|-
| &#61;
| {{code|&amp;#61;}}
| {{tlg|code=yes|{{=}}}}
| equals sign
|}

* Anchor names that contain any character shown in the table will not work as expected. However, any of these characters can be replaced with the codes. The pipe symbol and equals sign can be worked around with {{tlg|code=yes|nolink=yes|!}} and {{tlg|code=yes|nolink=yes|{{=}}}}, 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. They result in invalid HTML.

* 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>=== {{anchor|Bar}} Baz ===</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>=== {{anchor|Baz}} Abcd ===</nowiki></code> and <code><nowiki>=== {{anchor|bAZ}} Efgh ===</nowiki></code>.

* If a template is inside a section title then the template code will appear in the edit summary window each time a section edit of that section begins, as in {{nowrap|"<code><nowiki>/* {{anchor|Issues}}Limitations */ New issue</nowiki></code>"}}. The editor must manually fix the section title part of the edit summary window, or when the section is saved, the browser may not return to the section and the section link of that edit in the history page doesn’t work. When using anchor in a section title, consider substituting the template, resulting in <code><nowiki><span id="..."></span></nowiki></code> being saved.

=== Use in tables ===

Anchors may be used within tables, subject to certain restrictions. The {{tlg|code=yes|nolink=yes|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. It is used on the table’s caption thus:

<syntaxhighlight lang=text>
|+ {{anchor|FooX}} A table caption
</syntaxhighlight>

and the following forms of cell are valid:

<syntaxhighlight lang=text>
! {{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 {{tlg|code=yes|nolink=yes|anchor}} is not in that portion of the markup intended for the classes, styles etc. Thus, {{tlg|code=yes|nolink=yes|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=text>
! {{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{{=}}}} attribute. This is placed in that portion of the markup where the classes, styles etc. may be used, as follows:

<syntaxhighlight lang=text>
{| 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{{=}}}} attribute may appear before, between or after any other attributes that may be present, but only one {{code|id{{=}}}} attribute may be used in each of these areas.

[[Category:Templates]][[Category:Templates documentation]]