Template:Hatnote/doc: Difference between revisions

Help

Latest revision as of 20:03, 22 March 2023

The hatnotes used for adding links between articles where more context is important. Broadly speaking, a hatnote should answer a readers' question: Am I on the right page?

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.
selfref - If set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references.
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:

Error: no text specified (help).

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.

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

Technical details

This template uses the Lua templating language, and more information can be found on the Global Lua Module page. For a traditional wikitext version of this template, see Hatnote on Templates Wiki.

The HTML code produced by this template looks like this:

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

@@ Line 4: / Line 4: @@
 == Usage ==
-; Basic usage:
+===Basic usage===
- &#123;{hatnote|''text''}}
+<pre>
+{{Hatnote|''text''}}
-; All parameters:
+</pre>
- &#123;{hatnote|''text''|extraclasses=''extra classes''|selfref=''yes''|category=''no''}}
+===All parameters===
+<pre>
+{{Hatnote|''text''|extraclasses=''extra classes''|selfref=''yes''|category=''no''}}
+</pre>
 == Parameters ==
@@ Line 20: / Line 23: @@
 == Example ==
-* <code><nowiki>{{hatnote|Example hatnote text}}</nowiki></code> → {{hatnote|Example hatnote text}}
+* <code><nowiki>{{Hatnote|Example hatnote text}}</nowiki></code> → {{hatnote|Example hatnote text}}
 == Errors ==
 If no hatnote text is supplied, the template will output the following message:
-* {{hatnote|category=no}}
+* {{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.
+# 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.
+# 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>.
+# 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.
+# 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.
 Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]].
@@ Line 37: / Line 40: @@
 == Technical details ==
-This template uses the [[Help:Lua|Lua templating language]], and more information can be found [[w:c:dev:Global_Lua_Modules/Hatnote|on the Global Lua Module page]]. '''For a traditional wikitext version of this template, see [[w:c:templates:Template:Hatnote|Hatnote on Templates Wiki]]'''.
+This template uses the [[wikia:Help:Lua|Lua templating language]], and more information can be found [[wikia:dev:Global_Lua_Modules/Hatnote|on the Global Lua Module page]]. '''For a traditional wikitext version of this template, see [[wikia:templates:Template:Hatnote|Hatnote on Templates Wiki]]'''.
 The HTML code produced by this template looks like this:
 * <code><nowiki><div role="note" class="hatnote"></nowiki>''hatnote text''<nowiki></div></nowiki></code>
-<includeonly>[[Category:Templates|{{PAGENAME}}]][[Category:Templates/Context-link|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>