Changes
Jump to navigation
Jump to search
Undid revision 874816793 by Hydrargyrum (talk) wrong on both counts: for the first, see Special:Diff/874816157 - the link is there, although grey not blue so you may not have spotted i...
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{missing information|it describes only things about [[template:anchor]] not this one, it tells nothing about how it looks and when it should be used and so the distinctions to the usual template anchor.}}
{{tsh|visanc|vanchor}}
The template {{tnull|Visible anchor}} inserts one or more [[HTML element#Anchor|HTML anchors]] in a page. Those locations can then be linked to using <code><nowiki>[[#link|...]]</nowiki></code> syntax. Unlike {{tl|Anchor}}, the '''first parameter''' will be visible text on the page.
== Usage ==
1. <code style="color:green;"><nowiki>{{</nowiki>visible anchor|foo<nowiki>}}</nowiki></code>
: '''Visible as:''' foo
: '''Linkable as:''' <code><nowiki>[[#foo|...]]</nowiki></code> from within the same article, <code><nowiki>[[</nowiki>''<small>articlename</small>''#foo|...<nowiki>]]</nowiki></code> from other articles and from redirects.
2. The template can be used to create up to ten anchors with a single call. Here's an example using the <code>vhanchor</code> [[#Aliases|shortcut]]:
: <code style="color:green;"><nowiki>{{</nowiki>vanchor|foo|bar|baz<nowiki>}}</nowiki></code>
: '''Visible as:''' foo
: '''Linkable as:'''<code><nowiki>[[#foo]]</nowiki></code>, <code><nowiki>[[#bar]]</nowiki></code> and <code><nowiki>[[#baz]]</nowiki></code>.
: Note how only the first parameter is made visible in the rendered text.
=== Limitations ===
{|class="wikitable" style="float:right"
|---
! Character
! [[Character entity reference|Code]]
! Template
! Meaning
|---
| 
| <code>&quot;</code> <br /><code>&#34;</code>
| {{N/a}}
| (double) [[quotation mark]]
|---
| #
| <code>&#35;</code>
| {{N/a}}
| [[Number sign|hash]]
|---
| |
| <code>&#124;</code>
| {{tl|!}}
| [[Vertical bar|pipe]]
|---
| =
| <code>&#61;</code>
| {{tl|{{=}}}}
| [[Equals sign|equals]]
|}
* '''This template should not be used within section headings.''' Doing so will result in broken links in edit summaries, as well as possible duplicate anchors (see below).
* 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; you can check for duplicate anchors by running the page through the [[W3C Markup Validation Service]].
* 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 "&#" 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.
* As with other templates which use positional parameters, putting each anchor name on separate lines, for example {{clear}}{{pre|<nowiki>{{</nowiki>vanchor<br/>|humpty<br />|dumpty<nowiki>}}</nowiki>}} will not work as expected.
=== TemplateData ===
{{TemplateDataHeader}}
<templatedata>
{
"params": {
"1": {
"label": "Anchor name, and text to display",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting; you can put formatting in the \"text\" parameter instead.",
"example": "start-of-content",
"type": "string",
"required": true
},
"2": {
"label": "Second anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string",
"suggested": true
},
"3": {
"label": "Third anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"4": {
"label": "Fourth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"5": {
"label": "Fifth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"6": {
"label": "Sixth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"7": {
"label": "Seventh anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"8": {
"label": "Eighth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"9": {
"label": "Ninth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"10": {
"label": "Tenth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"text": {
"label": "Display text",
"description": "Overrides the display of parameter 1, but is not an anchor name. May be formatted.",
"example": "Properties of CO<sub>2</sub>",
"type": "content",
"suggested": true
}
},
"description": "The template {{Visible anchor}} inserts one or more HTML anchors in a page. Those locations can then be linked to using [[#link|...]] syntax. Unlike {{Anchor}}, the first parameter will be visible text on the page."
}
</templatedata>
=== Aliases ===
* {{tl|visanc}}
* {{tl|vanchor}}
== See also ==
* {{tl|Anchor}}
* {{tl|Anchored list}}
* {{tl|Shortcut}}
* [[Help:Link#Section linking (anchors)|Help:Link § Section linking (anchors)]] (Shortcut: [[WP:ANCHOR]])
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- CATEGORIES HERE, THANKS -->
[[Category:Wikipedia formatting and function templates]]
}}</includeonly>
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{missing information|it describes only things about [[template:anchor]] not this one, it tells nothing about how it looks and when it should be used and so the distinctions to the usual template anchor.}}
{{tsh|visanc|vanchor}}
The template {{tnull|Visible anchor}} inserts one or more [[HTML element#Anchor|HTML anchors]] in a page. Those locations can then be linked to using <code><nowiki>[[#link|...]]</nowiki></code> syntax. Unlike {{tl|Anchor}}, the '''first parameter''' will be visible text on the page.
== Usage ==
1. <code style="color:green;"><nowiki>{{</nowiki>visible anchor|foo<nowiki>}}</nowiki></code>
: '''Visible as:''' foo
: '''Linkable as:''' <code><nowiki>[[#foo|...]]</nowiki></code> from within the same article, <code><nowiki>[[</nowiki>''<small>articlename</small>''#foo|...<nowiki>]]</nowiki></code> from other articles and from redirects.
2. The template can be used to create up to ten anchors with a single call. Here's an example using the <code>vhanchor</code> [[#Aliases|shortcut]]:
: <code style="color:green;"><nowiki>{{</nowiki>vanchor|foo|bar|baz<nowiki>}}</nowiki></code>
: '''Visible as:''' foo
: '''Linkable as:'''<code><nowiki>[[#foo]]</nowiki></code>, <code><nowiki>[[#bar]]</nowiki></code> and <code><nowiki>[[#baz]]</nowiki></code>.
: Note how only the first parameter is made visible in the rendered text.
=== Limitations ===
{|class="wikitable" style="float:right"
|---
! Character
! [[Character entity reference|Code]]
! Template
! Meaning
|---
| 
| <code>&quot;</code> <br /><code>&#34;</code>
| {{N/a}}
| (double) [[quotation mark]]
|---
| #
| <code>&#35;</code>
| {{N/a}}
| [[Number sign|hash]]
|---
| |
| <code>&#124;</code>
| {{tl|!}}
| [[Vertical bar|pipe]]
|---
| =
| <code>&#61;</code>
| {{tl|{{=}}}}
| [[Equals sign|equals]]
|}
* '''This template should not be used within section headings.''' Doing so will result in broken links in edit summaries, as well as possible duplicate anchors (see below).
* 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; you can check for duplicate anchors by running the page through the [[W3C Markup Validation Service]].
* 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 "&#" 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.
* As with other templates which use positional parameters, putting each anchor name on separate lines, for example {{clear}}{{pre|<nowiki>{{</nowiki>vanchor<br/>|humpty<br />|dumpty<nowiki>}}</nowiki>}} will not work as expected.
=== TemplateData ===
{{TemplateDataHeader}}
<templatedata>
{
"params": {
"1": {
"label": "Anchor name, and text to display",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting; you can put formatting in the \"text\" parameter instead.",
"example": "start-of-content",
"type": "string",
"required": true
},
"2": {
"label": "Second anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string",
"suggested": true
},
"3": {
"label": "Third anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"4": {
"label": "Fourth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"5": {
"label": "Fifth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"6": {
"label": "Sixth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"7": {
"label": "Seventh anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"8": {
"label": "Eighth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"9": {
"label": "Ninth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"10": {
"label": "Tenth anchor name",
"description": "This will become an anchor. The characters \", #, | and = must be escaped; see the main template page for details. Do not try to use formatting.",
"type": "string"
},
"text": {
"label": "Display text",
"description": "Overrides the display of parameter 1, but is not an anchor name. May be formatted.",
"example": "Properties of CO<sub>2</sub>",
"type": "content",
"suggested": true
}
},
"description": "The template {{Visible anchor}} inserts one or more HTML anchors in a page. Those locations can then be linked to using [[#link|...]] syntax. Unlike {{Anchor}}, the first parameter will be visible text on the page."
}
</templatedata>
=== Aliases ===
* {{tl|visanc}}
* {{tl|vanchor}}
== See also ==
* {{tl|Anchor}}
* {{tl|Anchored list}}
* {{tl|Shortcut}}
* [[Help:Link#Section linking (anchors)|Help:Link § Section linking (anchors)]] (Shortcut: [[WP:ANCHOR]])
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- CATEGORIES HERE, THANKS -->
[[Category:Wikipedia formatting and function templates]]
}}</includeonly>
