Template:Hatnote/doc

Revision as of 23:44, 17 August 2020 by Saucy (talk | contribs) (create)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This template creates a hatnote. This is usually put at the top of a page or section.

Hatnotes tell the reader if they are on the right article. You have probably seen notices like "This article is about 1. For 2, see 3." at the top of Wikipedia articles, that is an example of a hatnote.

Example edit

{{hatnote|This article is about the user. For an actual, physical typewriter, then go to the [[wp:Typewriter|Typewriter]] Wikipedia article, you're on the wrong the website for that you fucking retard}} outputs:

Usage edit

Basic usage:

{{hatnote|text}}

All parameters:

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

Parameters edit

This template accepts the following parameters (but you probably only need to worry about the first one):

  • 1 - the hatnote text (required)
  • extraclasses - any extra CSS classes to be added
  • category - If set to "no", "n", "false", or "0", then it will suppress the error tracking category (Category:Hatnote templates with errors). This has an effect only if the hatnote text parameter is omitted.

Template data edit

Adds a hatnote. Hatnotes tell the reader if they are on the right article. You have probably seen notices like "This article is about 1. For 2, see 3." at the top of Wikipedia articles, that is an example of a hatnote.

Template parameters

ParameterDescriptionTypeStatus
Text1

The text of the hatnote

Stringrequired
extraclassesextraclasses

Any extra CSS classes to add

Stringoptional
categorycategory

If set to "no", "n", "false", or "0", it will suppress the error tracking category.

Booleanoptional