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

This template uses Lua:

Module:Broader

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 article on the subject. It should be used when there should be a link to another article that discusses a subject more broadly, but is not a main article (which should use ((Main))), a narrower topic (which should probably use ((Further))), or at the same level of focus (which should probably use ((See also))).

Usage

Basic usage: ((Broader|article))
With a topic: ((Broader|article|topic=topic))
With more than one target page: ((Broader|article1|article2|article3|topic=topic))
All parameters: ((Broader|article|topic=topic|selfref=yes|category=no))

Parameters

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 (and greater numbers) - any additional pages to link to. These links are also automatically formatted as with the first parameter.
topic - the name of the topic. If this is not specified, the text "this topic" is used.
selfref - if set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See Template:Self ref for more information.
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

((Broader|Article)) →
For broader coverage of this topic, see Article.
((Broader|Article|topic=some topic)) →
For broader coverage of some topic, see Article.

Errors

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 four reasons:

No parameters were specified (the template code was ((Broader))). Please use ((Broader|page)) instead.
Some parameters were specified, but the page name wasn't included. For example, the template text ((Broader|selfref=yes)) will produce this error. Please use (for example) ((Broader|page|selfref=yes)) 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 ((Broader|2+2=4)) will produce this error. To work around this, you can specify the parameter name explictly by using 1= before the page name (like this: ((Broader|1=2+2=4))) or you can disable the equals being interpreted as delimiting a parameter name by surrounding the equals with double braces (like this: ((Broader|2+2((=))4))).

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.

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

TemplateData documentation used by VisualEditor and other tools

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

TemplateData for Broader

This template is used to show readers where to find broader coverage related to a particular topic. It is usually placed at the top of a section or article.

Template parameters[Edit template data]
Parameter		Description	Type	Status
Article	`1`	The name of the article that you want to link to	Page name	required
Article 2	`2`	The name of an additional article that you want to link to	Page name	optional
Article 3	`3`	The name of an additional article that you want to link to	Page name	optional
Article 4	`4`	The name of an additional article that you want to link to	Page name	optional
Topic	`topic`	A brief description of the topic related to which a broader coverage will be provided. If left blank, the template will read 'For broader coverage related to this topic...'	String	optional
Self reference	`selfref`	Set to "yes" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. "For the Wikipedia Sandbox, see [[WP:SAND]]".)	Line	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.	Unknown	optional

The above documentation is transcluded from Template:Broader/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.