Template:About/doc
 | This template should be used on pages only if other topics and articles exist with very similar names. For most pages, this is not true, so do not use this template on them. |
 | Uses Lua: |
{{About}} is a commonly used hatnote template on Wikipedia, recently imported to Commons. It should be placed at the top of an page, linking the reader to other pages with similar titles or concepts that they may have been seeking instead. The template has several formats, including:
- {{About|Use1}} →
- {{About|Use1||Article2}} →
- {{About|Use1||Article2|and|Article3}} →
- {{About|Use1|Use2|Article2}} →
- {{About|Use1|Use2|Article2|and|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}} →
For more options, find "{{About}}" in the text below.
For reference, see and documentation below.
TemplateData[edit]
- TemplateData
TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.
Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either useTemplateData=1 or useTemplateData=only on the /doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.
Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.
Wikipedia's help about TemplateData • Commons-specific information
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 | required |
| 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 |