Importer, Bürokraten, Moderatoren (CommentStreams), Strukturierte-Diskussionen-Bots, Oberflächenadministratoren, Push-Abonnementverwalter, Oversighter, Administratoren, Kampagnenbearbeiter (Hochladeassistent)
855
Bearbeitungen
(update TemplateData) |
K (172 Versionen von wpen:Template:Hatnote/doc importiert) |
||
| (77 dazwischenliegende Versionen von 33 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{ | {{Redirect|Template:Dablink|the maintenance template|Template:Dablinks}} | ||
{{ | {{High-use| 369726 }} | ||
{{Never substitute}} | |||
{{lua|Module:Hatnote}} | {{lua|Module:Hatnote}} | ||
This template | This template produces formatted text, following the guideline for a '''[[WP:HATNOTE|Wikipedia hatnote]]'''. | ||
:<code><nowiki>{{hatnote|Example hatnote text.}}</nowiki></code> →<br><!-- a construct to show hatnote as expected (using newline) --> | |||
{{hatnote|Example hatnote text.}} | |||
Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): ''Am I on the right page?'' | |||
{{TOC limit}} | {{TOC limit}} | ||
| Zeile 11: | Zeile 16: | ||
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 [[: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:Cheatsheet|Wikipedia markup]]. | The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal [[Wikipedia:Cheatsheet|Wikipedia markup]]. | ||
== Usage == | == Usage == | ||
; Basic usage: | ; Basic usage: | ||
{{hatnote|''text''}} | {{hatnote|''text''}} | ||
| Zeile 24: | Zeile 28: | ||
== Parameters == | == Parameters == | ||
This template accepts the following parameters: | |||
* <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>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 ([[: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 == | |||
* <code> | * <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}} | ||
If you see this error message, it is for one of | If you see this error message, it is for one of four reasons: | ||
# No parameters | # No parameters were specified (the template code was <code><nowiki>{{hatnote}}</nowiki></code>). Please use <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>}}</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>. | ||
# 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 and are unsure of what to do, please post a message on [[Template talk:Hatnote]], and someone should be able to help you. | 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 == | == 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}} | |||
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}} | |||
{{TemplateData header|noheader=1}} | |||
{{Hatnote templates | |||
{{Collapse top|TemplateData}} | |||
{{ | |||
<templatedata> | <templatedata> | ||
{ | { | ||
| Zeile 89: | Zeile 91: | ||
} | } | ||
</templatedata> | </templatedata> | ||
{{Collapse bottom}} | {{Collapse bottom}}<includeonly>{{Sandbox other|| | ||
[[Category:Hatnote templates| ]] | |||
<includeonly> | [[Category:Cross-reference templates]] | ||
[[Category:Hatnote templates]] | }}</includeonly> | ||
</includeonly> | |||