Template:Hatnote

From mediawiki.org
Jump to navigation Jump to search
Template documentation

This template produces formatted text, following the guideline for a hatnote.

{{hatnote|Example hatnote text.}}

Broadly speaking, a hatnote should answer a readers' question (maybe preemptively): Am I on the right page?

Function[edit]

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.

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]

{{hatnote|text}}


Parameters[edit]

This template accepts the following parameters:

  • 1 - the hatnote text (required)

Example[edit]

  • {{hatnote|Example hatnote text}}

Technical details[edit]

The HTML code produced by this template looks like this:

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