Template:Anchor/doc - Revision history

Fritigern: Docpage does not want to be added to category. Why???

2011-10-21T08:46:10Z

Docpage does not want to be added to category. Why???

Fritigern at 08:44, 21 October 2011

2011-10-21T08:44:16Z

Fritigern: Created page with "{{Documentation subpage}} The template {{[[{{ns:Template}}:{{BASEPAGENAME}}|{{lc:{{BASE..."

2011-10-21T08:39:01Z

Created page with "{{Documentation subpage}}  The template <nowiki>{{</nowiki>[[{{ns:Template}}:{{BASEPAGENAME}}|{{lc:{{BASE..."

New page

{{Documentation subpage}}


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>[[#link|...]]</nowiki></code> syntax. {{#ifeq:{{BASEPAGENAME}}|Visible anchor| Unlike {{tl|Anchor}}, the first parameter will be visible text on the page.|}}

===Examples===
1. <code style="color:green;"><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 <tt><nowiki>[[</nowiki>''articlename''#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,
:<code style="color:gray;"><nowiki>==</nowiki> <code style="color:green;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}|foo<nowiki>}}</nowiki></code> Section title <nowiki>==</nowiki></code>
:Here, links via <tt><nowiki>[[</nowiki>''articlename''#foo<nowiki>]]</nowiki></tt> would remain valid even if the section were renamed.

3. The template can be used to create up to ten anchors with a single call. For example,
: <code style="color:green;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}|foo|bar|baz<nowiki>}}</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| 
 
4. If the text to be displayed must differ from the anchor (e.g. because it contains brackets for linking), the <code style="color:green;">text</code> parameter can be used:
: <code style="color:green;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}<nowiki>|foo|text=[[foo]]}}</nowiki></code>
: this will result in a link that constitutes an anchor of its own|}}

===Limitations===
* Anchor names that contain [[Number sign|#]] (hash), [[Vertical_bar||]] (pipe), [[Equals sign|=]] (equal) will not work as expected. However, the latter can be worked around with {{tl|{{=}}}}; a redirect with "=" in its name will link properly to an anchor with <nowiki>{{=}}</nowiki>. Markup code such as <nowiki> and </nowiki> (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.
* Putting each anchor name on separate lines, for example
:<code style="color:green;"><nowiki>{{</nowiki>{{lc:{{BASEPAGENAME}}}}
:|humpty |dumpty<nowiki>}}</nowiki></code>
:will probably not work as expected.
* 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, so you can check for duplicate anchors by consulting 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 <nowiki>"/* {{anchor|Issues}}Limitations */ New issue"</nowiki>. This can be fixed by deleting the template code from the edit summary before the changes are saved.

<includeonly>
{{DEFAULTSORT:{{PAGENAME}}}}
[[Category:Templates]]

</includeonly>

@@ Line 32: / Line 32: @@
 * 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 <nowiki>"/* {{anchor|Issues}}Limitations */ New issue"</nowiki>. This can be fixed by deleting the template code from the edit summary before the changes are saved.
 [[Category:Template documentation pages]]
 {{DEFAULTSORT:{{PAGENAME}}}}
 </includeonly>