 | This is a documentation subpage for Template:Hatnote. It may contain usage information, categories and other content that is not part of the original template page. |
| This is a documentation subpage for Template:Hatnote. It may contain usage information, categories and other content that is not part of the original template page. |
 | Using this template does not create a redirect. The following pages may have what you are looking for:
|
| File:Ambox warning yellow.svg | This template is used on approximately 39,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
Description and use[edit source]
This template produces a hatnote:
{{Redirect|Foo}}→ Template loop detected: Template:Redirect
It is placed at the top of the article or section that is the primary topic of a redirect, and links to other topics that are ambiguous with the name of that redirect. This template is used instead of the generic {{for}} in order to reduce reader confusion.
An example would be when a user searches for the emperor Achilleus. However, the search term "Achilleus" redirects to the page titled Achilles (as in the mythical hero) because it is considered more likely the user were searching for the very well known hero than a relatively obscure emperor. Now, at the top of this Achilles page you will (among other things) find the following hatnote:
- "Achilleus" redirects here. For the Roman emperor with this name, see Achilleus (Roman usurper).
That text is this template in action.
Parameters[edit source]
Template:Expand-section
A |text= option adds text to the end; note that this should only be used when truly necessary, when the other hatnote templates listed below don't suffice.
Examples[edit source]
{{Redirect|Foo}}→ Template loop detected: Template:Redirect{{Redirect|REDIRECT||PAGE1}}→ Template loop detected: Template:Redirect{{Redirect|REDIRECT|USE1|PAGE1}}→ Template loop detected: Template:Redirect{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}→ Template loop detected: Template:Redirect{{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}→ Template loop detected: Template:Redirect{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}→ Template loop detected: Template:Redirect{{Redirect|Achilleus|the Emperor with this name|Achilleus (emperor)|other uses|Achilles (disambiguation)}}(as used on the page Achilles) → Template loop detected: Template:Redirect
More complex uses[edit source]
For more complex cases, other templates can be used:
- {{Redirect2}} (when there are two incoming redirects)
- {{Redirect-multi}} (for two or more redirects)
- {{Redirect-several}} (for several redirects, without listing each)
- {{Redirect-distinguish}}
- {{See Wiktionary}} with "redirect" field
- {{Technical reasons}}
TemplateData[edit source]
TemplateData for Hatnote
<templatedata> { "params": { "1": { "label": "Redirecting page", "description": "Name of page that redirects here", "type": "wiki-page-name", "required": true }, "2": { "label": "Use 1", "description": "Displayed as: For Use 1, see ... If left empty, defaults to For other uses, see ...", "type": "line", "required": false }, "3": { "label": "Target 1", "description": "Page to link to. Default is PAGENAME (disambiguation).", "type": "wiki-page-name", "required": false }, "4": { "label": "Use 2", "description": "Second use. Can be 'and' to give: For Use 1, see Target1 and Target2.", "type": "line", "required": false }, "5": { "label": "Target 2", "description": "Page to link second use to.", "type": "wiki-page-name", "required": false }, "6": { "label": "Use 3", "description": "Third use. Can be 'and'.", "type": "line", "required": false }, "7": { "label": "Target 3", "description": "Page to link third use to.", "type": "wiki-page-name", "required": false }, "text": { "label": "Custom text", "type": "line", "description": "Text to be appended to the end." } }, "description": "This template produces a hatnote similar to:\n\n\"Foo\" redirects here. For other uses, see Foo (disambiguation).", "format": "inline" } </templatedata>
See also[edit source]
- {{no redirect}}, {{-r}}
- {{is redirect}} — returns yes/<blank>
- Rcat functional index
| File:Ambox warning orange.svg | This template is used on approximately 370,000 pages, or roughly 64300% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
| This template uses Lua: |
This template produces formatted text, following the guideline for a Wikipedia hatnote:
- {{Hatnote
|Example hatnote text.}} →
Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): Am I on the right page?
Function[edit source]
This template is primarily used to add a correctly formatted hatnote to a page. Often, but not always, this is a disambiguation link at the top of article pages. It places an HTML div- / div block around the text entered as its only argument, which provides standardized formatting (contents are indented and italicized in most displays); it also isolates the contained code to make sure that it is interpreted correctly.
This template is also used as the "meta-template" for additional specialized disambiguation link templates; see Category:Hatnote templates for a list.
The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal Wikipedia markup.
Usage[edit source]
- Basic usage
- {{hatnote
|text}}
- All parameters
- {{hatnote
|text |extraclasses=extra classes |selfref=yes |category=no}}
Parameters[edit source]
This template accepts the following parameters:
1– the hatnote text (required)extraclasses– any extra CSS classes to be added, for example, the {{see also}} template adds the classes "|extraclasses=boilerplate seealso".selfref– If set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See Template:Selfref for more information.category– If set to "no", "n", "false", or "0", suppresses the error tracking category (Category:Hatnote templates with errors). This has an effect only if the leftmost parameter (the hatnote text) is omitted.
Example[edit source]
- {{hatnote
|Example hatnote text}} →
Errors[edit source]
If no hatnote text is supplied, the template will output the following message:
- Error: no text specified (help).
If you see this error message, it is for one of four reasons:
- No parameters were specified (the template code was
{{hatnote}}). Please use{{hatnote|text}}instead. - Some parameters were specified, but the hatnote text wasn't included. For example, the template text
{{hatnote|extraclasses=seealso}}will produce this error. Please use (for example){{hatnote|text|extraclasses=seealso}}instead. - The hatnote text was specified, but that text contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code
{{hatnote|2+2=4}}will produce this error. To work around this, you can specify the parameter name explicitly by using1=before the hatnote text, like this:{{hatnote|1=2+2=4}}. - You tried to access Module:Hatnote directly by using
{{#invoke:hatnote|hatnote|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use{{hatnote|text}}instead.
If you see this error message and are unsure of what to do, please post a message on Template talk:Hatnote, and someone should be able to help you.
Pages that contain this error message are tracked in Category:Hatnote templates with errors.
Technical details[edit source]
The HTML code produced by this template looks like this:
<div role="note" class="hatnote navigation-not-searchable">hatnote text</div>
The code is produced by Module:Hatnote.
See also[edit source]
- {{For}}
TemplateData documentation used by VisualEditor and other tools
|
|---|
|
click here to see a monthly parameter usage report for this template.
TemplateData for Hatnote <templatedata> { "description": "Template for creating a standard Wikipedia hatnote. A hatnote is a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.",
"params": {
"1": {
"label": "Text",
"description": "This field should contain the text that will be displayed in the hatnote.",
"type": "string",
"required": true
},
"extraclasses": {
"type": "string/line",
"label": "Extra classes",
"description": "Extra CSS classes to be added to the tags surrounding the hatnote text."
},
"selfref": {
"type": "string/line",
"label": "Self reference",
"description": "Set to \"yes\" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. \"For the Wikipedia Sandbox, see WP:SAND\".)"
},
"category": {
"label": "Category",
"description": "Set to \"no\", \"n\", \"false\", or \"0\" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted."
}
}
} </templatedata> |