Template:Hatnote/doc

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

{{hatnote|Example hatnote text.}} →

Example hatnote text.

Broadly speaking, a hatnote should answer a readers' 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.

The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal Wikipedia markup.

Usage

{{hatnote|text}}

Parameters

This template accepts the following parameters:

• 1 - the hatnote text (required)

Example

• {{hatnote|Example hatnote text}} →
  Example hatnote text

Technical details

The HTML code produced by this template looks like this:

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

Hatnote/doc

<templatedata> { "description": { "en": "Template for creating a standard hatnote. A hatnote is a short note placed at the top of an article or section to direct users to related pages", "cs": "Šablona pro vytvoření standardní hatnote. Hatnote je krátká poznámka umístěná v horní části článku nebo sekce, která uživatele nasměruje na související stránky" }, "format": "inline", "params": { "1": { "aliases": [ "text" ], "label": "Text", "description": { "en": "This field should contain the text that will be displayed in the hatnote.", "cs": "Toto pole by mělo obsahovat text, který se zobrazí v hatnote." }, "type": "string", "required": true, "example": { "en": "Insert text here.", "cs": "Sem vložte text." } }, "extraclasses": { "label": { "en": "Extra classes", "cs": "Extra třídy" }, "description": { "en": "Comma-separated list of CSS class names", "cs": "Seznam názvů tříd CSS oddělených čárkami" }, "type": "string" } },

 "paramOrder": [
   "1",
   "extraclasses"
 ]

} </templatedata>