Template:About/doc: Difference between revisions

From World Encyclopedia of Conductors
en>Iiii I I I
copy from Template:For/doc
 
Created page with "{{documentation subpage}} <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia:Wikidata) --> {{high-risk| 109000+ }} {{Module rating|protected}} {{Lua|Module:Hatnote|Module:Hatnote list|Module:Pagetype}} This module implements the {{tl|about}} hatnote template. == Usage == *The <code>about</code> function implements the {{tl|about}} template directly, using the frame and applying no..."
Line 1: Line 1:
{{Documentation subpage}}<noinclude>{{pp|small=yes}}</noinclude><!--
{{documentation subpage}}
Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-use}}
{{high-risk| 109000+ }}
{{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.}}
{{Module rating|protected}}
{{Lua|Module:About}}
{{Lua|Module:Hatnote|Module:Hatnote list|Module:Pagetype}}


{{Tlc|About}} is a commonly used [[WP:Hatnote|hatnote template]] on Wikipedia for linking the reader to other articles with similar titles or concepts that they may have been seeking instead.
This module implements the {{tl|about}} [[Wikipedia:Hatnote|hatnote]] template.


==Usage==
== Usage ==
This template should be [[WP:HATNOTEPLACE|placed]] at the top of an article (but following {{Tlx|Short description}}, if present). The template has several formats, including:
*The <code>about</code> function implements the {{tl|about}} template directly, using the frame and applying no options. This should probably only be used in {{tl|about}}.
*{{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''.
*The <code>_about</code> function can be used from Lua to supply a custom arguments list (its first argument) and/or an options table (its second argument). Options include:
 
**<code>aboutForm</code> A string that can be used to substitute the form of the initial "about" message. It should include two substitution points: the first for the page type (e.g. "article"), and the second for the description of what the page is about. It should also include a trailing space for easy concatenation or omission. Defaults to <code>'This %s is about %s. '</code>.
=== Styling in italics ===
**<code>sectionString</code> Gives the page type string for when the named argument <code>section</code> is specified. Defaults to <code>'section'</code>.
Please see {{section link|Wikipedia:Hatnote|Hatnotes with italics in the links}} ([[WP:ITHAT]]) for details about how to use italics in hatnotes.
 
==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==
{{TemplateData header}}
<!-- Should this mention the existence of "and"? It's something of a can of worms, since it only looks as though it only works in certain combinations of the other page 2/3/4 description fields... -->
<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>
 
==See also==
* [[Wikipedia:Hatnote]]
{{Hatnote templates}}
 
 
<!-- To add more other pages, continue with this alternating pattern using increasing numbers, starting with 6 for the next page description. -->


<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Disambiguation and redirection hatnote templates]]
[[Category:Hatnote modules]]
}}</includeonly>
}}</includeonly>

Revision as of 20:40, 25 June 2026

This module implements the {{about}} hatnote template.

Usage

  • The about function implements the {{about}} template directly, using the frame and applying no options. This should probably only be used in {{about}}.
  • The _about function can be used from Lua to supply a custom arguments list (its first argument) and/or an options table (its second argument). Options include:
    • aboutForm A string that can be used to substitute the form of the initial "about" message. It should include two substitution points: the first for the page type (e.g. "article"), and the second for the description of what the page is about. It should also include a trailing space for easy concatenation or omission. Defaults to 'This %s is about %s. '.
    • sectionString Gives the page type string for when the named argument section is specified. Defaults to 'section'.