Template:About/doc: Difference between revisions
Jump to navigation
Jump to search
*>Sligocki Use {{about}} in examples, update to have all examples from {{otheruses templates}} and format |
*>Sligocki Make it clear that {{about}} is preferred spelling, cleanup usage |
||
| Line 1: | Line 1: | ||
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude> | <includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude> | ||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | ||
{{tl| | {{tl|about}} is a commonly used [[Wikipedia:Hatnote|hatnote]] on Wikipedia, and so should be placed at the top of an article, linking the reader to articles with similar titles or concepts that they may have been seeking instead. | ||
For | For historical reasons, it is also called {{tl|otheruses4}} and every example {{tlp|about|a|b|c|...}} may alternatively be spelled {{tlp|otheruses4|a|b|c|...}}, however to improve the readability of edits, {{tl|about}} is the suggested form and will be used throughout the documentation. | ||
For reference, there is information about [[Wikipedia:Hatnote|hatnotes in general]], [[Wikipedia:Hatnote#Examples of proper use|when and how to use them]], a complete [[Wikipedia:Hatnote#Templates|list of the other hatnotes]] available, and [[Wikipedia:Otheruses templates (example usage)|examples of their use]]. | For reference, there is information about [[Wikipedia:Hatnote|hatnotes in general]], [[Wikipedia:Hatnote#Examples of proper use|when and how to use them]], a complete [[Wikipedia:Hatnote#Templates|list of the other hatnotes]] available, and [[Wikipedia:Otheruses templates (example usage)|examples of their use]]. | ||
For further information, see the [[Template talk: | For further information, see the [[Template talk:about|talk page]]. | ||
==Usage== | ==Usage== | ||
''Note. When used in main | ''Note. When used in [[Wikipedia:Main namespace|main namespace]], the word "page" in the following hat notes is replaced by "article".'' | ||
* '''<code><nowiki>{{about|USE1}}</nowiki></code>''' | * '''<code><nowiki>{{about|USE1}}</nowiki></code>''' | ||
{{about|USE1}} | {{about|USE1}} | ||
* '''<code><nowiki>{{about|USE1| | * '''<code><nowiki>{{about|USE1||PAGE2}}</nowiki></code>''' (When the disambiguation page has a different name — '''Note the empty second parameter''') | ||
{{about|USE1| | {{about|USE1||PAGE2}} | ||
* '''<code><nowiki>{{about|USE1|USE2|PAGE2}}</nowiki></code>''' | * '''<code><nowiki>{{about|USE1|USE2|PAGE2}}</nowiki></code>''' (When there is only one other use) | ||
{{about|USE1|USE2|PAGE2}} | {{about|USE1|USE2|PAGE2}} | ||
* '''<code><nowiki>{{about| | * '''<code><nowiki>{{about|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}</nowiki></code>''' (When there are up to five other uses — You should generally create a [[Wikipedia:Disambiguation|disambiguation page]] at this point) | ||
{{about|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}} | {{about|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}} | ||
* '''<code><nowiki>{{about|USE1|USE2|PAGE2|USE3|PAGE3|other uses}}</nowiki></code>''' (When there are several standard other uses and also a disambiguation page with default name — '''Note that the last page name is not specified''') | |||
{{about|USE1|USE2|PAGE2|USE3|PAGE3|other uses}} | |||
* '''<code><nowiki>{{about||USE2|PAGE2|USE3|PAGE3|other uses}}</nowiki></code>''' (When you don't need to state the focus of this article/page — '''Note the empty first parameter''') | |||
{{about||USE2|PAGE2|USE3|PAGE3|other uses}} | |||
{{Otheruses templates}} | {{Otheruses templates}} | ||
Revision as of 03:55, 9 September 2009
Template:Template doc page viewed directly {{about}} is a commonly used hatnote on Wikipedia, and so should be placed at the top of an article, linking the reader to articles with similar titles or concepts that they may have been seeking instead.
For historical reasons, it is also called {{otheruses4}} and every example Template:Tlp may alternatively be spelled Template:Tlp, however to improve the readability of edits, {{about}} is the suggested form and will be used throughout the documentation.
For reference, there is information about hatnotes in general, when and how to use them, a complete list of the other hatnotes available, and examples of their use.
For further information, see the talk page.
Usage
Note. When used in main namespace, the word "page" in the following hat notes is replaced by "article".
{{about|USE1}}
Script error: No such module "about".
{{about|USE1||PAGE2}}(When the disambiguation page has a different name — Note the empty second parameter)
Script error: No such module "about".
{{about|USE1|USE2|PAGE2}}(When there is only one other use)
Script error: No such module "about".
{{about|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}(When there are up to five other uses — You should generally create a disambiguation page at this point)
Script error: No such module "about".
{{about|USE1|USE2|PAGE2|USE3|PAGE3|other uses}}(When there are several standard other uses and also a disambiguation page with default name — Note that the last page name is not specified)
Script error: No such module "about".
{{about||USE2|PAGE2|USE3|PAGE3|other uses}}(When you don't need to state the focus of this article/page — Note the empty first parameter)
Script error: No such module "about".