Template:About/doc: Difference between revisions
*>SamB Highlight '''and''' as a literal among placeholders |
*>SamB Correct/expand the TemplateData |
||
| Line 5: | Line 5: | ||
*{{Tlx|About|USE1|<nowiki/>|PAGE2}} → {{About|USE1||PAGE2}} | *{{Tlx|About|USE1|<nowiki/>|PAGE2}} → {{About|USE1||PAGE2}} | ||
*{{Tlx|About|USE1|USE2|PAGE2}} → {{About|USE1|USE2|PAGE2}} | *{{Tlx|About|USE1|USE2|PAGE2}} → {{About|USE1|USE2|PAGE2}} | ||
*{{Tlx|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: | 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: | ||
| Line 11: | Line 11: | ||
*{{Tlx|About|USE1||PAGE2|<nowiki>section=yes</nowiki>}} → {{About|USE1||PAGE2|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|<nowiki>section=yes</nowiki>}} → {{About|USE1|USE2|PAGE2|section=yes}} | ||
*{{Tlx|About|USE1|USE2|PAGE2| | *{{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 more options, find "{{Tlf|About}}" in the text below. | ||
| Line 20: | Line 20: | ||
==TemplateData== | ==TemplateData== | ||
{{TemplateDataHeader}} | {{TemplateDataHeader}} | ||
<!-- Should this mention the existance of "and"? It's something of a can of worms, since it only looks as though it only works in certain combinations of the other page 2/3/4 description fields... --> | |||
<templatedata> | <templatedata> | ||
{ | { | ||
| Line 37: | Line 38: | ||
"3": { | "3": { | ||
"label": "Other page 1 title", | "label": "Other page 1 title", | ||
"type": " | "type": "wiki-page-name", | ||
"description": "The title of the first other page. If unused, defaults to \"[page title] (disambiguation)\"." | "description": "The title of the first other page. If unused, defaults to \"[page title] (disambiguation)\"." | ||
}, | }, | ||
| Line 47: | Line 48: | ||
"5": { | "5": { | ||
"label": "Other page 2 title", | "label": "Other page 2 title", | ||
"type": "wiki-page-name", | |||
"description": "The title of the second other page. If unused, defaults to \"[page title] (disambiguation)\"." | |||
}, | |||
"6": { | |||
"label": "Other page 3 description", | |||
"type": "string", | "type": "string", | ||
"description": "The title of the | "description": "What the third other page is about. If unused or blank, defaults to \"For other uses\"." | ||
}, | |||
"7": { | |||
"label": "Other page 3 title", | |||
"type": "wiki-page-name", | |||
"description": "The title of the third other page. If unused, defaults to \"[page title] (disambiguation)\"." | |||
}, | |||
"8": { | |||
"label": "Other page 4 description", | |||
"type": "string", | |||
"description": "What the fourth other page is about. If unused or blank, defaults to \"For other uses\"." | |||
}, | |||
"9": { | |||
"label": "Other page 4 title", | |||
"type": "wiki-page-name", | |||
"description": "The title of the fourth other page. If unused, defaults to \"[page title] (disambiguation)\"." | |||
}, | |||
"section": { | |||
"type": "string", | |||
"description": "Pass \"yes\" in this parameter to get wording appropriate for use at the top of a section", | |||
"autovalue": "yes" | |||
} | } | ||
} | } | ||
} | } | ||
</templatedata> | </templatedata> | ||
<!-- To add more other pages, continue with this alternating pattern using increasing numbers, starting with 6 for the next page description. --> | |||
<includeonly> | <includeonly> | ||
<!-- ADD CATEGORIES BELOW THIS LINE --> | <!-- ADD CATEGORIES BELOW THIS LINE --> | ||
Revision as of 17:46, 24 June 2015
Script error: No such module "Message box".
{{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}}→ Script error: No such module "about".{{About|USE1||PAGE2}}→ Script error: No such module "about".{{About|USE1|USE2|PAGE2}}→ Script error: No such module "about".{{About|USE1|USE2|PAGE2|and|PAGE3}}→ Script error: No such module "about".
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}}→ Script error: No such module "about".{{About|USE1|PAGE2|section=yes}}→ Script error: No such module "about".{{About|USE1|USE2|PAGE2|section=yes}}→ Script error: No such module "about".{{About|USE1|USE2|PAGE2|and|PAGE3|section=yes}}→ Script error: No such module "about".
For more options, find "{{About}}" in the text below.
For reference, see Wikipedia:hatnotes and documentation below. Template:Hatnote templates documentation
TemplateData
See the monthly error report for this template.
TemplateData for 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": "wiki-page-name", "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": "wiki-page-name", "description": "The title of the second other page. If unused, defaults to \"[page title] (disambiguation)\"." }, "6": { "label": "Other page 3 description", "type": "string", "description": "What the third other page is about. If unused or blank, defaults to \"For other uses\"." }, "7": { "label": "Other page 3 title", "type": "wiki-page-name", "description": "The title of the third other page. If unused, defaults to \"[page title] (disambiguation)\"." }, "8": { "label": "Other page 4 description", "type": "string", "description": "What the fourth other page is about. If unused or blank, defaults to \"For other uses\"." }, "9": { "label": "Other page 4 title", "type": "wiki-page-name", "description": "The title of the fourth other page. If unused, defaults to \"[page title] (disambiguation)\"." }, "section": { "type": "string", "description": "Pass \"yes\" in this parameter to get wording appropriate for use at the top of a section", "autovalue": "yes" } } } </templatedata>