Template:About/doc: Difference between revisions

Latest revision as of 14:56, 23 January 2024

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.

[[Category:Template documentation pages{{#translation:}}]]

This template is used on approximately 154,000 pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

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

{{About}} is a commonly used hatnote template on CAPipedia 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||Article (disambiguation)}} →
{{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.

The |selfref=yes option marks the entire hatnote as a CAPipediaself-reference, causing it to be omitted when the page content is reused outside of CAPipedia(see {{self reference}} and MOS:SELFREF for more 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

<templatedata> { "description": "This template is a hatnote in the format \"This page is about … For other uses …\".", "params": { "1": { "label": "Page description", "type": "string", "description": "What the page this template is placed on is about (\"This page is about …\")", "suggested": true }, "2": { "label": "Other page 1 description", "type": "string", "description": "What the first other page is about. If unused or blank, defaults to \"other uses\".", "suggested": true }, "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)\".", "suggested": true }, "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" },

       "text": {

"label": "Custom text", "type": "string", "description": "Text to be appended to the end." } } } </templatedata>

@@ Line 4: / Line 4: @@
 {{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 [[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:
+{{Tlc|About}} is a commonly used [[WP:Hatnote|hatnote template]] on CAPipedia 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}}
@@ Line 26: / Line 26: @@
 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).
+The {{para|selfref|yes}} option marks the entire hatnote as a CAPipediaself-reference, causing it to be omitted when the page content is reused outside of CAPipedia(see {{tl|self reference}} and [[MOS:SELFREF]] for more details).
 For more options, find "{{Tlf|About}}" in the text below.

v t e Hatnote templates
Wikipedia:Hatnote Wikipedia:Disambiguation Wikipedia:Redirect
Generic	{{Hatnote}} {{Self-reference}}
For and about	{{For}} {{For-text}} (for custom text) {{For-multi}} (for multiple uses) {{About}} Variations: {{Other uses}} {{Other uses of}} {{Redirect-distinguish-for}} {{About-distinguish}} {{About-distinguish-text}}
Other topics	{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other storms}} {{Other places}} {{Other ships}}
Redirect	{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Redirect-distinguish-text}} {{Redirect-distinguish-for}} {{Technical reasons}}
Distinguish	{{Distinguish}} (supports custom text) {{About-distinguish}} {{About-distinguish-text}} (for custom text) {{Redirect-distinguish}} {{Redirect-distinguish-text}} (for custom text) {{Redirect-distinguish-for}}
For use in sections	{{Main}} {{Main if exists}} {{Main list}} {{Further}} {{Further-text}} (for custom text) {{Further interlanguage link}} {{See also}} {{See also if exists}} {{See also-text}} (for custom text) {{For outline}} {{For timeline}}
Special	{{Broader}} {{For introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific	{{About year}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}}
Category:Hatnote templates modules for [family] names for lists hatnote templates for category pages