Template:Broader/doc

From TWC Archive
Jump to navigation Jump to search

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
{{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: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}}
  • {{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 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

ParameterDescriptionTypeStatus
Article1

The name of the article that you want to link to

Stringrequired
Article 22

The name of an additional article that you want to link to

Stringoptional
Article 33

The name of an additional article that you want to link to

Stringoptional
Article 44

The name of an additional article that you want to link to

Stringoptional
Topictopic

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

Stringoptional
Self referenceselfref

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]]".)

Lineoptional
Categorycategory

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.

Unknownoptional