Vorlage:Hatnote/doc: Unterschied zwischen den Versionen

Aktuelle Version vom 13. Januar 2023, 13:08 Uhr

Lua-Fehler in Modul:Redirect_hatnote, Zeile 66: attempt to call field 'quote' (a nil value)

Diese Vorlage wird auf 369726 Seiten verwendet

Um große Unterbrechungen und unnötige Serverauslastung zu vermeiden, solltest du Änderungen an anderer Stelle testen, indem du beispielsweise den Quellcode dieser Vorlage kopierst und in den Benutzerbereich oder in die Sandbox einfügst. Erwäge, deine Änderungen auf der Diskussionsseite vorzuschlagen, bevor du diese Vorlage bearbeitest.

This template should not be substituted.

Diese Vorlage benutzt Module:Hatnote, Skripte geschrieben in der Programmiersprache Lua. Bitte informiere dich dort, wenn du mehr über die Sprache und ihren Einsatz erfahren willst. Diese Vorlagen sollte im Regelfall nicht ersetzt werden.

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

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

Basic usage

{{hatnote|text}}

All parameters

{{hatnote|text|extraclasses=extra classes|selfref=yes|category=no}}

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

{{hatnote|Example hatnote text}} →

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 using 1= 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.

@@ Zeile 1: / Zeile 1: @@
 {{Documentation subpage}}
+{{Redirect|Template:Dablink|the maintenance template|Template:Dablinks}}
+{{High-use| 369726 }}
+{{Never substitute}}
+{{lua|Module:Hatnote}}
-==Usage==
+This template produces formatted text, following the guideline for a '''[[WP:HATNOTE|Wikipedia hatnote]]'''.
-Using {{tlx|dablink|''text''}} formats text into the standard stylistic for a [[Wikipedia:Hatnote|Wikipedia hatnote]]. That produces a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.
+:<code><nowiki>{{hatnote|Example hatnote text.}}</nowiki></code> &rarr;<br><!-- a construct to show hatnote as expected (using newline) -->
+{{hatnote|Example hatnote text.}}
-===Other disambiguation templates===
+Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): ''Am I on the right page?''
-This template may ''not'' be the desired template for your applications. See [[Template:Otheruses templates]] for a comparison and index of the alternatives.
-==Usage and purpose==
+{{TOC limit}}
-This template is primarily used to add ''disambiguation links'' (''dab'' is Wikipedia shorthand for "disambiguation") to the top of article pages. It places an HTML <code>div-</code> / <code>div</code> block around the material given 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 [[Wikipedia:Otheruses templates (example usage)]] for a list.
+== 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.
-Contrary to what its name may imply, 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]].
+This template is also used as the "meta-template" for additional specialized disambiguation link templates; see [[:Category:Hatnote templates]] for a list.
-==Template contents==
+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]].
-<code><nowiki><div class="dablink"></div></nowiki></code>
+== Usage ==
+; Basic usage:
+ &#123;{hatnote|''text''}}
+; All parameters:
+ &#123;{hatnote|''text''|extraclasses=''extra classes''|selfref=''yes''|category=''no''}}
+== 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><nowiki>{{hatnote|Example hatnote text}}</nowiki></code> → {{hatnote|Example hatnote text}}
+== Errors ==
+If no hatnote text is supplied, the template will output the following message:
+* {{hatnote|category=no}}
+If you see this error message, it is for one of four reasons:
+# 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 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:
+* {{tag|div|attribs=role="note" class="hatnote navigation-not-searchable"|link=yes|content= hatnote text}}
+The code is produced by [[Module:Hatnote]].
 ==See also==
-*{{tlx|Looking}} - "You may be looking for..."
+* {{tl|For}}
-*{{tlx|Disambig}} (Disambiguation}}
-* {{tlx|Hatnote templates documentation}}
-<includeonly>
-[[Category:Hatnote templates]]
-[[ca:Plantilla:Metacaixa enllaç de desambiguació]]
+{{Hatnote templates}}
-[[cy:Nodyn:Dolengyfeirio]]
+{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
-[[et:Mall:Dablink]]
+{{TemplateData header|noheader=1}}
-[[ja:Template:Dablink]]
+<templatedata>
-[[ka:თარგი:Dablink]]
+{
-[[no:mal:Dablink]]
+  "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.",
-</includeonly>
+  "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 <div> 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>
+{{Collapse bottom}}<includeonly>{{Sandbox other||
+[[Category:Hatnote templates| ]]
+[[Category:Cross-reference templates]]
+}}</includeonly>

v t e Hatnote templates
Wikipedia:Hatnote Wikipedia:Disambiguation Wikipedia:Redirect
Generic	{{Hatnote}} {{Selfref}} (for self-references)
For and about	{{For}} {{For-text}} (for custom text) {{For multi}} (for multiple uses) {{About}} Variations: {{Other uses}} {{Other uses of}} {{Redirect-distinguish-for}} {{About-distinguish}} {{About-distinguish-text}}
Other topics	{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other places}} {{Other ships}} {{Other hurricanes}}
Redirect	{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Redirect-distinguish-text}} {{Redirect-distinguish-for}} {{Technical reasons}}
Distinguish	{{Distinguish}} (supports custom text too) {{Redirect-distinguish}} {{Redirect-distinguish-text}} (for custom text) {{Redirect-distinguish-for}} {{About-distinguish}} {{About-distinguish-text}} (for custom text)
For use in sections	{{Main}} {{Further}} {{Further-text}} (for custom text) {{Further ill}} {{See also}} {{See also if exists}} {{For outline}} {{For timeline}}
Special	{{Broader}} {{See introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific	{{Year dab}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}}
Category:Hatnote templates modules for [family] names for lists hatnote templates for category pages