Template:About/doc

From blackwiki
Jump to navigation Jump to search

{{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}}Script error: No such module "about".
  • {{About|Use1}}Script error: No such module "about".
  • {{About||Use2|Article2}}Script error: No such module "about".
  • {{About|Use1||Article2}}Script error: No such module "about".
  • {{About|Use1||Article2|and|Article3}}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|Use3|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".

A |text= option adds text to the end; note that this should be only used when truly necessary, and the other hatnote templates listed below don't suffice. This template also supports |selfref=.

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

For reference, see Wikipedia:hatnote and documentation below.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for About

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

Template parameters

ParameterDescriptionTypeStatus
Page description1

What the page this template is placed on is about ("This page is about …")

Stringsuggested
Other page 1 description2

What the first other page is about. If unused or blank, defaults to "For other uses".

Stringsuggested
Other page 1 title3

The title of the first other page. If unused, defaults to "[page title] (disambiguation)".

Pagesuggested
Other page 2 description4

What the second other page is about.

Stringoptional
Other page 2 title5

The title of the second other page. If unused or blank and parameter 4 exists, defaults to "[page title] (disambiguation)".

Pageoptional
Other page 3 description6

What the third other page is about.

Stringoptional
Other page 3 title7

The title of the third other page. If unused or blank and parameter 6 exists, defaults to "[page title] (disambiguation)".

Pageoptional
Other page 4 description8

What the fourth other page is about.

Stringoptional
Other page 4 title9

The title of the fourth other page. If unused or blank and parameter 8 exists, defaults to "[page title] (disambiguation)".

Pageoptional
Sectionsection

Pass "yes" in this parameter to get wording appropriate for use at the top of a section.

Auto value
yes
Stringoptional
Custom texttext

Text to be appended to the end.

Stringoptional