Template:About/doc: Difference between revisions

From Pluribus Lore Wiki
Jump to navigation Jump to search
← Older edit
VisualWikitext
*>Wikid77
noted as a "template" & listed 4 common parameter formats, to avoid "shaggy dog story" of reading entire remainder of large documentation page
Cheese (talk | contribs)
Bureaucrats, masseditregexeditor, Administrators
1,355 edits
m 113 revisions imported
 
(35 intermediate revisions by 24 users not shown)
Line 1: Line 1:
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{Documentation subpage}}
{{Tl|About}} is a commonly used hatnote [[wp:Template|template]] on Wikipedia, and so 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 {{color|#515151|'''Template:About'''}} has several formats, including:
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
*<nowiki>{{About|USE1}}</nowiki>{{ns|12}} → {{ns}}This page is about USE1. For other uses, see [[hyperlink|Pagename (disambiguation)]].
{{High-risk| 105000+ }}
*<nowiki>{{About|USE1||PAGE2}}</nowiki>{{ns|7}} → {{ns}}This page is about USE1. For other uses, see [[hyperlink|PAGE2]].
{{ombox|type=content|text=This template should be used on articles only if other topics and articles exist with very similar names. For most articles, this is not true, so do not use this template on them.}}
*<nowiki>{{About|USE1|USE2|PAGE2}}</nowiki> → {{ns}}This page is about USE1. For USE2, see [[hyperlink|PAGE2]].
{{Lua|Module:About}}
*<nowiki>{{About|USE1|USE2|PAGE2|and|PAGE3}}</nowiki> → {{ns}}This page is about USE1. For USE2, see [[hyperlink|PAGE2]] and [[hyperlink|PAGE3]].
{{Tlc|About}} is a commonly used [[WP:Hatnote|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:
*{{Tlx|About|Use1}} → {{About|Use1}}
*{{Tlx|About|Use1|<nowiki/>|Article2}} → {{About|Use1||Article2}}
*{{Tlx|About|Use1|Use2|Article2}} → {{About|Use1|Use2|Article2}}
*{{Tlx|About|Use1|Use2|Article2|and|Article3}} → {{About|Use1|Use2|Article2|and|Article3}}
*{{Tlx|About|Use1|Use2|Article2|other uses}} → {{About|Use1|Use2|Article2|other uses}}


For more options, find "{About}" in the text below.
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|<nowiki/>|Article2|<nowiki>section=yes</nowiki>}} → {{About|Use1||Article2|section=yes}}
*{{Tlx|About|Use1|Use2|Article2|<nowiki>section=yes</nowiki>}} → {{About|Use1|Use2|Article2|section=yes}}
*{{Tlx|About|Use1|Use2|Article2|and|Article3|<nowiki>section=yes</nowiki>}} → {{About|Use1|Use2|Article2|and|Article3|section=yes}}
*{{Tlx|About|Use1|Use2|Article2|other uses|<nowiki>section=yes</nowiki>}} → {{About|Use1|Use2|Article2|other uses|section=yes}}


For reference, see [[Wikipedia:hatnotes]] and documentation below.
For more options, find "{{Tlf|About}}" in the text below.
{{Hatnote templates documentation}}
 
For reference, see [[Wikipedia:hatnote]] and documentation below.
{{Hatnote templates}}


==TemplateData==
==TemplateData==
{{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 29: Line 43:
"3": {
"3": {
"label": "Other page 1 title",
"label": "Other page 1 title",
"type": "string",
"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 35: Line 49:
"label": "Other page 2 description",
"label": "Other page 2 description",
"type": "string",
"type": "string",
"description": "What the second other page is about. If unused or blank, defaults to \"For other uses\"."
"description": "What the second other page is about."
},
},
"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 or blank and parameter 4 exists, defaults to \"[page title] (disambiguation)\"."
},
"6": {
"label": "Other page 3 description",
"type": "string",
"description": "What the third other page is about."
},
"7": {
"label": "Other page 3 title",
"type": "wiki-page-name",
"description": "The title of the third other page. If unused or blank and parameter 6 exists, defaults to \"[page title] (disambiguation)\"."
},
"8": {
"label": "Other page 4 description",
"type": "string",
"description": "What the fourth other page is about."
},
"9": {
"label": "Other page 4 title",
"type": "wiki-page-name",
"description": "The title of the fourth other page. If unused or blank and parameter 8 exists, defaults to \"[page title] (disambiguation)\"."
},
"section": {
"type": "string",
"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."
"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>{{Sandbox other||
<!-- ADD CATEGORIES BELOW THIS LINE -->
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Disambiguation and redirection templates|{{PAGENAME}}]]
[[Category:Disambiguation and redirection templates]]
[[Category:Hatnote templates]]
[[Category:Hatnote templates]]


<!-- ADD INTERWIKIS BELOW THIS LINE -->
}}</includeonly>
[[ar:قالب:عن]]
[[es:Plantilla:Sobre]]
[[he:תבנית:פירוש נוסף]]
[[pt:Predefinição:Ver desambig]]
</includeonly>

Latest revision as of 04:38, 6 February 2017

Template:Mbox Script error: No such module "Message box". Script error: No such module "Message box". Script error: No such module "Lua banner". {{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||Article2}} → Script error: No such module "about".
  • {{About|Use1|Use2|Article2}} → Script error: No such module "about".
  • {{About|Use1|Use2|Article2|and|Article3}} → Script error: No such module "about".
  • {{About|Use1|Use2|Article2|other uses}} → 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||Article2|section=yes}} → Script error: No such module "about".
  • {{About|Use1|Use2|Article2|section=yes}} → Script error: No such module "about".
  • {{About|Use1|Use2|Article2|and|Article3|section=yes}} → Script error: No such module "about".
  • {{About|Use1|Use2|Article2|other uses|section=yes}} → Script error: No such module "about".

For more options, find "{{About}}" in the text below.

For reference, see Wikipedia:hatnote and documentation below. Script error: No such module "Navbox".

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

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." }, "5": { "label": "Other page 2 title", "type": "wiki-page-name", "description": "The title of the second other page. If unused or blank and parameter 4 exists, defaults to \"[page title] (disambiguation)\"." }, "6": { "label": "Other page 3 description", "type": "string", "description": "What the third other page is about." }, "7": { "label": "Other page 3 title", "type": "wiki-page-name", "description": "The title of the third other page. If unused or blank and parameter 6 exists, defaults to \"[page title] (disambiguation)\"." }, "8": { "label": "Other page 4 description", "type": "string", "description": "What the fourth other page is about." }, "9": { "label": "Other page 4 title", "type": "wiki-page-name", "description": "The title of the fourth other page. If unused or blank and parameter 8 exists, 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>


Retrieved from "http://wiki.pluribus.org.uk/w/index.php?title=Template:About/doc&oldid=267"