|
|
| Line 1: |
Line 1: |
| <includeonly>{{#invoke:Hatnote|hatnote}}</includeonly> | | <includeonly>{{#invoke:Hatnote|hatnote}}</includeonly><noinclude> |
| <noinclude> | | {{Documentation}}</noinclude> |
| == <span id="Typical_types">Typical types</span> ==
| |
| {{T|Main}}, {{T|Further}} are very similar, but indicate either the primary page for a topic or more detailed related topic. They have a nearly identical set of parameters.
| |
| | |
| ;{{T|Main}}: When an article is large, it often has a summary and a link to a main article. This template is used after the heading of the summary, to indicate a link to the subtopic article that has been summarized.
| |
| ;{{T|Further}}: Used to link to articles containing further information on this topic.
| |
| ;{{T|See also}}: Used to link to additional articles on related topics.
| |
| | |
| :;{{T|Main|Main Page}} →:{{Main|Main Page}}
| |
| :;{{T|Main|Main Page|Main Page}} →:{{Main|Main Page|Main Page}}
| |
| | |
| :*<code>1</code>, <code>2</code>, <code>3</code>, ... – the pages to link to. If no page names are specified, the current page name is used instead (without the namespace prefix). Categories and files are automatically escaped with the [[w:Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.
| |
| :*<code>l1</code>, <code>l2</code>, <code>l3</code>, ... ''or''<code>label 1</code>, <code>label 2</code>, <code>label 3</code>, ... – optional labels for each of the pages to link to (this is for articles where a piped link would be used). Note that the extra parameters use a lower case 'L', for example, <code>l1</code>, <u>not</u> <code>L1</code>.
| |
| :*<code>selfref</code> – if set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references.
| |
| | |
| == Disambiguation ==
| |
| : ''Examples below may have some of their links removed to prevent redlinks in documentation.''
| |
| Templates such as {{T|About}} and {{T|For}} are to be used in cases where a disambiguation is not needed. In general, disambiguation pages should only be used for 4 or more titles that are mostly or entirely identical, except for a qualifier.
| |
| ;{{T|About}}: Links the reader to other articles with similar titles or concepts that they may have been seeking instead. The template has several formats, including:
| |
| :;{{T|About|Use1}} →:{{About|}}
| |
| :;{{T|About|Use1|<nowiki/>|Main Page}} →:{{About|Use1||Main Page}}
| |
| :;{{T|About|Use1|<nowiki/>|Main Page|and|Main Page}} →:{{About|Use1||Main Page|and|Main Page}}
| |
| :;{{T|About|Use1|Use2|Main Page}} →:{{About|Use1|Use2|Main Page}}
| |
| :;{{T|About|Use1|Use2|Main Page|and|Main Page}} →:{{About|Use1|Use2|Main Page|and|Main Page}}
| |
| :;{{T|About|Use1|Use2|Main Page|other uses}} →:{{About|Use1|Use2|Main Page|other uses}}
| |
| | |
| Alternately, a <code>section=yes</code> parameter can be added to the {{T|About}} template for use at the top of a section. When using this parameter, the wording in the template changes to specify that it is being used in a section:
| |
| :;{{T|About|Use1|<nowiki>section=yes</nowiki>}} →:{{About|Use1|section=yes}}
| |
| :;{{T|About|Use1|<nowiki/>|Main Page|<nowiki>section=yes</nowiki>}} →:{{About|Use1||Main Page|section=yes}}
| |
| :;{{T|About|Use1|Use2|Main Page|<nowiki>section=yes</nowiki>}} →:{{About|Use1|Use2|Main Page|section=yes}}
| |
| :;{{T|About|Use1|Use2|Main Page|and|Main Page|<nowiki>section=yes</nowiki>}} →:{{About|Use1|Use2|Main Page|and|Main Page|section=yes}}
| |
| :;{{T|About|Use1|Use2|Main Page|other uses|<nowiki>section=yes</nowiki>}} →:{{About|Use1|Use2|Main Page|other uses|section=yes}}
| |
| | |
| A <var>text</var> option adds text to the end; note that this should be only used when truly necessary, and the other hatnote templates listed below don't suffice. This template also supports <var>selfref</var>.
| |
| | |
| ;{{T|For}}: Provides links to up to four articles or disambiguation pages. It accepts zero to five parameters.
| |
| | |
| :;If used without parameters on a page named ''Foo'', the result is
| |
| ::{{for|{{#invoke:i18n|getMsg|Module:Hatnote/i18n|other-uses|uselang = {{CONTENTLANG}} }}|Foo ({{#invoke:i18n|getMsg|Module:Hatnote/i18n|disambiguation|uselang = {{CONTENTLANG}} }})|category=n}}
| |
| :;The first parameter changes the hatnote itself and should be plain text, e.g. {{T|For|{{#invoke:i18n|getMsg|Module:Hatnote/i18n|similar-terms}}}} yields
| |
| ::{{for|{{#invoke:i18n|getMsg|Module:Hatnote/i18n|similar-terms}}|Foo ({{#invoke:i18n|getMsg|Module:Hatnote/i18n|disambiguation|uselang = {{CONTENTLANG}} }})|category=n}}
| |
| :;The second parameter is used to change the resultant link, e.g. {{T|For|{{#invoke:i18n|getMsg|Module:Hatnote/i18n|similar-terms}}|Main Page}} yields
| |
| ::{{For|{{#invoke:i18n|getMsg|Module:Hatnote/i18n|similar-terms}}|Main Page|category=n}}
| |
| :;The third, fourth and fifth parameters are used to give one, two, or three supplementary links:
| |
| :*{{For|{{#invoke:i18n|getMsg|Module:Hatnote/i18n|similar-terms}}|Main Page|Main Page|category=n}}
| |
| :*{{For|{{#invoke:i18n|getMsg|Module:Hatnote/i18n|similar-terms}}|Main Page|Main Page|Main Page|category=n}}
| |
| :*{{For|{{#invoke:i18n|getMsg|Module:Hatnote/i18n|similar-terms}}|Main Page|Main Page|Main Page|Main Page|category=n}}
| |
| :the last being produced by e.g. {{T|For|{{#invoke:i18n|getMsg|Module:Hatnote/i18n|similar-terms}}|Main Page|Main Page|Main Page|Main Page}}.
| |
| </noinclude> | |
