Difference between revisions of "About/Documentation"

m
Line 5: Line 5:
 
{{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==
 
==Usage==
 
<pre>{{about|the about template}}
 
<pre>{{about|the about template}}
 
{{about|the about template|other templates}}
 
{{about|the about template|other templates}}
 
{{about|the about template|other templates|Special:UnusedTemplates}}</pre>
 
{{about|the about template|other templates|Special:UnusedTemplates}}</pre>
 +
==Errors==
 +
'''No about text provided. Add a name parameter.'''

Revision as of 17:20, 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.

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'.

Usage

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

Errors

No about text provided. Add a name parameter.