Template:About/doc: Difference between revisions
(#REDIRECT User:John Clifford) |
m (1 revision imported) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | |||
{{ombox|type=content|text=This template should not be used unless other topics exist with names very similar to the name of the article it is being used on (which, for most articles, is not the case).}} | |||
{{Tlc|About}} is a commonly used hatnote [[WP:Template message|template]] on Wikipedia, and should be placed at the top of an article, linking the reader to other articles with similar titles or concepts that they may have been seeking instead. The template has several formats, including: | |||
*{{Tlx|About|USE1}} → {{About|USE1}} | |||
*{{Tlx|About|USE1|<nowiki/>|PAGE2}} → {{About|USE1||PAGE2}} | |||
*{{Tlx|About|USE1|USE2|PAGE2}} → {{About|USE1|USE2|PAGE2}} | |||
*{{Tlx|About|USE1|USE2|PAGE2|and|PAGE3}} → {{About|USE1|USE2|PAGE2|and|PAGE3}} | |||
Alternately, a <code>section=yes</code> parameter can be added to the {{Tlc|About}} template for use at the top of a section. When using this parameter, the wording in the template changes to specify that it is being used in a section: | |||
*{{Tlx|About|USE1|<nowiki>section=yes</nowiki>}} → {{About|USE1|section=yes}} | |||
*{{Tlx|About|USE1||PAGE2|<nowiki>section=yes</nowiki>}} → {{About|USE1||PAGE2|section=yes}} | |||
*{{Tlx|About|USE1|USE2|PAGE2|<nowiki>section=yes</nowiki>}} → {{About|USE1|USE2|PAGE2|section=yes}} | |||
*{{Tlx|About|USE1|USE2|PAGE2|and|PAGE3|<nowiki>section=yes</nowiki>}} → {{About|USE1|USE2|PAGE2|and|PAGE3|section=yes}} | |||
For more options, find "{{Tlf|About}}" in the text below. | |||
For reference, see [[Wikipedia:hatnotes]] and documentation below. | |||
{{Hatnote templates documentation}} | |||
==TemplateData== | |||
{{TemplateDataHeader}} | |||
<templatedata> | |||
{ | |||
"description": "This template is a hatnote in the format \"This page is about … For other uses …\".", | |||
"params": { | |||
"1": { | |||
"label": "Page description", | |||
"type": "string", | |||
"required": true, | |||
"description": "What the page this template is placed on is about (\"This page is about …\")" | |||
}, | |||
"2": { | |||
"label": "Other page 1 description", | |||
"type": "string", | |||
"description": "What the first other page is about. If unused or blank, defaults to \"For other uses\"." | |||
}, | |||
"3": { | |||
"label": "Other page 1 title", | |||
"type": "string", | |||
"description": "The title of the first other page. If unused, defaults to \"[page title] (disambiguation)\"." | |||
}, | |||
"4": { | |||
"label": "Other page 2 description", | |||
"type": "string", | |||
"description": "What the second other page is about. If unused or blank, defaults to \"For other uses\"." | |||
}, | |||
"5": { | |||
"label": "Other page 2 title", | |||
"type": "string", | |||
"description": "The title of the second other page. If unused, defaults to \"[page title] (disambiguation)\". To add more other pages, continue with this alternating pattern using increasing numbers, starting with 6 for the next page description." | |||
} | |||
} | |||
} | |||
</templatedata> | |||
<includeonly> | |||
<!-- ADD CATEGORIES BELOW THIS LINE --> | |||
[[Category:Disambiguation and redirection templates|{{PAGENAME}}]] | |||
[[Category:Hatnote templates]] | |||
</includeonly> | |||
Latest revision as of 08:39, 18 December 2014
 | This template should not be used unless other topics exist with names very similar to the name of the article it is being used on (which, for most articles, is not the case). |
{{About}} is a commonly used hatnote template on Wikipedia, and should be placed at the top of an article, linking the reader to other articles with similar titles or concepts that they may have been seeking instead. The template has several formats, including:
{{About|USE1}}→This page is about USE1. For other uses, see About/doc (disambiguation).{{About|USE1||PAGE2}}→This page is about USE1. For other uses, see PAGE2.{{About|USE1|USE2|PAGE2}}→This page is about USE1. For USE2, see PAGE2.{{About|USE1|USE2|PAGE2|and|PAGE3}}→
Alternately, a section=yes parameter can be added to the {{About}} template for use at the top of a section. When using this parameter, the wording in the template changes to specify that it is being used in a section:
{{About|USE1|section=yes}}→This section is about USE1. For other uses, see About/doc (disambiguation).{{About|USE1|PAGE2|section=yes}}→This section is about USE1. For other uses, see PAGE2.{{About|USE1|USE2|PAGE2|section=yes}}→This section is about USE1. For USE2, see PAGE2.{{About|USE1|USE2|PAGE2|and|PAGE3|section=yes}}→
For more options, find "{{About}}" in the text below.
For reference, see Wikipedia:hatnotes and documentation below.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TemplateData
About
<templatedata> { "description": "This template is a hatnote in the format \"This page is about … For other uses …\".", "params": { "1": { "label": "Page description", "type": "string", "required": true, "description": "What the page this template is placed on is about (\"This page is about …\")" }, "2": { "label": "Other page 1 description", "type": "string", "description": "What the first other page is about. If unused or blank, defaults to \"For other uses\"." }, "3": { "label": "Other page 1 title", "type": "string", "description": "The title of the first other page. If unused, defaults to \"[page title] (disambiguation)\"." }, "4": { "label": "Other page 2 description", "type": "string", "description": "What the second other page is about. If unused or blank, defaults to \"For other uses\"." }, "5": { "label": "Other page 2 title", "type": "string", "description": "The title of the second other page. If unused, defaults to \"[page title] (disambiguation)\". To add more other pages, continue with this alternating pattern using increasing numbers, starting with 6 for the next page description." } } } </templatedata>