Vorlage:Hatnote/doc

Aus skandinavien-wiki.net
Gnome-emblem-important.svg
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 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}}

Technical details

The HTML code produced by this template looks like this:

  • <div role="note" class="hatnote">hatnote text</div>

The code is produced by Module:Hatnote.

See also

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

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.

Vorlagenparameter

ParameterBeschreibungTypStatus
Text1

This field should contain the text that will be displayed in the hatnote.

Mehrzeiliger Texterforderlich
Extra classesextraclasses

Extra CSS classes to be added to the <div> tags surrounding the hatnote text.

Einzeiliger Textoptional
Self referenceselfref

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]]".)

Einzeiliger Textoptional
Categorycategory

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.

Unbekanntoptional