Difference between revisions of "About/Documentation"

m
m
Line 1: Line 1:
 
==Description==
 
==Description==
 
Should be placed at the top of an article. Links to pages of similar titles or concepts that the reader may be looking for.
 
Should be placed at the top of an article. Links to pages of similar titles or concepts that the reader may be looking for.
 +
==Usage==
 +
{{T|about|the about template}}
 +
{{T|about|the about template|other templates}}
 +
{{T|about|the about template|other templates|Special:UnusedTemplates}}
 
==Parameters==
 
==Parameters==
 
{{parameter|name|Text explaining what the article is about.}}
 
{{parameter|name|Text explaining what the article is about.}}
 
{{parameter|use|The uses of the similar article that the reader may be looking for.|other uses|Usually kept blank if there is more than one similar article.}}
 
{{parameter|use|The uses of the similar article that the reader may be looking for.|other uses|Usually kept blank if there is more than one similar article.}}
 
{{parameter|page|The name of the page that the reader may be looking for. Links to the current page's disambiguation page by default.|<code><nowiki>{{PAGENAME}} disambiguation</nowiki></code>}}
 
{{parameter|page|The name of the page that the reader may be looking for. Links to the current page's disambiguation page by default.|<code><nowiki>{{PAGENAME}} disambiguation</nowiki></code>}}
==Usage==
 
<pre>{{about|the about template}}
 
{{about|the about template|other templates}}
 
{{about|the about template|other templates|Special:UnusedTemplates}}</pre>
 
 
==Errors==
 
==Errors==
 
'''No about text provided. Add a name parameter.'''
 
'''No about text provided. Add a name parameter.'''

Revision as of 19:56, 25 February 2023

Description

Should be placed at the top of an article. Links to pages of similar titles or concepts that the reader may be looking for.

Usage

{{about|<the about template>}} {{about|<the about template>|<other templates>}} {{about|<the about template>|<other templates>|<Special:UnusedTemplates>}}

Parameters

Arrow.pngname: Text explaining what the article is about.
Required.
Arrow.pnguse: The uses of the similar article that the reader may be looking for.
Optional. Defaults to 'other uses'.
Notes: Usually kept blank if there is more than one similar article.
Arrow.pngpage: The name of the page that the reader may be looking for. Links to the current page's disambiguation page by default.
Optional. Defaults to '{{PAGENAME}} disambiguation'.

Errors

No about text provided. Add a name parameter.