Template:Hatnote/doc: Difference between revisions

Latest revision as of 04:31, 3 September 2020

This is a documentation subpage for Template:Hatnote.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 354,000 pages, or roughly 5370% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Hatnote

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

Parameters

This template accepts the following parameters:

1 – the hatnote text (required)
extraclasses – any extra CSS classes to be added, for example, the {{see also}} template adds the classes "|extraclasses=boilerplate seealso".
selfref – If set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See Template:Selfref for more information.
category – If set to "no", "n", "false", or "0", suppresses the error tracking category (Category:Hatnote templates with errors). This has an effect only if the leftmost parameter (the hatnote text) is omitted.

Example

{{hatnote|Example hatnote text}} →

Errors

If no hatnote text is supplied, the template will output the following message:

If you see this error message, it is for one of four reasons:

No parameters were specified (the template code was {{hatnote}}). Please use {{hatnote|text}} instead.
Some parameters were specified, but the hatnote text wasn't included. For example, the template text {{hatnote|extraclasses=seealso}} will produce this error. Please use (for example) {{hatnote|text|extraclasses=seealso}} instead.
The hatnote text was specified, but that text contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code {{hatnote|2+2=4}} will produce this error. To work around this, you can specify the parameter name explicitly by using 1= before the hatnote text, like this: {{hatnote|1=2+2=4}}.
You tried to access Module:Hatnote directly by using {{#invoke:hatnote|hatnote|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use {{hatnote|text}} instead.

If you see this error message and are unsure of what to do, please post a message on Template talk:Hatnote, and someone should be able to help you.

Pages that contain this error message are tracked in Category:Hatnote templates with errors.

Technical details

The HTML code produced by this template looks like this:

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

The code is produced by Module:Hatnote.

Template parameters
Parameter		Description	Type	Status
Text	`1`	This field should contain the text that will be displayed in the hatnote.	String	required
Extra classes	`extraclasses`	Extra CSS classes to be added to the <div> tags surrounding the hatnote text.	Line	optional
Self reference	`selfref`	Set to "yes" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. "For the Wikipedia Sandbox, see [[WP:SAND]]".)	Line	optional
Category	`category`	Set to "no", "n", "false", or "0" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted.	Unknown	optional

@@ Line 1: / Line 1: @@
-<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude><!--
+{{Documentation subpage}}
+{{High-use| 369726 }}
+{{lua|Module:Hatnote}}
-                        EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
+This template produces formatted text, following the guideline for a '''[[WP:HATNOTE|Wikipedia hatnote]]'''.
-==Usage and purpose==
+:<code><nowiki>{{hatnote|Example hatnote text.}}</nowiki></code> &rarr;<br><!-- a construct to show hatnote as expected (using newline) -->
-This template is used to add disambiguation links (''dab'' is Wikipedia shorthand for "disambiguation") to the top of article pages, and is intended to be used only when other disambiguation link templates are found to be too restrictive for a given situation.  See [[Wikipedia:Otheruses templates (example usage)]] for a list of templates that should be first considered before using this one.
+{{hatnote|Example hatnote text.}}
-This template places an HTML div-/div block around the material given as its only argument, forcing browsers to react on the contained code.{{huh}} Contrary to what its name implies, it does not actually create a link of any kind.
+Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): ''Am I on the right page?''
-This is very useful for binding effects within other templates, or on disambig lines heading an article.
+{{TOC limit}}
-;Contents of the template: {{Fs|3|<nowiki><div class="dablink">{{{1}}}</div></nowiki>}}
-----
+== 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 <code>div-</code> / <code>div</code> 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.
-;5 Examples:(these use the {{tlx|indent}} family of templates for comparisions of forcing wrap effects, The last shows the effect of an embedded HTML <nowiki>'<br />'</nowiki> line break.)
+This template is also used as the "meta-template" for additional specialized disambiguation link templates; see [[:Category:Hatnote templates]] for a list.
-*(1) {{Fs|3|<nowiki>{{dablink|See also [[Murphy's Law]], [[Finagle's Law]] and [[Murphy's laws of combat]]. For the album by British rock band [[Spear of Destiny (band)|Spear of Destiny]], see [[Sod's Law (Spear of Destiny album)]]}}</nowiki>}}
-;gives
-{{dablink|See also [[Murphy's Law]], [[Finagle's Law]] and [[Murphy's laws of combat]]. For the album by British rock band [[Spear of Destiny (band)|Spear of Destiny]], see [[Sod's Law (Spear of Destiny album)]]}}
-----
-*(2) {{Fs|3|<nowiki>{{dablink|See also [[Murphy's Law]], [[Finagle's Law]] and [[Murphy's laws of combat]]. {{I}}For the album by British rock band [[Spear of Destiny (band)|Spear of Destiny]], see [[Sod's Law (Spear of Destiny album)]]}}</nowiki>}}
+The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal [[Wikipedia:Cheatsheet|Wikipedia markup]].
-;gives
-{{dablink|See also [[Murphy's Law]], [[Finagle's Law]] and [[Murphy's laws of combat]]. {{I}}For the album by British rock band [[Spear of Destiny (band)|Spear of Destiny]], see [[Sod's Law (Spear of Destiny album)]]}}
-----
-*(3) {{Fs|3|<nowiki>{{dablink|See also [[Murphy's Law]], [[Finagle's Law]] and [[Murphy's laws of combat]]. {{I|9}}For the album by British rock band [[Spear of Destiny (band)|Spear of Destiny]], see [[Sod's Law (Spear of Destiny album)]]}}</nowiki>}}
+== Usage ==
-;gives
+; Basic usage:
-{{dablink|See also [[Murphy's Law]], [[Finagle's Law]] and [[Murphy's laws of combat]]. {{I|9}}For the album by British rock band [[Spear of Destiny (band)|Spear of Destiny]], see [[Sod's Law (Spear of Destiny album)]]}}
+ &#123;{hatnote|''text''}}
-----
-*(4) {{Fs|3|<nowiki>{{dablink|See also [[Murphy's Law]], [[Finagle's Law]] and [[Murphy's laws of combat]]. {{I0}}For the album by British rock band [[Spear of Destiny (band)|Spear of Destiny]], see [[Sod's Law (Spear of Destiny album)]]}}</nowiki>}}
+; All parameters:
-;gives
+ &#123;{hatnote|''text''|extraclasses=''extra classes''|selfref=''yes''|category=''no''}}
-{{dablink|See also [[Murphy's Law]], [[Finagle's Law]] and [[Murphy's laws of combat]]. {{I0}}For the album by British rock band [[Spear of Destiny (band)|Spear of Destiny]], see [[Sod's Law (Spear of Destiny album)]]}}
-----
-*(5) {{Fs|3|<nowiki>{{dablink|See also [[Murphy's Law]], [[Finagle's Law]] and [[Murphy's laws of combat]]. <br />For the album by British rock band [[Spear of Destiny (band)|Spear of Destiny]], see [[Sod's Law (Spear of Destiny album)]]}}</nowiki>}}
+== Parameters ==
-;gives
+This template accepts the following parameters:
-{{dablink|See also [[Murphy's Law]], [[Finagle's Law]] and [[Murphy's laws of combat]]. <br />For the album by British rock band [[Spear of Destiny (band)|Spear of Destiny]], see [[Sod's Law (Spear of Destiny album)]]}}
+* <code>1</code> – the hatnote text (required)
-----
+* <code>extraclasses</code> – any extra CSS classes to be added, for example, the {{tl|see also}} template adds the classes "{{para|extraclasses|boilerplate seealso}}".
-<includeonly>
+* <code>selfref</code> – If set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See [[Template:Selfref]] for more information.
-<!-- ADD CATEGORIES BELOW THIS LINE -->
+* <code>category</code> – If set to "no", "n", "false", or "0", suppresses the error tracking category ([[:Category:Hatnote templates with errors]]). This has an effect only if the <!--"first-positional parameter", not "first positional parameter", if you value the readers' time ... but better yet --> leftmost parameter (the hatnote text) is omitted.
-[[Category:Disambiguation and redirection templates|Dablink]]
-<!-- ADD INTERWIKIS BELOW THIS LINE -->
+== Example ==
-[[ja:Template:Dablink]]
+* <code><nowiki>{{hatnote|Example hatnote text}}</nowiki></code> → {{hatnote|Example hatnote text}}
-[[sl:Predloga:Razpov]]
-</includeonly>
+== Errors ==
+If no hatnote text is supplied, the template will output the following message:
+* {{hatnote|category=no}}
+If you see this error message, it is for one of four reasons:
+# No parameters were specified (the template code was <code><nowiki>{{hatnote}}</nowiki></code>). Please use <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>}}</nowiki></code> instead.
+# Some parameters were specified, but the hatnote text wasn't included. For example, the template text <code><nowiki>{{hatnote|extraclasses=seealso}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>|extraclasses=seealso}}</nowiki></code> instead.
+# The hatnote text was specified, but that text contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code <code><nowiki>{{hatnote|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explicitly by using <code>1=</code> before the hatnote text, like this: <code><nowiki>{{hatnote|1=2+2=4}}</nowiki></code>.
+# You tried to access [[Module:Hatnote]] directly by using <code><nowiki>{{#invoke:hatnote|hatnote|</nowiki>''text''<nowiki>}}</nowiki></code>. Use of #invoke in this way has been disabled for performance reasons. Please use <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>}}</nowiki></code> instead.
+If you see this error message and are unsure of what to do, please post a message on [[Template talk:Hatnote]], and someone should be able to help you.
+Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]].
+== Technical details ==
+The HTML code produced by this template looks like this:
+* {{tag|div|attribs=role="note" class="hatnote"|link=yes|content= hatnote text}}
+The code is produced by [[Module:Hatnote]].
+==See also==
+* {{tl|For}}
+{{Hatnote templates}}
+{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
+{{TemplateData header|noheader=1}}
+<templatedata>
+{
+  "description": "Template for creating a standard Wikipedia hatnote. A hatnote is a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.",
+  "params": {
+    "1": {
+      "label": "Text",
+      "description": "This field should contain the text that will be displayed in the hatnote.",
+      "type": "string",
+      "required": true
+    },
+    "extraclasses": {
+      "type": "string/line",
+      "label": "Extra classes",
+      "description": "Extra CSS classes to be added to the <div> tags surrounding the hatnote text."
+    },
+    "selfref": {
+      "type": "string/line",
+      "label": "Self reference",
+      "description": "Set to \"yes\" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. \"For the Wikipedia Sandbox, see [[WP:SAND]]\".)"
+    },
+    "category": {
+      "label": "Category",
+      "description": "Set to \"no\", \"n\", \"false\", or \"0\" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted."
+    }
+  }
+}
+</templatedata>
+{{Collapse bottom}}<includeonly>{{Sandbox other||
+[[Category:Hatnote templates| ]]
+[[Category:Cross-reference templates]]
+}}</includeonly>

v t e Hatnote templates
Wikipedia:Hatnote Wikipedia:Disambiguation Wikipedia:Redirect
Generic	{{Hatnote}} {{Selfref}} (for self-references)
For and about	{{For}} {{For2}} (for custom text) {{About}} Variations: {{Other uses}} {{Other uses of}}
Other topics	{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other places}} {{Other ships}} {{Other hurricanes}}
Redirect	{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Technical reasons}}
Distinguish	{{Distinguish}} (supports custom text too) {{Redirect-distinguish}} {{Redirect-distinguish2}} (for custom text) {{Redirect-distinguish6}} {{About-distinguish}} {{About-distinguish2}} (for custom text)
For use in sections	{{Main}} {{Further}} {{Further2}} (for custom text) {{See also}} {{See also if exists}} {{For outline}}
Special	{{Broader}} {{See introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific	{{Year dab}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}} {{Other MeSH codes}}
Category:Hatnote templates modules for [family] names for lists hatnote templates for category pages

Template:Hatnote/doc: Difference between revisions

Latest revision as of 04:31, 3 September 2020

Contents

Function

Usage

Parameters

Example

Errors

Technical details

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools