Fyrimynd:Hatnote/doc

Frá Wikipedia, hin frælsa alfrøðin
Far til: navigatión, leita
Dokumentation
Hetta er dokumentatiónssíðan fyri Fyrimynd:Hatnote.

Henda síðan er ikki neyðturviliga hugsað at skula vísast beinleiðis. Um hon nýtir variablar, so kunnu nøkur leinki sýnast sum brotin. Tú mást ikki útskifta variablarnir við beinleiðis tittlar ella URL.


Snarvegur:
F:HAT

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

{{hatnote|Example hatnote text.}}
Example hatnote text.

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

Function[rætta wikitekst]

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 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 markup.

Usage[rætta wikitekst]

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

Parameters[rætta wikitekst]

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.

Example[rætta wikitekst]

  • {{hatnote|Example hatnote text}}
    Example hatnote text

Errors[rætta wikitekst]

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 explictly by using 1= before the hatnote text, like this: {{hatnote|1=2+2=4}}.
  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.

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.

Technical details[rætta wikitekst]

The HTML code produced by this template looks like this:

  • <div class="hatnote">hatnote text</div>

The code is produced by Module:Hatnote.


Hatnote fyrimyndir[rætta wikitekst]

Fyri the full guideline on hatnotes, sí Wikipedia:Hatnote.

Hatnotes mugu vera ovast á síðuni ella brotinum.

Generic hatnote[rætta wikitekst]

  • {{Hatnote|CUSTOM TEXT}}
    CUSTOM TEXT
{{Hatnote|For other senses of this term, see [[etc…]]}}
For other senses of this term, see etc…

Aðrar síður um sama evni ("Meira kunning ...")[rætta wikitekst]

"Høvuðsgrein: …"[rætta wikitekst]

{{Høvuðsgrein}} is used to make summary style explicit, when used in a summary section for which there is also a separate article on the subject:

Høvuðsgrein: Main Article
Høvuðsgrein: Main Article

"Fyri at lesa um fleiri smálutir um …, sí …"[rætta wikitekst]

{{Details}} can supplement {{Main}} in summary sections, or can indicate more details in nonsummary sections:

  • {{Details|PAGE1}}
    For more details on this topic, see PAGE1.
  • {{Details|PAGE1|TOPIC}}
    For more details on TOPIC, see PAGE1.

{{Details3}} allows changing the displayed name for links. Unlike {{Details}}, it requires bracketed link notation:

"See also …"[rætta wikitekst]

Note: use only when OTHER TOPIC PAGE is related to current article and contains a self-explanatory parenthetical.

"Further information: …"[rætta wikitekst]

Other uses of the same title ("For …, see …")[rætta wikitekst]

"This page is about … For other uses …"[rætta wikitekst]

{{About}} is the main template for noting other uses.

