Editing Template:Broader/doc

{{Documentation subpage}}
{{Lua|Module:Broader}}

This template is used to make [[Wikipedia:Summary style|summary style]] explicit. It looks like this:

{{Broader|Article}}

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 {{tl|Main}}), a narrower topic (which should probably use {{tl|Further}}), or at the same level of focus (which should probably use {{tl|See also}}).

== Usage ==
{{see|WP:SUMMARYHATNOTE}}
; Basic usage: {{tlc|Broader|''article''}}
; With a topic: {{tlc|Broader|''article''|topic{{=}}''topic''}}
; With more than one target page: {{tlc|Broader|''article1''|''article2''|''article3''|topic{{=}}''topic''}}
; All parameters: {{tlc|Broader|''article''|topic{{=}}''topic''|selfref{{=}}''yes''|category{{=}}''no''}}

== Parameters ==

This template accepts the following parameters:
* <code>1</code> - the page to link to (required). Categories and files are automatically escaped with the [[wikipedia:Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.
* <code>2</code> (and greater numbers) - any additional pages to link to. These links are also automatically formatted as with the first parameter.
* <code>topic</code> - the name of the topic. If this is not specified, the text "this topic" is used.
* <code>selfref</code> - 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.
* <code>category</code> - 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 ==

* {{tlc|Broader|Article}} &rarr; {{Broader|Article}}
* {{tlc|Broader|Article|topic{{=}}some topic}} &rarr; {{Broader|Article|topic=some topic}}

== Errors ==

If no page name is supplied, the template will output the following message:
* {{Broader|category=no}}

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

If you see this error message and are unsure of what to do, please post a message on [[wikipedia:WP:HD|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 ==
*{{tl|Further}}
*{{tl|Redirect}}

{{Hatnote templates}}
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<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 [[wikipedia: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>
{{Collapse bottom}}

<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Cross-reference templates|{{PAGENAME}}]]
[[Category:Wikipedia page-section templates|{{PAGENAME}}]]
[[Category:Hatnote templates]]
}}</includeonly>