This is an archive copy of wikilivres.ca as of 18 February 2017 (from the WikiTeam dump). The original site is closed.
Template:Anchor/documentation: Difference between revisions
Jump to navigation
Jump to search
imported>-jkb- m 72 revisions |
imported>-jkb- modified |
||
| Line 1: | Line 1: | ||
===Description=== | ===Description=== | ||
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 HTML anchors in a page. Those locations can then be linked to using <code><nowiki>[[#link|...]]</nowiki></code> syntax. | ||
===Examples=== | ===Examples=== | ||
| Line 25: | Line 19: | ||
===Limitations=== | ===Limitations=== | ||
* Anchor names that contain | * Anchor names that contain the number sign # (hash), vertical bar | (pipe), equals sign = (equal) will not work as expected. Most other characters, including white space and punctuation are not a problem. | ||
* Anchors cannot be placed in the middle of other wiki syntax. For example, <code style="color:green;"><nowiki>==Heading{{</nowiki>{{lc:{{BASEPAGENAME}}}}|foo<nowiki>}}==</nowiki></code> will not work. | * Anchors cannot be placed in the middle of other wiki syntax. For example, <code style="color:green;"><nowiki>==Heading{{</nowiki>{{lc:{{BASEPAGENAME}}}}|foo<nowiki>}}==</nowiki></code> will not work. | ||
* 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. | ||
| Line 34: | Line 28: | ||
* Anchor names should be unique (with respect to all heading titles and additional anchors) on each page; multiple anchors won't work as expected since the #links will always go to the first anchor with that name. | * Anchor names should be unique (with respect to all heading titles and additional anchors) on each page; multiple anchors won't work as expected since the #links will always go to the first anchor with that name. | ||
* Unlike section headings, anchors may not work on some (very old) browsers. This is because section headings are tagged with the more backward-compatible <code><nowiki><a name="heading" id="heading"></a></nowiki></code>. Such tagging cannot be achieved with templates. | * Unlike section headings, anchors may not work on some (very old) browsers. This is because section headings are tagged with the more backward-compatible <code><nowiki><a name="heading" id="heading"></a></nowiki></code>. Such tagging cannot be achieved with templates. | ||
Revision as of 18:26, 1 November 2009
Description
The template {{anchor}} inserts one or more HTML anchors in a page. Those locations can then be linked to using [[#link|...]] syntax.
Examples
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,
==Section title=={{anchor|foo}}- 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
- Anchor names that contain the number sign # (hash), vertical bar | (pipe), equals sign = (equal) will not work as expected. Most other characters, including white space and punctuation are not a problem.
- Anchors cannot be placed in the middle of other wiki syntax. For example,
==Heading{{anchor|foo}}==will not work. - The template can create a maximum of 10 anchors. Specifying more than 10 anchors will result in an error message.
- Care should be taken to ensure that names are on a single line: For example,
{{anchor|humpty
dumpty}}- will probably not work as expected.
- Anchor names should be unique (with respect to all heading titles and additional anchors) on each page; multiple anchors won't work as expected since the #links will always go to the first anchor with that name.
- Unlike section headings, anchors may not work on some (very old) browsers. This is because section headings are tagged with the more backward-compatible
<a name="heading" id="heading"></a>. Such tagging cannot be achieved with templates.