Note. When used in main namespace, the word "page" in the following hatnotes is replaced by "article".

  • {{About|USE1}}
    Henda síða er um USE1. Fyri aðra nýtslu, sí Hatnote/doc (fleiri týdningar).
  • {{About|USE1||PAGE2}} (When the disambiguation page has a different name – Note the empty second parameter) →
    Henda síða er um USE1. Fyri aðra nýtslu, sí PAGE2.
  • {{About|USE1|USE2|PAGE2}} (When there is only one other use) →
    Henda síða er um USE1. Fyri USE2, sí PAGE2.
  • {{About|USE1|USE2|PAGE2|and|PAGE3}} (Two pages for USE2) →
    Henda síða er um USE1. Fyri USE2, sí PAGE2.
  • {{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}} (Using the {{!}} magic word to give the link a different title) →
    Henda síða er um USE1. Fyri USE2, sí PAGE2TITLE.
  • {{About|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}} (When there are up to four other uses – You should generally create a disambiguation page at this point) →
    Henda síða er um USE1. Fyri USE2, sí PAGE2. For USE3, see PAGE3. Fyri USE4, sí PAGE4. Fyri USE5, sí PAGE5.
  • {{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses}} (When there are several standard other uses and also a disambiguation page with default name – Note that the last page name is not specified) →
    Henda síða er um USE1. Fyri USE2, sí PAGE2. For USE3, see PAGE3. Fyri other uses, sí Hatnote/doc (fleiri týdningar).
  • {{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4}} (When there are several standard other uses and also a disambiguation page with non-default name) →
    Henda síða er um USE1. Fyri USE2, sí PAGE2. For USE3, see PAGE3. Fyri other uses, sí PAGE4.
  • {{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}}
    Henda síða er um USE1. Fyri USE2, sí PAGE2. For USE3, see PAGE3. Fyri other uses, sí PAGE4 and Hatnote/doc (fleiri týdningar).
  • {{About||USE2|PAGE2|USE3|PAGE3|other uses}} (When you don't need to state the focus of this article/page – Note the empty first parameter) →
    Fyri USE2, sí PAGE2. For USE3, see PAGE3. Fyri other uses, sí Hatnote/doc (fleiri týdningar).
  • {{About|||PAGE1|and|PAGE2}}
    Fyri aðra nýtslu, sí PAGE1.
Note: {{for||PAGE1|PAGE2}} produces the same result.
Note: this hatnote says "section", instead of "article" or "page".

"This page is about … It is not to be confused with …"[rætta wikitekst]

{{About-distinguish}} is a template for noting other uses when there could be confusion with another topic.

"For …, see …"[rætta wikitekst]

{{For}} can be used instead of {{About}} so as not to display: This page is about USE1. but still specify a specific other use. This effect can also be achieved by using an empty first parameter in {{About}} as in:

For example: {{For|OTHER TOPIC|PAGE1}} is the same as {{About||OTHER TOPIC|PAGE1}} (note the empty first parameter).

However, it is somewhat clearer when using the {{For}} template, since the word "about" does not appear in the statement.

Variations
As with {{Other uses}}, there is a whole family of "for" templates. {{For2}} allows custom text, such as quotation marks or a link from part of the "CUSTOM TEXT"
  • {{For2|OTHER TOPIC|CUSTOM TEXT}}
    Fyri OTHER TOPIC, sí CUSTOM TEXT.

"For other uses, see …"[rætta wikitekst]

When such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.

Variations
There are, historically, a whole family of "other uses" templates for specific cases. {{About}} is the standard hatnote for "other uses" and many of them can be specified using the {{About}} template. However, the individual templates may be easier to use in certain contexts.
Here are the variations and (when appropriate) the equivalents using the {{About}}, {{Other uses}} or {{For}} templates.
Note: adds "(disambiguation)" to whatever is input as the PAGE1.
Note: {{Other uses|PAGE1 (disambiguation)}} produces the same result.
Note: same as {{about}}, except it forces a second use to be noted if unspecified by parameters.

"For other uses of …, see …"[rætta wikitekst]

"… redirects here. For other uses, see …"[rætta wikitekst]

  • {{Redirect|REDIRECT}}
    "REDIRECT" redirects here. For other uses, see REDIRECT (disambiguation).
  • {{Redirect|REDIRECT||PAGE1}}
    "REDIRECT" redirects here. For other uses, see PAGE1.
  • {{Redirect|REDIRECT|USE1|PAGE1}}
    "REDIRECT" redirects here. For USE1, see PAGE1.
  • {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}}
    "REDIRECT" redirects here. For USE1, see PAGE1. For USE2, see PAGE2.
  • {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
    "REDIRECT" redirects here. For USE1, see PAGE1. For USE2, see PAGE2. For USE3, see PAGE3.
  • {{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}
    "REDIRECT" redirects here. For USE1, see PAGE1 og PAGE2.
  • {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}
    "REDIRECT" redirects here. For USE1, see PAGE1. For USE2, see PAGE2 og PAGE3.
  • {{Redirect6|REDIRECT|USE1|PAGE1}}
    "REDIRECT" redirects here. Fyri USE1, sí PAGE1. Fyri aðra nýtslu, sí REDIRECT (fleiri týdningar).
  • {{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}}
    "REDIRECT" redirects here. Fyri USE1, sí PAGE1. Fyri aðra nýtslu, sí PAGE2.
Variations
  • For two sources:
    • {{Redirect2|REDIRECT1|REDIRECT2}}
      "REDIRECT1" og "REDIRECT2" víðaristilla higar. Fyri aðra nýtslu, sí REDIRECT1 (fleiri týdningar).
    • {{Redirect2|REDIRECT1|REDIRECT2|USE}}
      "REDIRECT1" og "REDIRECT2" víðaristilla higar. Fyri USE, sí REDIRECT1 (fleiri týdningar).
    • {{Redirect2|REDIRECT1|REDIRECT2||PAGE1}}
      "REDIRECT1" og "REDIRECT2" víðaristilla higar. Fyri aðra nýtslu, sí PAGE1.
    • {{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}
      "REDIRECT1" og "REDIRECT2" víðaristilla higar. Fyri USE, sí PAGE1.
    • {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}
      "REDIRECT1" og "REDIRECT2" víðaristilla higar. Fyri USE1, sí PAGE1. For USE2, sí PAGE2.
    • {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
      "REDIRECT1" og "REDIRECT2" víðaristilla higar. Fyri USE1, sí PAGE1. For USE2, sí PAGE2. For USE3, see PAGE3.
    • {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}
      "REDIRECT1" og "REDIRECT2" víðaristilla higar. Fyri USE1, sí PAGE1. For USE2, sí PAGE2. For USE3, see PAGE3. For USE4, sí PAGE4.
    • {{Redirect4|REDIRECT1|REDIRECT2}}
      "REDIRECT1" og "REDIRECT2" víðaristilla higar. Fyri aðra nýtslu, sí REDIRECT1 (fleiri týdningar) og REDIRECT2 (fleiri týdningar).
    • {{Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}}
      "REDIRECT1" og "REDIRECT2" víðaristilla higar. Fyri USE, sí TEXT.
  • For three sources:
  • To specify the text following "redirects here.":
    • {{Redirect3|REDIRECT|TEXT}} or {{Redirect text|REDIRECT|TEXT}}
      "REDIRECT" redirects here. TEXT.
    • {{Redirect-synonym|TERM|OTHER TOPIC}}
      "TERM" verður stýrd higar. TERM kann eisini meinast við OTHER TOPIC.
... Not to be confused with ...

Similar proper names ("For other people named ...")[rætta wikitekst]

Other people[rætta wikitekst]

Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.

Other places[rætta wikitekst]

Other ships[rætta wikitekst]

For articles on ships:

  • {{Other ships|SHIP1}}
    Fyri at lesa meira um onnur skip við sama navni, sí SHIP1.

Distinguish[rætta wikitekst]

"Not to be confused with …"[rætta wikitekst]

"… redirects here. It is not to be confused with …"[rætta wikitekst]

"For technical reasons, … redirects here. For … , see … ."[rætta wikitekst]

Family names[rætta wikitekst]

Miscellaneous (hurricanes, Pope Stephen, Wiki selfref)[rætta wikitekst]

These hatnotes are topic-specific. They are documented at their template page.

Categories[rætta wikitekst]

Category-specific templates:

This is a template for linking categories horizontally. Horizontal linkage is often the right solution when vertical linkage (i.e., as sub-category and parent category) is not appropriate. In most cases, this template should be used on both categories to create reciprocal linkage between the two categories.

Lists[rætta wikitekst]

User pages[rætta wikitekst]

Hetta er ein Wikipedia brúkarakjaksíða. Fyri aðra nýtslu av TOPIC, sí PAGE1.

Notes[rætta wikitekst]

These templates are used in thousands of articles; therefore, changing the syntax could break thousands of articles. If you wish to create or edit a disambiguation or redirection template, first ask yourself the following questions:

  1. Is there already a template that will do this job? Since many disambiguation and redirection templates have already been created, first check: Category:Disambiguation and redirection templates.
  2. Do I really need a new template for this? Will it likely be used on any other articles or should I just use {{Hatnote}} instead? Before creating a new template, see the template namespace guideline.
  3. If I change the parameters around on an existing template, do I know what the result will be? Will it break existing uses of the template and if so, can I fix all of the errors? Before making any changes, see Template sandbox and test cases.