Template:Hatnote/doc: Difference between revisions
From Zoophilia Wiki
Jump to navigationJump to search
meta>Steel1943 added note regarding template being converted to Lua Module:Hatnote |
meta>Mr. Stradivarius update after conversion to Module:Hatnote |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{ | {{high-risk|819,000+}} | ||
{{ | {{shortcut|T:HAT}} | ||
{{ | {{lua|Module:Hatnote}} | ||
This template formats text into the standard stylistic for a [[Wikipedia:Hatnote|Wikipedia hatnote]]. It produces a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries. | |||
{{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 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. | ||
| Line 13: | Line 15: | ||
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]]. | 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 == | ||
<code><nowiki><div class=" | |||
; Basic usage: | |||
{{hatnote|''text''}} | |||
; All parameters: | |||
{{hatnote|''text''|extraclasses=''extra classes''|selfref=''yes''|category=''no''}} | |||
== Parameters == | |||
This template accepts the following parameters: | |||
* <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}}. | |||
* <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. | |||
* <code>category</code> - if set to "no", "n", "false", or "0", suppresses the error tracking category ([[:Category:Hatnote templates with errors]]). This only has an effect if the first positional parameter (the hatnote text) is omitted. | |||
== 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 three reasons: | |||
# No parameters have been specified. This error can be produced by using the template code <code><nowiki>{{hatnote}}</nowiki></code>. Please use <code><nowiki>{{hatnote|</nowiki>''text''<nowiki>}}</nowiki></code> instead. | |||
# You specified some parameters, but the first positional parameter wasn't included. Using (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. | |||
# You specified the hatnote text, but that text contains an equals sign ("="). Due to the way templates work on Wikipedia, all the text before the first equals sign becomes the parameter name. For example, in the template <code><nowiki>{{hatnote|2+2=4}}</nowiki></code>, "2+2" becomes the parameter name, and "4" becomes the parameter value. This means that no text is passed to the first positional parameter, and the template thinks that no hatnote text has been specified. To work around this, you can specify the first positional parameter explictly, like this: <code><nowiki>{{hatnote|1=2+2=4}}</nowiki></code>. | |||
If you see this error and are unsure of what to do, please post a message on [[Template talk:Hatnote]], and someone should be able to help you. | |||
== Technical details == | |||
The HTML code produced by this template looks like this: | |||
* <code><nowiki><div class="hatnote"></nowiki>''hatnote text''<nowiki></div></nowiki></code> | |||
The code is produced by [[Module:Hatnote]]. | |||
==Redirects== | |||
* [[Template:Dablink]] | |||
* [[Template:Rellink]] | |||
==Template data== | {{Hatnote templates documentation}} | ||
== Template data == | |||
{{TemplateDataHeader}} | {{TemplateDataHeader}} | ||
<templatedata>{ | <templatedata>{ | ||
| Line 30: | Line 70: | ||
} | } | ||
}}</templatedata> | }}</templatedata> | ||
<includeonly> | <includeonly> | ||
[[Category:Hatnote templates]] | [[Category:Hatnote templates]] | ||
</includeonly> | </includeonly> | ||
Revision as of 05:48, 5 May 2014
 | 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 354,000+ pages, or roughly 5213% 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: |
This template formats text into the standard stylistic for a Wikipedia hatnote. It produces a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.
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 Wikipedia:Hatnote test 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 only has an effect if the first positional parameter (the hatnote text) is omitted.
Errors
If no hatnote text is supplied, the template will output the following message:
- {{{1}}}
If you see this error message, it is for one of three reasons:
- No parameters have been specified. This error can be produced by using the template code
{{hatnote}}. Please use{{hatnote|text}}instead. - You specified some parameters, but the first positional parameter wasn't included. Using (for example) the template text
{{hatnote|extraclasses=seealso}}will produce this error. Please use (for example){{hatnote|text|extraclasses=seealso}}instead. - You specified the hatnote text, but that text contains an equals sign ("="). Due to the way templates work on Wikipedia, all the text before the first equals sign becomes the parameter name. For example, in the template
{{hatnote|2+2=4}}, "2+2" becomes the parameter name, and "4" becomes the parameter value. This means that no text is passed to the first positional parameter, and the template thinks that no hatnote text has been specified. To work around this, you can specify the first positional parameter explictly, like this:{{hatnote|1=2+2=4}}.
If you see this error and are unsure of what to do, please post a message on Template talk:Hatnote, and someone should be able to help you.
Technical details
The HTML code produced by this template looks like this:
<div class="hatnote">hatnote text</div>
The code is produced by Module:Hatnote.
Redirects
Template:Hatnote templates documentation
Template data
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.
TemplateData for Hatnote
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Text | 1 | This field should contain the text that will be displayed in the hatnote. | String | required |
