More actions
No edit summary |
No edit summary |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{wikipedia|page name}} | {{wikipedia|page name}} | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{Lua|Module:Hatnote}} | {{Lua|Module:Hatnote}} | ||
This template produces formatted text, following the guideline for a '''[[Wikipedia:Hatnote|Wikipedia hatnote]]''': | This template produces formatted text, following the guideline for a '''[[Wikipedia:Hatnote|Wikipedia hatnote]]''': | ||
: | : →<br><!-- a construct to show hatnote as expected (using newline) --> | ||
{{Hatnote|Example hatnote text.}} | {{Hatnote|Example hatnote text.}} | ||
Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): ''Am I on the right page?'' | Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): ''Am I on the right page?'' | ||
== Function == | == Function == | ||
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 <code>div-</code> / <code>div</code> 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 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 <code>div-</code> / <code>div</code> 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 | This template is also used as the "meta-template" for additional specialized disambiguation link templates; see for a list. | ||
The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal | The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal Wikipedia markup. | ||
== Usage == | == Usage == | ||
; Basic usage: | ; Basic usage: | ||
: | : | ||
; All parameters: | ; All parameters: | ||
: | : | ||
== Parameters == | == Parameters == | ||
| Line 33: | Line 28: | ||
* <code>1</code> – the hatnote text (required) | * <code>1</code> – the hatnote text (required) | ||
* <code>extraclasses</code> – any extra CSS classes to be added, for example, the {{tl|see also}} template adds the classes "{{para|extraclasses|boilerplate seealso}}". | * <code>extraclasses</code> – any extra CSS classes to be added, for example, the {{tl|see also}} template adds the classes "{{para|extraclasses|boilerplate seealso}}". | ||
* <code>selfref</code> – If set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See | * <code>selfref</code> – 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. | ||
* <code>category</code> – If set to "no", "n", "false", or "0", suppresses the error tracking category ( | * <code>category</code> – 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 <!--"first-positional parameter", not "first positional parameter", if you value the readers' time ... but better yet --> leftmost parameter (the hatnote text) is omitted. | ||
== Example == | == Example == | ||
* | * → {{hatnote|Example hatnote text}} | ||
== Errors == | == Errors == | ||
| Line 47: | Line 42: | ||
# Some parameters were specified, but the hatnote text wasn't included. For example, the template text <code><nowiki>{{hatnote|extraclasses=seealso}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>|extraclasses=seealso}}</nowiki></code> instead. | # Some parameters were specified, but the hatnote text wasn't included. For example, the template text <code><nowiki>{{hatnote|extraclasses=seealso}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>|extraclasses=seealso}}</nowiki></code> 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 <code><nowiki>{{hatnote|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explicitly by using <code>1=</code> before the hatnote text, like this: <code><nowiki>{{hatnote|1=2+2=4}}</nowiki></code>. | # 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 <code><nowiki>{{hatnote|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explicitly by using <code>1=</code> before the hatnote text, like this: <code><nowiki>{{hatnote|1=2+2=4}}</nowiki></code>. | ||
# You tried to access | # You tried to access Module:Hatnote directly by using <code><nowiki>{{#invoke:hatnote|hatnote|</nowiki>''text''<nowiki>}}</nowiki></code>. Use of #invoke in this way has been disabled for performance reasons. Please use <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>}}</nowiki></code> instead. | ||
If you see this error message and are unsure of what to do, please post a message on | 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 | Pages that contain this error message are tracked in :Category:Hatnote templates with errors. | ||
== Technical details == | == Technical details == | ||
| Line 58: | Line 53: | ||
* {{tag|div|attribs=role="note" class="hatnote navigation-not-searchable"|link=yes|content= hatnote text}} | * {{tag|div|attribs=role="note" class="hatnote navigation-not-searchable"|link=yes|content= hatnote text}} | ||
The code is produced by | The code is produced by Module:Hatnote. | ||
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}} | {{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}} | ||
{{TemplateData header|noheader=1}} | {{TemplateData header|noheader=1}} | ||
Latest revision as of 18:11, 9 April 2025
| This page uses Creative Commons Licensed content from Wikipedia (view authors). |
 | 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 template uses Lua: |
This template produces formatted text, following the guideline for a Wikipedia hatnote:
- →
Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): Am I on the right page?
Function
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 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
- Basic usage
- All parameters
Parameters
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
- →
Errors
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
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.
TemplateData documentation used by VisualEditor and other tools
| |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
See a monthly parameter usage report for Template:Hatnote in articles based on its TemplateData.
TemplateData for Hatnote 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.
| |||||||||||||||||||||||||