Template:Hatnote/doc: Difference between revisions
hatnote would not work if substituted |
Antoniokf5 (talk | contribs) m 1 revision imported |
||
Line 1: | Line 1: | ||
The hatnotes used for adding links between articles where more context is important. |
|||
{{Documentation subpage}} |
|||
Broadly speaking, a hatnote should answer a readers' question: Am I on the right page? |
|||
{{High-use| 369726 }} |
|||
{{Never substitute}} |
|||
{{lua|Module:Hatnote}} |
|||
This template produces formatted text, following the guideline for a '''[[WP:HATNOTE|Wikipedia hatnote]]'''. |
|||
:<code><nowiki>{{hatnote|Example hatnote text.}}</nowiki></code> →<br><!-- a construct to show hatnote as expected (using newline) --> |
|||
{{hatnote|Example hatnote text.}} |
|||
Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): ''Am I on the right page?'' |
|||
{{TOC limit}} |
|||
== 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. |
|||
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:Cheatsheet|Wikipedia markup]]. |
|||
== Usage == |
== Usage == |
||
; Basic usage: |
; Basic usage: |
||
{{hatnote|''text''}} |
{{hatnote|''text''}} |
||
Line 27: | Line 11: | ||
== Parameters == |
== Parameters == |
||
This template accepts the following parameters: |
This template accepts the following parameters: |
||
* <code>1</code> |
* <code>1</code> - the hatnote text (required) |
||
* <code>extraclasses</code> |
* <code>extraclasses</code> - any extra CSS classes to be added. |
||
* <code>selfref</code> |
* <code>selfref</code> - If set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references. |
||
* <code>category</code> |
* <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 leftmost parameter (the hatnote text) is omitted. |
||
== Example == |
== 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}} |
||
== Typical types == |
|||
{{T|Main}}, {{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}} →:{{Main|Main Page}} |
|||
:;{{T|Main|Main Page|Main Page}} →:{{Main|Main Page|Main Page}} |
|||
:*<code>1</code>, <code>2</code>, <code>3</code>, ... – 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 [[w:Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''. |
|||
:*<code>l1</code>, <code>l2</code>, <code>l3</code>, ... ''or''<code>label 1</code>, <code>label 2</code>, <code>label 3</code>, ... – 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, <code>l1</code>, <u>not</u> <code>L1</code>. |
|||
:*<code>selfref</code> – 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}} →:{{About|}} |
|||
:;{{T|About|Use1|<nowiki/>|Main Page}} →:{{About|Use1||Main Page}} |
|||
:;{{T|About|Use1|<nowiki/>|Main Page|and|Main Page}} →:{{About|Use1||Main Page|and|Main Page}} |
|||
:;{{T|About|Use1|Use2|Main Page}} →:{{About|Use1|Use2|Main Page}} |
|||
:;{{T|About|Use1|Use2|Main Page|and|Main Page}} →:{{About|Use1|Use2|Main Page|and|Main Page}} |
|||
:;{{T|About|Use1|Use2|Main Page|other uses}} →:{{About|Use1|Use2|Main Page|other uses}} |
|||
Alternately, a <code>section=yes</code> 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|<nowiki>section=yes</nowiki>}} →:{{About|Use1|section=yes}} |
|||
:;{{T|About|Use1|<nowiki/>|Main Page|<nowiki>section=yes</nowiki>}} →:{{About|Use1||Main Page|section=yes}} |
|||
:;{{T|About|Use1|Use2|Main Page|<nowiki>section=yes</nowiki>}} →:{{About|Use1|Use2|Main Page|section=yes}} |
|||
:;{{T|About|Use1|Use2|Main Page|and|Main Page|<nowiki>section=yes</nowiki>}} →:{{About|Use1|Use2|Main Page|and|Main Page|section=yes}} |
|||
:;{{T|About|Use1|Use2|Main Page|other uses|<nowiki>section=yes</nowiki>}} →:{{About|Use1|Use2|Main Page|other uses|section=yes}} |
|||
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 == |
== Errors == |
||
If no hatnote text is supplied, the template will output the following message: |
If no hatnote text is supplied, the template will output the following message: |
||
* {{hatnote|category=no}} |
* {{hatnote|category=no}} |
||
Line 45: | Line 80: | ||
# 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. |
||
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]]. |
Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]]. |
||
== Technical details == |
== 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: |
|||
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]]. |
|||
* <code><nowiki><div role="note" class="hatnote"></nowiki>''hatnote text''<nowiki></div></nowiki></code> |
|||
==See also== |
|||
* {{tl|For}} |
|||
<includeonly>[[Category:Notice templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude> |
|||
{{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> |
Revision as of 12:31, 20 June 2021
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}}
→
Typical types
{{Main}}, {{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.
- {{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.
- {{Further}}
- Used to link to articles containing further information on this topic.
- {{See also}}
- Used to link to additional articles on related topics.
1
,2
,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.l1
,l2
,l3
, ... orlabel 1
,label 2
,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,l1
, notL1
.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 {{About}} and {{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.
- {{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:
Alternately, a section=yes
parameter can be added to the {{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:
A text 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 selfref.
- {{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
- The first parameter changes the hatnote itself and should be plain text, e.g. {{For}} yields
- The second parameter is used to change the resultant link, e.g. {{For}} yields
- The third, fourth and fifth parameters are used to give one, two, or three supplementary links
- the last being produced by e.g. {{For}}.
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 using1=
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>