Editing Template:Hatnote/doc

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 ===
<code><nowiki>{{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}}</nowiki></code> outputs:

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

=== Usage ===
Basic usage:
 &#123;{hatnote|''text''}}

All parameters:
 &#123;{hatnote|''text''|extraclasses=''extra classes''<!--|selfref=''yes''-->|category=''no''}}

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

* <code>1</code> - the hatnote text (required)
* <code>extraclasses</code> - any extra CSS classes to be added
<!--* <code>selfref</code> - If set you "yes", "y", "true", or "1", it adds the CSS class "selfref". This is used to denote self-references to Irony Hub Wiki. This would be used when linking to pages in the Irony Hub Wiki namespace.-->
* <code>category</code> - 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 ===
<templatedata>
{
	"params": {
		"1": {
			"label": "Text",
			"description": "The text of the hatnote",
			"type": "string",
			"required": true
		},
		"extraclasses": {
			"description": "Any extra CSS classes to add",
			"type": "string"
		},
		"category": {
			"description": "If set to \"no\", \"n\", \"false\", or \"0\", it will suppress the error tracking category.",
			"type": "boolean"
		}
	},
	"description": "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."
}
</templatedata>