Template:About/doc: Difference between revisions

From Pluribus Lore Wiki
Jump to navigation Jump to search
← Older edit
VisualWikitext
*>Sligocki
Make it clear that {{about}} is preferred spelling, cleanup usage
Cheese (talk | contribs)
Bureaucrats, masseditregexeditor, Administrators
1,355 edits
m 113 revisions imported
 
(87 intermediate revisions by 62 users not shown)
Line 1: Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{tl|about}} is a commonly used [[Wikipedia:Hatnote|hatnote]] on Wikipedia, and so should be placed at the top of an article, linking the reader to articles with similar titles or concepts that they may have been seeking instead.
{{High-risk| 105000+ }}
{{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.}}
{{Lua|Module:About}}
{{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 historical reasons, it is also called {{tl|otheruses4}} and every example {{tlp|about|a|b|c|...}} may alternatively be spelled {{tlp|otheruses4|a|b|c|...}}, however to improve the readability of edits, {{tl|about}} is the suggested form and will be used throughout the documentation.
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, there is information about [[Wikipedia:Hatnote|hatnotes in general]], [[Wikipedia:Hatnote#Examples of proper use|when and how to use them]], a complete [[Wikipedia:Hatnote#Templates|list of the other hatnotes]] available, and [[Wikipedia:Otheruses templates (example usage)|examples of their use]].
For more options, find "{{Tlf|About}}" in the text below.


For further information, see the [[Template talk:about|talk page]].
For reference, see [[Wikipedia:hatnote]] and documentation below.
{{Hatnote templates}}


==Usage==
==TemplateData==
''Note. When used in [[Wikipedia:Main namespace|main namespace]], the word "page" in the following hat notes is replaced by "article".''
{{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>
{
"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>
<!--  To add more other pages, continue with this alternating pattern using increasing numbers, starting with 6 for the next page description. -->


* '''<code><nowiki>{{about|USE1}}</nowiki></code>'''
<includeonly>{{Sandbox other||
{{about|USE1}}
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
* '''<code><nowiki>{{about|USE1||PAGE2}}</nowiki></code>''' (When the disambiguation page has a different name — '''Note the empty second parameter''')
[[Category:Disambiguation and redirection templates]]
{{about|USE1||PAGE2}}
[[Category:Hatnote templates]]
* '''<code><nowiki>{{about|USE1|USE2|PAGE2}}</nowiki></code>''' (When there is only one other use)
{{about|USE1|USE2|PAGE2}}
* '''<code><nowiki>{{about|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}</nowiki></code>''' (When there are up to five other uses — You should generally create a [[Wikipedia:Disambiguation|disambiguation page]] at this point)
{{about|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}
* '''<code><nowiki>{{about|USE1|USE2|PAGE2|USE3|PAGE3|other uses}}</nowiki></code>''' (When there are several standard other uses and also a disambiguation page with default name — '''Note that the last page name is not specified''')
{{about|USE1|USE2|PAGE2|USE3|PAGE3|other uses}}


* '''<code><nowiki>{{about||USE2|PAGE2|USE3|PAGE3|other uses}}</nowiki></code>''' (When you don't need to state the focus of this article/page — '''Note the empty first parameter''')
}}</includeonly>
{{about||USE2|PAGE2|USE3|PAGE3|other uses}}
 
{{Otheruses templates}}
 
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude><includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Disambiguation and redirection templates|{{PAGENAME}}]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
[[ar:قالب:Otheruses4]]
[[fr:Autre4]]
[[lv:Veidne:Otheruses4]]
[[mk:Шаблон:Другизначења4]]
[[pt:Predefinição:Outrousopara]]
[[ro:Format:Altesensuri4]]
[[sl:Predloga:Drugipomeni4]]
[[sv:Mall:Hänvisning]]
[[vi:Tiêu bản:Otheruses4]]
[[zh-yue:Template:Otheruses4]]
[[zh:Template:Otheruses4]]
</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"