Difference between revisions of "About/Documentation"
Stratonian (talk | contribs) m (added correct spacing between bullet points) |
Stratonian (talk | contribs) m (→Parameters: Added variable names) |
||
Line 2: | Line 2: | ||
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. | ||
==Parameters== | ==Parameters== | ||
− | {{bullet}} ''' | + | {{bullet}} '''name''': Text explaining what the article is about. |
− | {{bullet}} ''' | + | {{bullet}} '''use''': Optional. The uses of the similar article that the reader may be looking for. This is usually kept blank if there is more than one similar article. |
+ | |||
+ | {{bullet}} '''page''': Optional. The name of the page that the reader may be looking for. Links to a documentation page for articles of the same name by default. | ||
− | |||
==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> |
Revision as of 12:23, 16 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
• name: Text explaining what the article is about.
• use: Optional. The uses of the similar article that the reader may be looking for. This is usually kept blank if there is more than one similar article.
• page: Optional. The name of the page that the reader may be looking for. Links to a documentation page for articles of the same name by default.
Usage
{{about|the about template}} {{about|the about template|other templates}} {{about|the about template|other templates|Special:UnusedTemplates}}