Template:Broader

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

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

Further information: WP:SUMMARYHATNOTE
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}}
  • {{Broader|Article|topic=some topic}}

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:

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

See also

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

TemplateData for Broader

<templatedata> { "description": "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.", "params": { "1": { "label": "Article", "description": "The name of the article that you want to link to", "type": "wiki-page-name", "required": true }, "2": { "label": "Article 2", "description": "The name of an additional article that you want to link to", "type": "wiki-page-name", "required": false }, "3": { "label": "Article 3", "description": "The name of an additional article that you want to link to", "type": "wiki-page-name", "required": false }, "4": { "label": "Article 4", "description": "The name of an additional article that you want to link to", "type": "wiki-page-name", "required": false }, "topic": { "label": "Topic", "description": "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...'", "type": "string", "required": false }, "selfref": { "type": "string/line", "label": "Self reference", "description": "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\".)" }, "category": { "label": "Category", "description": "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." } } } </templatedata>