Template:For multi/doc

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

Usage

Zero parameters

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.

Output and comparison

The output with zero parameter is:

Which is the same as using {{Other uses}}:

One or two parameters

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.

Output and comparison

The output with one parameter is:

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

The output with two parameters is:

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

Three or more parameters

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.

Output and comparison

The output with three parameter is:

This is different from {{For}}, where providing three parameters would produce:

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:

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 is this way would look like:

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:

The above example produces a link to Template:For multi/doc (disambiguation) at the end.

Multiple articles per use

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}} outputs:

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:For multi in articles based on its TemplateData.

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.

Template parameters
This template prefers inline formatting of parameters.
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".	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.	String	required
Other page 2	`4`	The title of the second other page. If unused or blank and parameter 4 exists, defaults to "[page title] (disambiguation)".	Page name	optional
Other use 3	`5`	What the third other use of the title is.	String	optional
Other page 3	`6`	The title of the third other page. If unused or blank and parameter 6 exists, defaults to "[page title] (disambiguation)".	Page name	optional
Other use 4	`7`	What the fourth other use of the title is.	String	optional
Other page 4	`8`	The title of the fourth other page. If unused or blank and parameter 8 exists, defaults to "[page title] (disambiguation)".	Page name	optional

v t e Hatnote templates
Wikipedia:Hatnote Wikipedia:Disambiguation Wikipedia:Redirect
Generic	{{Hatnote}} {{Selfref}} (for self-references)
For and about	{{For}} {{For2}} (for custom text) {{For multi}} (for multiple uses) {{About}} Variations: {{Other uses}} {{Other uses of}}
Other topics	{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other places}} {{Other ships}} {{Other hurricanes}}
Redirect	{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Technical reasons}}
Distinguish	{{Distinguish}} (supports custom text too) {{Redirect-distinguish}} {{Redirect-distinguish2}} (for custom text) {{Redirect-distinguish6}} {{About-distinguish}} {{About-distinguish2}} (for custom text)
For use in sections	{{Main}} {{Further}} {{Further2}} (for custom text) {{Further ill}} {{See also}} {{See also if exists}} {{For outline}}
Special	{{Broader}} {{See introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific	{{Year dab}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}} {{Other MeSH codes}}
Category:Hatnote templates modules for [family] names for lists hatnote templates for category pages