Jump to content

Teamplaid:Hatnote/documentation

O Wiktionary

This template produces formatted text, following the guideline for a Wikipedia Hatnote.

{{Hatnote|Example Hatnote text.}}

Broadly speaking, a Hatnote should answer a readers' question (maybe preemptively): Am I on the right page?

Foincsean - Function[deasaich]

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 Roinn-seòrsa: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 markup.

Ùsaid - Usage[deasaich]

Basic usage
{{Hatnote|text}}
All parameters
{{Hatnote|text|extraclasses=extra classes|selfref=yes|category=no}}


Paramadairean - Parameters[deasaich]

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 (Roinn-seòrsa:Hatnote templates with errors). This has an effect only if the leftmost parameter (the Hatnote text) is omitted.

Eisimpleir - Example[deasaich]

  • {{Hatnote|Example Hatnote text}}

Mearachdan - Errors[deasaich]

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:

  1. No parameters were specified (the template code was {{Hatnote}}). Please use {{Hatnote|text}} instead.
  2. 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.
  3. 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}}.
  4. You tried to access Mòideal: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.

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 Roinn-seòrsa:Hatnote templates with errors.

Mion-fhiosrachadh teicnigeach - Technical details[deasaich]

The HTML code produced by this template looks like this:

  • <div role="note" class="Hatnote">Hatnote text</div>

The code is produced by Mòideal:Hatnote.

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

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.

Paramadairean na teamplaide[Stiùirich an TemplateData]

ParamadairTuairisgeulSeòrsaStaid
Text1

This field should contain the text that will be displayed in the Hatnote.

Sreangriatanach
Extra classesextraclasses

Extra CSS classes to be added to the <div> tags surrounding the Hatnote text.

Loidhneroghainneil
Self referenceselfref

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 {{enUici|WP:SAND|WP:SAND}}".)

Loidhneroghainneil
Roinn-seòrsacategory

Set to "no", "n", "false", or "0" to suppresses the error tracking category (Roinn-seòrsa:Hatnote templates with errors). This only has an effect if the Hatnote text is omitted.

Chan eil fhiosroghainneil