Template:Hatnote/doc

From Our World of Text Wiki
< Template:Hatnote
Revision as of 12:45, 7 November 2024 by Dat Hack3r (talk | contribs) (Created template documentation.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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}}