Template:About/doc: Difference between revisions

Revision as of 07:27, 26 December 2024

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.

This template uses Lua:

Module:About

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:About in articles based on its TemplateData.

TemplateData for About

This template is a hatnote in the format "This page is about … For other uses …".

Template parameters
Parameter		Description	Type	Status
Page description	`1`	What the page this template is placed on is about ("This page is about …")	String	suggested
Other page 1 description	`2`	What the first other page is about. If unused or blank, defaults to "other uses".	String	suggested
Other page 1 title	`3`	The title of the first other page. If unused, defaults to "[page title] (disambiguation)".	Page name	suggested
Other page 2 description	`4`	What the second other page is about.	String	optional
Other page 2 title	`5`	The title of the second other page. If unused or blank and parameter 4 exists, defaults to "[page title] (disambiguation)".	Page name	optional
Other page 3 description	`6`	What the third other page is about.	String	optional
Other page 3 title	`7`	The title of the third other page. If unused or blank and parameter 6 exists, defaults to "[page title] (disambiguation)".	Page name	optional
Other page 4 description	`8`	What the fourth other page is about.	String	optional
Other page 4 title	`9`	The title of the fourth other page. If unused or blank and parameter 8 exists, defaults to "[page title] (disambiguation)".	Page name	optional
section	`section`	Pass "yes" in this parameter to get wording appropriate for use at the top of a section. Auto value `yes`	String	optional
Custom text	`text`	Text to be appended to the end.	String	optional

@@ Line 1: / Line 1: @@
-{{Documentation subpage}}<noinclude>{{pp|small=yes}}</noinclude><!--
-Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
-{{High-use}}
 {{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}}
-==Usage==
-{{Tlc|About}} is a commonly used [[WP:Hatnote|hatnote template]] on Wikipedia, and should be [[WP:HATNOTEPLACE|placed]] at the top of an article (but following {{Tlx|Short description}}, if present), 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}} → {{About}}
-*{{Tlx|About|Use1}} → {{About|Use1}}
-*{{Tlx|About|<nowiki/>|Use2|Article2}} → {{About||Use2|Article2}}
-*{{Tlx|About|<nowiki/>|<nowiki/>||Article (disambiguation)}} → {{About|||Article (disambiguation)}}
-*{{Tlx|About|Use1|<nowiki/>|Article2}} → {{About|Use1||Article2}}
-*{{Tlx|About|Use1|<nowiki/>|Article2|and|Article3}} → {{About|Use1||Article2|and|Article3}}
-*{{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|and|Article3|and|Article4|and|Article5}} → {{About|Use1|Use2|Article2|and|Article3|and|Article4|and|Article5}}
-*{{Tlx|About|Use1|Use2|Article2|Use3|Article3}} → {{About|Use1|Use2|Article2|Use3|Article3}}
-*{{Tlx|About|Use1|Use2|Article2|other uses}} → {{About|Use1|Use2|Article2|other uses}}
-The template {{tl|For-multi}} produces the same hatnote, but without the initial ''This template is about''.
-==Parameters==
-Alternately, a {{para|section|yes}} 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}}
-A {{para|text}} option adds text to the end; this should only be used when truly necessary, when the other hatnote templates listed below don't suffice.
-The {{para|selfref|yes}} option marks the entire hatnote as a Wikipedia self-reference, causing it to be omitted when the page content is reused outside of Wikipedia (see {{tl|self reference}} and [[MOS:SELFREF]] for more details).
-For more options, see section "TemplateData" below.
 ==TemplateData==

Revision as of 07:27, 26 December 2024

TemplateData

See also