Template:Broader/doc

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.

Usage
&#123;{broader|article}}
 * Basic usage:

&#123;{broader|article|topic}}
 * With a topic:

&#123;{broader|article|topic|selfref=yes|category=no}}
 * All parameters:

Parameters
This template accepts the following parameters:
 * - 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.
 * - the name of the topic. If this is not specified, the text "this topic" is used.
 * - 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.
 * - 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

 * &rarr;
 * &rarr;

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  ). Please use   instead.
 * 2) Some parameters were specified, but the page name wasn't included. For example, the template text   will produce this error. Please use (for example)   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   will produce this error. To work around this, you can specify the parameter name explictly by using   before the page name, like this:.
 * 4) You tried to access Module:Broader directly by using  . Use of #invoke in this way has been disabled for performance reasons. Please use   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.

{ "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": "string", "required": true },   "2": {      "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." } } }