Template:Hatnote/doc: Difference between revisions
m Reverted 1 edit by 66.87.64.69 (talk) to last revision by Eyesnore. (TW) |
m 165 revisions imported from wikipedia:Template:Hatnote/doc |
||
(27 intermediate revisions by 20 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{High-use| 369726 }} |
|||
{{Never substitute}} |
|||
{{shortcut|T:HAT}} |
|||
{{lua|Module:Hatnote}} |
{{lua|Module:Hatnote}} |
||
Line 8: | Line 8: | ||
{{hatnote|Example hatnote text.}} |
{{hatnote|Example hatnote text.}} |
||
Broadly speaking, a hatnote should answer a |
Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): ''Am I on the right page?'' |
||
{{TOC limit}} |
{{TOC limit}} |
||
Line 20: | Line 20: | ||
== Usage == |
== Usage == |
||
; Basic usage: |
; Basic usage: |
||
{{hatnote|''text''}} |
{{hatnote|''text''}} |
||
Line 28: | Line 27: | ||
== Parameters == |
== Parameters == |
||
This template accepts the following parameters: |
This template accepts the following parameters: |
||
* <code>1</code> |
* <code>1</code> – the hatnote text (required) |
||
* <code>extraclasses</code> |
* <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> |
* <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> |
* <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 == |
||
* <code><nowiki>{{hatnote|Example hatnote text}}</nowiki></code> → {{hatnote|Example hatnote text}} |
* <code><nowiki>{{hatnote|Example hatnote text}}</nowiki></code> → {{hatnote|Example hatnote text}} |
||
== Errors == |
== Errors == |
||
If no hatnote text is supplied, the template will output the following message: |
If no hatnote text is supplied, the template will output the following message: |
||
* {{hatnote|category=no}} |
* {{hatnote|category=no}} |
||
Line 55: | Line 51: | ||
== Technical details == |
== Technical details == |
||
The HTML code produced by this template looks like this: |
The HTML code produced by this template looks like this: |
||
* |
* {{tag|div|attribs=role="note" class="hatnote navigation-not-searchable"|link=yes|content= hatnote text}} |
||
The code is produced by [[Module:Hatnote]]. |
The code is produced by [[Module:Hatnote]]. |
||
==See also== |
|||
* {{tl|For}} |
|||
{{Hatnote templates}} |
{{Hatnote templates}} |
||
{{Collapse top|TemplateData}} |
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}} |
||
{{TemplateData header|noheader=1}} |
|||
{{TemplateDataHeader}} |
|||
<templatedata> |
<templatedata> |
||
{ |
{ |
||
Line 92: | Line 90: | ||
} |
} |
||
</templatedata> |
</templatedata> |
||
{{Collapse bottom}}<includeonly>{{ |
{{Collapse bottom}}<includeonly>{{Sandbox other|| |
||
[[Category:Hatnote templates| ]] |
[[Category:Hatnote templates| ]] |
||
[[Category:Cross-reference templates]] |
[[Category:Cross-reference templates]] |
Latest revision as of 02:20, 21 March 2022
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 is used on approximately 370,000 pages, or roughly 6704% 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 should not be substituted. |
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 based on this 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.
|