Template:Broader/doc: Difference between revisions
m (Updated TemplateData) |
(Added documentation of extra parameters) |
||
Line 13: | Line 13: | ||
; With a topic: |
; With a topic: |
||
{{broader|''article''|topic=''topic''}} |
{{broader|''article''|topic=''topic''}} |
||
; With more than one target page: |
|||
{{broader|''article1''|''article2''|''article3''|topic=''topic''}} |
|||
; All parameters: |
; All parameters: |
||
Line 21: | Line 24: | ||
This template accepts the following parameters: |
This template accepts the following parameters: |
||
* <code>1</code> - the page to link to (required). Categories and files are automatically escaped with the [[Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''. |
* <code>1</code> - the page to link to (required). Categories and files are automatically escaped with the [[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>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:Selfref]] for more information. |
* <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:Selfref]] for more information. |
||
Line 60: | Line 64: | ||
"type": "string", |
"type": "string", |
||
"required": true |
"required": true |
||
}, |
|||
"2": { |
|||
"label": "Article 2", |
|||
"description": "The name of an additional article that you want to link to", |
|||
"type": "string", |
|||
"required": false |
|||
}, |
|||
"3": { |
|||
"label": "Article 3", |
|||
"description": "The name of an additional article that you want to link to", |
|||
"type": "string", |
|||
"required": false |
|||
}, |
|||
"4": { |
|||
"label": "Article 4", |
|||
"description": "The name of an additional article that you want to link to", |
|||
"type": "string", |
|||
"required": false |
|||
}, |
}, |
||
"topic": { |
"topic": { |
Revision as of 19:30, 18 April 2020
This is a documentation subpage for Template:Terminate sentence It contains usage information, categories and other content that is not part of the original template page. |
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
- 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: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}}
.
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
| ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Click here to see a monthly parameter usage report for this template based on this 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.
|