Difference between revisions of "Template:Broader/doc"
imported>Nihiltres (Removed see also of Template:Broader2; that now redirects here) |
imported>Nihiltres (Added detail on when this template should be used, tweaked display syntax for examples, and added mention of an alternative for escaping equals) |
||
| Line 5: | Line 5: | ||
{{broader|Article}} | {{broader|Article}} | ||
| − | It is used in sections for which there is also a separate article on the subject. | + | 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 == | == Usage == | ||
| − | ; Basic usage: | + | ; Basic usage: {{tlc|broader|''article''}} |
| − | + | ; With a topic: {{tlc|''article''|topic{{=}}''topic''}} | |
| − | + | ; With more than one target page: {{tlc|broader|''article1''|''article2''|''article3''|topic{{=}}''topic''}} | |
| − | ; With a topic: | + | ; All parameters: {{tlc|broader|''article''|topic{{=}}''topic''|selfref{{=}}''yes''|category{{=}}''no''}} |
| − | |||
| − | |||
| − | ; With more than one target page: | ||
| − | |||
| − | |||
| − | ; All parameters: | ||
| − | |||
== Parameters == | == Parameters == | ||
| Line 32: | Line 25: | ||
== Examples == | == Examples == | ||
| − | * | + | * {{tlc|broader|Article}} → {{broader|Article}} |
| − | * | + | * {{tlc|broader|Article|topic{{=}}some topic}} → {{broader|Article|topic=some topic}} |
== Errors == | == Errors == | ||
| Line 43: | Line 36: | ||
# No parameters were specified (the template code was <code><nowiki>{{broader}}</nowiki></code>). Please use <code><nowiki>{{broader|</nowiki>''page''<nowiki>}}</nowiki></code> instead. | # 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. | # 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 | + | # 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 [[WP:HD|the help desk]], and someone should be able to help you. | If you see this error message and are unsure of what to do, please post a message on [[WP:HD|the help desk]], and someone should be able to help you. | ||
Revision as of 16:56, 19 April 2020
| 40px | This is a documentation subpage for Template:Broader. It contains usage information, categories and other content that is not part of the original template page. |
| 30px | This template uses Lua: |
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}}).
Contents
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:
- No parameters were specified (the template code was
{{broader}}). Please use{{broader|page}}instead. - 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. - 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 using1=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
- {{Further}}
TemplateData documentation used by VisualEditor and other tools
| ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
See the monthly parameter usage report for this template.
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.
| ||||||||||||||||||||||||||||||||||||||||