Template:Anchor/doc: Difference between revisions
(Created page with '{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> The template <nowiki>{{</nowiki>[[{{ns:Template}}:{{BASEPAGENAME}}|{{lc:{{BASE…') |
m (Text replacement - " " to " ") |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
The template <nowiki>{{</nowiki>[[{{ns:Template}}:{{BASEPAGENAME}}|{{lc:{{BASEPAGENAME}}}}]]<nowiki>}}</nowiki> inserts one or more [[ | The template <nowiki>{{</nowiki>[[{{ns:Template}}:{{BASEPAGENAME}}|{{lc:{{BASEPAGENAME}}}}]]<nowiki>}}</nowiki> inserts one or more [[Help: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=== | ===Examples=== | ||
| Line 23: | Line 23: | ||
===Limitations=== | ===Limitations=== | ||
* Anchor names that contain [[Number sign|#]] (hash), [[Vertical_bar| | * Anchor names that contain [[Number sign|#]] (hash), [[Vertical_bar||]] (pipe), [[Equals sign|=]] (equal) will not work as expected. Markup code such as <nowiki><sup></sup> and <sub></sub></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. | * 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 | * Putting each anchor name on separate lines, for example | ||
| Line 36: | Line 36: | ||
* {{tl|Anchored list}} | * {{tl|Anchored list}} | ||
* {{tl|Section}} | * {{tl|Section}} | ||
* | * tl Shortcut | ||
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | <includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | ||
Latest revision as of 17:00, 30 October 2023
 |
This is a documentation subpage for Template:Anchor (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
The template {{anchor}} inserts one or more HTML anchors in a page. Those locations can then be linked to using [[#link|...]] syntax.
Examples[edit source]
1. {{anchor|foo}}
- could be linked to with [[#foo|...]] from within the same article,
- or it could be linked to with [[articlename#foo|...]] from other articles and from redirects.
2. Anchors can be more suitable for inter-article linking than section titles are. For example,
=={{anchor|foo}}Section title ==- Here, links via [[articlename#foo]] 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,
{{anchor|foo|bar|baz}}- will create three anchors that can then be linked to with [[#foo]], [[#bar]] and [[#baz]].
- Specifying more than 10 anchors will cause an error message to be displayed.
Limitations[edit source]
- Anchor names that contain # (hash), | (pipe), = (equal) will not work as expected. Markup code such as <sup></sup> and <sub></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.
- Putting each anchor name on separate lines, for example
{{anchor|humpty
|dumpty}}- 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 "/* {{anchor|Issues}}Limitations */ New issue". This can be fixed by deleting the template code from the edit summary before the changes are saved.
See also[edit source]
- {{Visible anchor}}
- {{Anchored list}}
- {{Section}}
- tl Shortcut