Template:About/doc: Difference between revisions

Template page
(Showing that |and| markup automatically converts "and"s to commas if the list of other uses has more than two entries.)
 
m (1 revision imported)
 
(No difference)

Latest revision as of 09:51, 18 June 2022

{{About}} is a commonly used hatnote template on Wikipedia, and should be placed at the top of an article (but following {{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:

  • {{About}}
  • {{About|Use1}}
  • {{About||Use2|Article2}}
  • {{About|Use1||Article2}}
  • {{About|Use1||Article2|and|Article3}}
  • {{About|Use1|Use2|Article2}}
  • {{About|Use1|Use2|Article2|and|Article3}}
  • {{About|Use1|Use2|Article2|and|Article3|and|Article4|and|Article5}}
  • {{About|Use1|Use2|Article2|Use3|Article3}}
  • {{About|Use1|Use2|Article2|other uses}}

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:

A |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. This template supports |selfref= (see {{self reference}} and MOS:SELFREF for details).

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

For reference, see Wikipedia:hatnote and documentation below.

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

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)".

Page namesuggested
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)".

Page nameoptional
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)".

Page nameoptional
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)".

Page nameoptional
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