Template:Hatnote/doc: Difference between revisions

Content deleted Content added
simplify lede
m 165 revisions imported from wikipedia:Template:Hatnote/doc
 
(47 intermediate revisions by 31 users not shown)
Line 1:
{{Documentation subpage}}
{{shortcutHigh-use|T:HAT 369726 }}
{{Never substitute}}
{{lua|Module:Hatnote}}
 
Line 7 ⟶ 8:
{{hatnote|Example hatnote text.}}
 
Broadly speaking, a hatnote should answer a readersreader's question (maybe preemptively): ''Am I on the right page?''.
 
{{TOC limit}}
Line 19 ⟶ 20:
 
== Usage ==
 
; Basic usage:
{{hatnote|''text''}}
Line 27:
 
== Parameters ==
 
This template accepts the following parameters:
* <code>1</code> - the hatnote text. (required)
* <code>extraclasses</code> - any extra CSS classes to be added., Forfor example, the {{tl|see also}} template adds the classes "{{para|extraclasses|boilerplate seealso}}".
* <code>selfref</code> - ifIf 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.
* <code>category</code> - ifIf set to "no", "n", "false", or "0", suppresses the error tracking category ([[:Category:Hatnote templates with errors]]). This only 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.
 
== Example ==
* <code><nowiki>{{hatnote|Example hatnote text}}</nowiki></code> &rarr; {{hatnote|Example hatnote text}}
 
* <code><nowiki>{{hatnote|Example hatnote text}}</nowiki></code> &rarr; {{hatnote|Example hatnote text}}
 
== Errors ==
 
If no hatnote text is supplied, the template will output the following message:
* {{hatnote|category=no}}
Line 46 ⟶ 43:
# 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 explictlyexplicitly 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.
 
Line 54 ⟶ 51:
 
== Technical details ==
 
The HTML code produced by this template looks like this:
 
* <code><nowiki><{{tag|div|attribs=role="note" class="hatnote navigation-not-searchable"></nowiki>''|link=yes|content= hatnote text''<nowiki></div></nowiki></code>}}
 
The code is produced by [[Module:Hatnote]].
 
==See also==
{{Hatnote templates documentation}}
* {{tl|For}}
{{Collapse top|TemplateData}}
 
{{TemplateDataHeader}}
{{Hatnote templates documentation}}
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
Line 91 ⟶ 90:
}
</templatedata>
{{Collapse bottom}}<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandboxSandbox other||
[[Category:Hatnote templates| ]]
[[Category:Cross-reference templates]]
}}</includeonly>