Difference between revisions of "About/Documentation"
Stratonian (talk | contribs) (Added documentation page for about) |
Stratonian (talk | contribs) m |
||
| (10 intermediate revisions by the same user not shown) | |||
| 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}}<br> | ||
| + | {{T|about|the about template|other templates}}<br> | ||
| + | {{T|about|the about template|other templates|Special:UnusedTemplates}} | ||
| + | |||
==Parameters== | ==Parameters== | ||
| − | {{ | + | {{parameter|1|Text explaining what the article is about.}} |
| − | {{ | + | {{parameter|use1|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|page1|The name of the page that the reader may be looking for.|<nowiki>{{PAGENAME}} disambiguation</nowiki>}} |
| − | + | {{parameter|use2|The uses of a second similar article that the reader may be looking for.|another use}} | |
| − | < | + | {{parameter|page2|The name of the second page that the reader may be looking for.}} |
| − | {{ | + | |
| − | {{ | + | ==Errors== |
| + | '''No about text provided. Add a name parameter.''' | ||
| + | <includeonly>[[Category:General Wiki Templates]]</includeonly> | ||
Latest revision as of 18:25, 19 August 2023
Description[edit]
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[edit]
{{about|<the about template>}}
{{about|<the about template>|<other templates>}}
{{about|<the about template>|<other templates>|<Special:UnusedTemplates>}}
Parameters[edit]
1: Text explaining what the article is about.- Required.
- use1: 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.
- page1: The name of the page that the reader may be looking for.
- Optional. Defaults to '
{{PAGENAME}} disambiguation'.
- use2: The uses of a second similar article that the reader may be looking for.
- Optional. Defaults to '
another use'.
- page2: The name of the second page that the reader may be looking for.
- Required.
Errors[edit]
No about text provided. Add a name parameter.