Template:Broader/doc

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

For broader coverage of this topic, see Article.

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

Usage

Basic usage

{{broader|article}}

With a topic

{{broader|article|topic}}

All parameters

{{broader|article|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 - 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:Selfref 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|some topic}} →
  For broader coverage of this topic, see Article and some topic.

Errors

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

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

1. No parameters were specified (the template code was {{broader}}). Please use {{broader|page}} instead.
2. 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.
3. 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}}.
4. You tried to access Module:Broader directly by using {{#invoke:broader|broader|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use {{broader|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.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this 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 Parameter Description Type Status Article 1 The name of the article that you want to link to String required Topic 2 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