View source for Template:For multi/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Lua|Module:Hatnote|Module:Hatnote list}}

{{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 similar to {{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 ==
=== Zero 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.

==== Output and comparison ====
The output with zero parameter is: {{For multi}}

Which 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.

==== Output and comparison ====
The output with one parameter is: {{For multi|UseA}}

This is identical to passing the same arguments to {{tlx|For}}: {{For|UseA}}

The output with two parameters is: {{For multi|UseA|ArticleA}}

This is identical to passing the same arguments to {{tlx|For}}: {{For|UseA|ArticleA}}

=== Three or more parameters ===
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.

==== Output and comparison ====
The output with three parameter is: {{For multi|UseA|ArticleA|UseB}}

This is different from {{tlx|For}}, where providing three parameters would produce: {{For|UseA|ArticleA|ArticleB}}

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|ArticleA|UseB}}

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 is this way would look like: {{About||UseA|ArticleA|UseB}}

==== Last parameter ====
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}}

The above example produces a link to [[{{FULLPAGENAME}} (disambiguation)]] at the end.

==== Multiple articles per use ====
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 multi|UseA|ArticleA|and|ArticleB|and|ArticleC|UseB|ArticleD|and|ArticleE}}</code> outputs: {{For multi|UseA|ArticleA|and|ArticleB|and|ArticleC|UseB|ArticleD|and|ArticleE}}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"description": "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.",
	"params": {
		"1": {
			"label": "Other use 1",
			"type": "string",
			"description": "What the first other use of the title is. If unused or blank, defaults to \"For other uses\".",
			"required": true
		},
		"2": {
			"label": "Other page 1",
			"type": "wiki-page-name",
			"description": "The title of the first other page. If unused, defaults to \"[page title] (disambiguation)\".",
			"required": true
		},
		"3": {
			"label": "Other use 2",
			"type": "string",
			"description": "What the second other use of the title is.",
			"required": true
		},
		"4": {
			"label": "Other page 2",
			"type": "wiki-page-name",
			"description": "The title of the second other page. If unused or blank and parameter 4 exists, defaults to \"[page title] (disambiguation)\"."
		},
		"5": {
			"label": "Other use 3",
			"type": "string",
			"description": "What the third other use of the title is."
		},
		"6": {
			"label": "Other page 3",
			"type": "wiki-page-name",
			"description": "The title of the third other page. If unused or blank and parameter 6 exists, defaults to \"[page title] (disambiguation)\"."
		},
		"7": {
			"label": "Other use 4",
			"type": "string",
			"description": "What the fourth other use of the title is."
		},
		"8": {
			"label": "Other page 4",
			"type": "wiki-page-name",
			"description": "The title of the fourth other page. If unused or blank and parameter 8 exists, defaults to \"[page title] (disambiguation)\"."
		}
	},
	"format": "inline"
}
</templatedata>

{{Hatnote templates}}
<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Disambiguation and redirection templates]]
[[Category:Hatnote templates]]
}}</includeonly>