→Output and comparison: consistantancy
|
→3 or more parameters: 'nother example per talk page
|
||
(10 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{High-use}} |
|||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> |
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> |
||
{{Lua|Module:Hatnote|Module:Hatnote list}} |
{{Lua|Module:Hatnote|Module:Hatnote list}} |
||
{{tlx|For |
{{tlx|For-multi}} is a hatnote template that produces a list of alternative uses for the title of the article and links to articles about those uses. It is similarto {{tlx|For}} with the primary difference being this template allows multiple uses to be listed while still being able to link to multiple articles per use. It is essentially the same as {{tlx|About}} but without the about clause at the start. |
||
== |
==Usage== |
||
=== |
===0 parameters=== |
||
When no parameters are provided, this template functions the exact same as {{tlx|Other uses}}. It is preferred to use that template as it more clearly explains the output of the function. |
When no parameters are provided, this template functions the exact same as {{tlx|Other uses}}. It is preferred to use that template as it more clearly explains the output of the function. |
||
⚫ | The output with zero parameter {{tlc|For-multi}} is: {{For-multi}} |
||
==== Output and comparison ==== |
|||
⚫ | |||
'''Comparison to other templates''': |
|||
|
This is the same as using {{tlx|Other uses}}: {{Other uses}} |
||
=== |
===One or two parameters=== |
||
When one or two parameters are provided, this template functions the exact same as {{tlx|For}}. It is preferred to use that template as the "multi" functionality of this template is not required. |
When one or two parameters are provided, this template functions the exact same as {{tlx|For}}. It is preferred to use that template as the "multi" functionality of this template is not required. |
||
==== |
====1 Parameter==== |
||
The output with one parameter is: {{For multi|UseA}} |
|||
|
With one parameter, {{tlx|For-multi|UseA}} yields: {{For-multi|UseA}} |
||
'''Comparison to other templates''': |
|||
⚫ |
|
||
⚫ | This is identical to passing the same arguments to {{tlx|For}}. For example, {{tlx|For|UseA}} yields: {{For|UseA}} |
||
====2 Parameters==== |
|||
⚫ |
This is identical to passing the same arguments to {{tlx|For}} |
||
With two parameters, {{tlx|For-multi|UseA|ArticleA}} yields: {{For-multi|UseA|ArticleA}} |
|||
⚫ | |||
⚫ |
When three or more parameters are provided, this template can be used. Functionally, it is the same as {{tlx|About}}, but without the about clause at the beginning. Per the guideline at [[WP:HNS]], it is up to the editor to decide whether or not the hatnote should contain a brief summary (i.e. whether or not the hatnote should use {{tlx|For |
||
'''Comparison to other templates''': |
|||
==== Output and comparison ==== |
|||
|
This is identical to passing the same arguments to {{tlx|For}}. For example, {{tlx|For|UseA|ArticleA}} yields: {{For|UseA|ArticleA}} |
||
⚫ | |||
⚫ |
|
||
⚫ | When three or more parameters are provided, this template can be used. Functionally, it is the same as {{tlx|About}}, but without the about clause at the beginning. Per the guideline at [[WP:HNS]], it is up to the editor to decide whether or not the hatnote should contain a brief summary (i.e. whether or not the hatnote should use {{tlx|For-multi}} or {{tlx|About}}) based on their preference and what is likely to be clearer and easier for the reader. |
||
With three parameters, the output of |
|||
⚫ |
As you can see, this function is able to output multiple uses, unlike {{tlx|For}}. {{tlx|About}} also produces the same output, but with an about clause at the beginning: {{About|About|UseA| |
||
:{{tlx|For-multi|UseA|ArticleA|UseB}} |
|||
⚫ | |||
With four parameters, the output of |
|||
⚫ |
Technically, {{tlx|About}} can be used by passing an empty first parameter, but this isn't recommended as the wikitext <code>{{((}}About||UseA|ArticleA|UseB}}</code> doesn't make it clear what the output is going to be and what the purpose of the template is as, in this case, the name of the template "About" is misleading. Using |
||
:{{tlx|For-multi|UseA|ArticleA|UseB|ArticleB}} |
|||
is: {{For-multi|UseA|ArticleA|UseB|ArticleB}} |
|||
'''Comparison to other templates''': |
|||
⚫ | |||
⚫ | The output of {{tlx|For-multi|UseA|ArticleA|UseB}} is different from {{tlx|For}} provided with three parameters where {{tlx|For|UseA|ArticleA|ArticleB}} yields: {{For|UseA|ArticleA|ArticleB}} |
||
⚫ |
When the last parameter is a "use", the current article plus (disambiguation) will be linked to at the end of the template. For example |
||
⚫ | As you can see, this function is able to output multiple uses, unlike {{tlx|For}}. {{tlx|About}} also produces the same output, but with an about clause at the beginning. For example, {{tlx|About|About|UseA|ArticleA|UseB}} yields: {{About|About|UseA|ArticleA|UseB}} |
||
⚫ |
The above example produces a link to |
||
⚫ | Technically, {{tlx|About}} can be used by passing an empty first parameter, but this isn't recommended as the wikitext <code>{{((}}About||UseA|ArticleA|UseB}}</code> doesn't make it clear what the output is going to be and what the purpose of the template is as, in this case, the name of the template "About" is misleading. Using it this way would look like: {{About||UseA|ArticleA|UseB}} |
||
⚫ | |||
⚫ |
Multiple articles can be used per use by putting a parameter with the content <code>and</code> between them. For example the wikitext <code>{{((}}For |
||
⚫ | |||
⚫ | Multiple articles can be used per use by putting a parameter with the content <code>and</code> between them. For example, the wikitext <!-- formerly: <code>{{((}}For-multi|UseA|ArticleA|and|ArticleB|and|ArticleC|UseB|ArticleD|and|ArticleE}}</code> --> |
||
:{{tlx|For-multi|UseA|ArticleA|and|ArticleB|and|ArticleC|UseB|ArticleD|and|ArticleE}} |
|||
yields: {{For-multi|UseA|ArticleA|and|ArticleB|and|ArticleC|UseB|ArticleD|and|ArticleE}} |
|||
⚫ | |||
⚫ | When the last parameter is a "use", the current article plus (disambiguation) will be linked to at the end of the template. For example, |
||
:{{tlx|For-multi|UseA|ArticleA|UseB}} |
|||
yields: {{For-multi|UseA|ArticleA|UseB}} |
|||
⚫ | The above example produces a link to the PAGENAME (no namespace) at the end. |
||
== TemplateData == |
== TemplateData == |
||
Line 55: | Line 72: | ||
"label": "Other use 1", |
"label": "Other use 1", |
||
"type": "string", |
"type": "string", |
||
"description": "What the first other use of the title is. If unused or blank, defaults to \"For other uses\".", |
"description": "What the first other use of the title is. If unused or blank, defaults to \"For other uses\" and ignores parameters 3ff.", |
||
"required": true |
"required": true |
||
}, |
}, |
||
Line 67: | Line 84: | ||
"label": "Other use 2", |
"label": "Other use 2", |
||
"type": "string", |
"type": "string", |
||
"description": "What the second other use of the title is.", |
"description": "What the second other use of the title is. If unused or blank, defaults to \"For other uses\" and ignores parameters 5ff.", |
||
"required": true |
"required": true |
||
}, |
}, |
||
Line 73: | Line 90: | ||
"label": "Other page 2", |
"label": "Other page 2", |
||
"type": "wiki-page-name", |
"type": "wiki-page-name", |
||
"description": "The title of the second other page. If unused or blank and parameter |
"description": "The title of the second other page. If unused or blank and parameter 3 exists, defaults to \"[page title] (disambiguation)\"." |
||
}, |
}, |
||
"5": { |
"5": { |
||
"label": "Other use 3", |
"label": "Other use 3", |
||
"type": "string", |
"type": "string", |
||
"description": "What the third other use of the title is." |
"description": "What the third other use of the title is. If unused or blank, defaults to \"For other uses\" and ignores parameters 7ff." |
||
}, |
}, |
||
"6": { |
"6": { |
||
"label": "Other page 3", |
"label": "Other page 3", |
||
"type": "wiki-page-name", |
"type": "wiki-page-name", |
||
"description": "The title of the third other page. If unused or blank and parameter |
"description": "The title of the third other page. If unused or blank and parameter 5 exists, defaults to \"[page title] (disambiguation)\"." |
||
}, |
}, |
||
"7": { |
"7": { |
||
"label": "Other use 4", |
"label": "Other use 4", |
||
"type": "string", |
"type": "string", |
||
"description": "What the fourth other use of the title is." |
"description": "What the fourth other use of the title is. If unused or blank, defaults to \"For other uses\"." |
||
}, |
}, |
||
"8": { |
"8": { |
||
"label": "Other page 4", |
"label": "Other page 4", |
||
"type": "wiki-page-name", |
"type": "wiki-page-name", |
||
"description": "The title of the fourth other page. If unused or blank and parameter |
"description": "The title of the fourth other page. If unused or blank and parameter 7 exists, defaults to \"[page title] (disambiguation)\"." |
||
} |
} |
||
}, |
}, |
||
Line 99: | Line 116: | ||
} |
} |
||
</templatedata> |
</templatedata> |
||
==See also== |
|||
* [[:Category:Disambiguation and redirection templates]] |
|||
* {{tl|Disambiguation}} – for helping readers find other articles with the same or similar names. Placed at the bottom of the article. |
|||
* {{tl|For}} – hatnote linking to multiple articles or disambiguation pages; e.g. ''For similar terms, see ArticleA, ArticleB, and ArticleC.'' |
|||
* {{tl|Other uses}} – hatnote linking to a disambiguation pages; e.g. ''For other uses, see Target (disambiguation).'' |
|||
* {{tl|Redirect}} – for linking to disambiguation pages in an article that is [[WP:PRIMARYREDIRECT|the primary topic of a redirect]] |
|||
* {{tl|WikiProject Disambiguation}} – for disambig talkpages |
|||
* [[Wikipedia:Hatnote]] |
|||
{{Hatnote templates}} |
{{Hatnote templates}} |
||
<includeonly>{{sandbox other|| |
<includeonly>{{sandbox other|| |
||
<!-- Categories below this line; interwikis at Wikidata --> |
<!-- Categories below this line; interwikis at Wikidata --> |
||
[[Category:Disambiguation and redirection templates]] |
[[Category:Disambiguation and redirection templates]] |
||
[[Category:Hatnote templates]] |
[[Category:Hatnote templates]] |
||
}}</includeonly> |
}}</includeonly> |
This is a documentation subpage for Template:For-multi. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 10,000 pages and changes may be widely noticed. Test changes in the template's /sandboxor/testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template uses Lua:
|
{{For-multi}}
is a hatnote template that produces a list of alternative uses for the title of the article and links to articles about those uses. It is similar to {{For}}
with the primary difference being this template allows multiple uses to be listed while still being able to link to multiple articles per use. It is essentially the same as {{About}}
but without the about clause at the start.
When no parameters are provided, this template functions the exact same as {{Other uses}}
. It is preferred to use that template as it more clearly explains the output of the function.
The output with zero parameter {{For-multi}}
is:
Comparison to other templates:
This is the same as using {{Other uses}}
:
When one or two parameters are provided, this template functions the exact same as {{For}}
. It is preferred to use that template as the "multi" functionality of this template is not required.
With one parameter, {{For-multi|UseA}}
yields:
Comparison to other templates:
This is identical to passing the same arguments to {{For}}
. For example, {{For|UseA}}
yields:
With two parameters, {{For-multi|UseA|ArticleA}}
yields:
Comparison to other templates:
This is identical to passing the same arguments to {{For}}
. For example, {{For|UseA|ArticleA}}
yields:
When three or more parameters are provided, this template can be used. Functionally, it is the same as {{About}}
, but without the about clause at the beginning. Per the guideline at WP:HNS, it is up to the editor to decide whether or not the hatnote should contain a brief summary (i.e. whether or not the hatnote should use {{For-multi}}
or{{About}}
) based on their preference and what is likely to be clearer and easier for the reader.
With three parameters, the output of
{{For-multi|UseA|ArticleA|UseB}}
is:
With four parameters, the output of
{{For-multi|UseA|ArticleA|UseB|ArticleB}}
is:
Comparison to other templates:
The output of {{For-multi|UseA|ArticleA|UseB}}
is different from {{For}}
provided with three parameters where {{For|UseA|ArticleA|ArticleB}}
yields:
As you can see, this function is able to output multiple uses, unlike {{For}}
. {{About}}
also produces the same output, but with an about clause at the beginning. For example, {{About|About|UseA|ArticleA|UseB}}
yields:
Technically, {{About}}
can be used by passing an empty first parameter, but this isn't recommended as the wikitext {{About||UseA|ArticleA|UseB}}
doesn't make it clear what the output is going to be and what the purpose of the template is as, in this case, the name of the template "About" is misleading. Using it this way would look like:
Multiple articles can be used per use by putting a parameter with the content and
between them. For example, the wikitext
{{For-multi|UseA|ArticleA|and|ArticleB|and|ArticleC|UseB|ArticleD|and|ArticleE}}
yields:
When the last parameter is a "use", the current article plus (disambiguation) will be linked to at the end of the template. For example,
{{For-multi|UseA|ArticleA|UseB}}
yields:
The above example produces a link to the PAGENAME (no namespace) at the end.
TemplateData for For-multi
This template lists multiple other uses for the title and links to articles about those uses. See the documentation for more information on usage and alternatives.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Other use 1 | 1 | What the first other use of the title is. If unused or blank, defaults to "For other uses" and ignores parameters 3ff. | String | required |
Other page 1 | 2 | The title of the first other page. If unused, defaults to "[page title] (disambiguation)". | Page name | required |
Other use 2 | 3 | What the second other use of the title is. If unused or blank, defaults to "For other uses" and ignores parameters 5ff. | String | required |
Other page 2 | 4 | The title of the second other page. If unused or blank and parameter 3 exists, defaults to "[page title] (disambiguation)". | Page name | optional |
Other use 3 | 5 | What the third other use of the title is. If unused or blank, defaults to "For other uses" and ignores parameters 7ff. | String | optional |
Other page 3 | 6 | The title of the third other page. If unused or blank and parameter 5 exists, defaults to "[page title] (disambiguation)". | Page name | optional |
Other use 4 | 7 | What the fourth other use of the title is. If unused or blank, defaults to "For other uses". | String | optional |
Other page 4 | 8 | The title of the fourth other page. If unused or blank and parameter 7 exists, defaults to "[page title] (disambiguation)". | Page name | optional |