Editing Template:Hatnote/doc

{{Documentation/Header}}
{{Lua|Hatnote}}
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?

==Syntax==
; Basic usage:
{{T|Hatnote|''text''}}

; All parameters:
{{T|Hatnote|''text''|extraclasses=''extra classes''|selfref=''yes''|category=''no''}}

==Parameters==
This template accepts the following parameters:
* {{F|1}} &mdash; the Hatnote text (required)
* {{F|extraclasses}} &mdash; any extra CSS classes to be added.
* {{F|selfref}} &mdash; If set to "yes," "y," "true" or "1," adds the CSS class "selfref." This is used to denote self-references.
* {{F|category}} &mdash; 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==
* {{T|Hatnote|Example Hatnote text|_Y_=1}}

==Typical Types==
{{T|Main}} and {{T|Further}} are very similar, but indicate either the primary page for a topic or more detailed related topic. They have a nearly identical set of parameters.

;{{T|Main}}: When an article is large, it often has a summary and a link to a main article. This template is used after the heading of the summary, to indicate a link to the subtopic article that has been summarized.
;{{T|Further}}: Used to link to articles containing further information on this topic.
;{{T|See also}}: Used to link to additional articles on related topics.

:;{{T|Main|Main Page|_Y_=1}}
:;{{T|Main|Main Page|Main Page|_Y_=1}}

:*{{F|1}}, {{F|2}}, {{F|3}}, ... – the pages to link to. If no page names are specified, the current page name is used instead (without the namespace prefix). Categories and files are automatically escaped with the ''colon trick'', and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.
:*{{F|l1}}, {{F|l2}}, {{F|l3}}, ... ''or''{{F|label 1}}, {{F|label 2}}, {{F|label 3}}, ... – optional labels for each of the pages to link to (this is for articles where a piped link would be used). Note that the extra parameters use a lower case 'L', for example, {{F|l1}}, '''''not''''' {{F|L1}}.
:*{{F|selfref}} – if set to "yes," "y," "true" or "1," adds the CSS class "selfref." This is used to denote self-references.

==Disambiguation==
Templates such as {{T|About}} and {{T|For}} are to be used in cases where a disambiguation is not needed. In general, disambiguation pages should only be used for 4 or more titles that are mostly or entirely identical, except for a qualifier.
;{{T|About}}: Links the reader to other articles with similar titles or concepts that they may have been seeking instead. The template has several formats, including:
:;{{T|About|Use1|_Y_=1}}
:;{{T|About|Use1||Main Page|_Y_=1}}
:;{{T|About|Use1||Main Page|and|Main Page|_Y_=1}}
:;{{T|About|Use1|Use2|Main Page|_Y_=1}}
:;{{T|About|Use1|Use2|Main Page|and|Main Page|_Y_=1}}
:;{{T|About|Use1|Use2|Main Page|other uses|_Y_=1}}

Alternately, a {{F|1=section=yes}} parameter can be added to the {{T|About}} template for use at the top of a section. When using this parameter, the wording in the template changes to specify that it is being used in a section:
:;{{T|About|Use1|p2=section=yes|_Y_=1}}
:;{{T|About|Use1||Main Page|p4=section=yes|_Y_=1}}
:;{{T|About|Use1|Use2|Main Page|p4=section=yes|_Y_=1}}
:;{{T|About|Use1|Use2|Main Page|and|Main Page|p6=section=yes|_Y_=1}}
:;{{T|About|Use1|Use2|Main Page|other uses|p5=section=yes|_Y_=1}}

A <var>text</var> option adds text to the end; note that this should be only used when truly necessary, and the other Hatnote templates listed below don't suffice. This template also supports <var>selfref</var>.

;{{T|For}}: Provides links to up to four articles or disambiguation pages. It accepts zero to five parameters.

:;If used without parameters on a page named ''Foo'', the result is
::{{Hatnote|For other uses, see [[:Foo (disambiguation)]].}}
:;The first parameter changes the Hatnote itself and should be plain text, e.g. {{T|For|similar terms}} yields
::{{Hatnote|For similar terms, see [[:Foo (disambiguation)]].}}
:;The second parameter is used to change the resultant link, e.g. {{T|For|similar terms|Main Page}} yields
::{{For|similar terms|Main Page}}
:;The third, fourth and fifth parameters are used to give one, two, or three supplementary links:
:*{{For|similar terms|Main Page|Main Page}}
:*{{For|similar terms|Main Page|Main Page|Main Page}}
:*{{For|similar terms|Main Page|Main Page|Main Page|Main Page}}
:the last being produced by e.g. {{T|For|similar terms|Main Page|Main Page|Main Page|Main Page}}.

==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 {{T|Hatnote}}). Please use {{T|Hatnote|''text''}} instead.
# Some parameters were specified, but the Hatnote text wasn't included. For example, the template text {{T|Hatnote|extraclasses=seealso}} will produce this error. Please use (for example) {{T|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 {{T|Hatnote|2+2{{=}}4}} will produce this error. To work around this, you can specify the parameter name explicitly by using {{F|1=}} before the Hatnote text, like this: {{T|Hatnote|p1=1=2+2=4}}
# You tried to access [[Module:Hatnote]] directly by using {{F|<nowiki>{{#invoke:Hatnote|Hatnote|''text''}}</nowiki>}} Use of #invoke in this way has been disabled for performance reasons. Please use {{T|Hatnote|''text''}} instead.

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

==Technical Details==
This template uses the [[w: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]]'''.

The HTML code produced by this template looks like this:

* {{F|<nowiki><div role="note" class="Hatnote"></nowiki>''Hatnote text''<nowiki></div></nowiki>}}