Template:About/doc: Difference between revisions
TheOnlyZac (talk | contribs) m (1 revision imported from wikipedia:Template:About/doc) |
TheOnlyZac (talk | contribs) m (Removed WP maintenance template) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
<!-- 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.}} |
{{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}} |
{{Lua|Module:About}} |
||
Latest revision as of 18:19, 3 August 2022
 | This is a documentation subpage for Template:About It contains usage information, categories and other content that is not part of the original template page. |
 | 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: |
{{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:
{{About|Use1|section=yes}}→{{About|Use1||Article2|section=yes}}→{{About|Use1|Use2|Article2|section=yes}}→{{About|Use1|Use2|Article2|and|Article3|section=yes}}→{{About|Use1|Use2|Article2|other uses|section=yes}}→
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. Template:Hatnote templates
TemplateData
TemplateData for About
This template is a hatnote in the format "This page is about … For other uses …".
| 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 "For 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.
| String | optional |
| Custom text | text | Text to be appended to the end. | String | optional |