Template:Main list/sandbox

This is the template sandbox page for Template:Main list (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

Shortcut

{{more}}

This template uses Lua:

Module:Main list

This template is used to make summary style explicit. It looks like this:

It is used in sections for which there is also a separate more comprehensive list article on the subject.

Usage[edit]

Basic usage

{{Main list|article}}

With a topic

{{Main list|article 1|article 2}}

All parameters

{{Main list|article 1|article 2|category=no}}

Parameters[edit]

This template accepts the following parameters:

1 - the page to link to (required). Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as page § section, rather than the MediaWiki default of page#section.
2 - a second page (optional). Same implications as the first parameter apply.
category - if set to "no", "n", "false", or "0", suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the first positional parameter (the page to link to) is omitted.

Examples[edit]

{{Main list|Wikipedia:Hatnote#Hatnote templates}} →
{{Main list|Wikipedia:Hatnote#Hatnote templates|Wikipedia:Template messages/Cleanup#Cleanup}} →

Errors[edit]

If no page name is supplied, the template will output the following message:

Error: no page name specified (help).

If you see this error message, it is for one of three reasons:

No parameters were specified (the template code was {{Main list}}). Please use {{Main list|page}} instead.
The page name was specified, but it contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code {{Main list|2+2=4}} will produce this error. To work around this, you can specify the parameter name explicitly by using 1= before the page name, like this: {{Main list|1=2+2=4}}.
You tried to access Module:Main list directly by using {{#invoke:Main list|mainList|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use {{Main list|text}} instead.

If you see this error message and are unsure of what to do, please post a message on the help desk, and someone should be able to help you.

Pages that contain this error message are tracked in Category:Hatnote templates with errors.

Alternative[edit]

For cases where the present context provides no short list to which this template "a more comprehensive list" wording could refer, see the template {{Main listing}}, which is just a pointer to the list article.

TemplateData[edit]

TemplateData documentation used by VisualEditor and other tools

See a monthly parameter usage report for Template:Main list in articles based on its TemplateData.

TemplateData for Main list

This template is used to show readers where to find more details about a particular topic. It is usually placed at the top of a section or article.

Template parameters[Edit template data]
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Article 1	`1`	The name of the article that you want to link to (required). Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as "page § section", rather than the MediaWiki default of "page#section".	String	required
Article 2	`2`	Name of the second article you want to link to (optional). Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as "page § section", rather than the MediaWiki default of "page#section".	String	optional
Category	`category`	Set to "no", "n", "false", or "0" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted. Auto value	Boolean	optional

v t e Hatnote templates
Wikipedia:Hatnote Wikipedia:Disambiguation Wikipedia:Redirect
Generic	{{Hatnote}} {{Self-reference}}
For and about	{{For}} {{For-text}} (for custom text) {{For-multi}} (for multiple uses) {{About}} Variations: {{Other uses}} {{Other uses of}} {{Redirect-distinguish-for}} {{About-distinguish}} {{About-distinguish-text}}
Other topics	{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other storms}} {{Other places}} {{Other ships}}
Redirect	{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Redirect-distinguish-text}} {{Redirect-distinguish-for}} {{Technical reasons}}
Distinguish	{{Distinguish}} (supports custom text) {{About-distinguish}} {{About-distinguish-text}} (for custom text) {{Redirect-distinguish}} {{Redirect-distinguish-text}} (for custom text) {{Redirect-distinguish-for}}
For use in sections	{{Main}} {{Main if exists}} {{Main list}} {{Further}} {{Further-text}} (for custom text) {{Further interlanguage link}} {{See also}} {{See also if exists}} {{See also-text}} (for custom text) {{For outline}} {{For timeline}}
Special	{{Broader}} {{For introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific	{{About year}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}}
Category:Hatnote templates modules for [family] names for lists hatnote templates for category pages