Fyrimynd:Hatnote/doc
 |
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. |
 | Uses Lua: |
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:
- 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 explictly 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.
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
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|Høvuðsgrein}}→
- Høvuðsgrein: Main Article
{{Høvuðsgrein|Høvuðsgrein|Article2}}→
- 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:
{{Details3|[[NTSC#Color_encoding|NTSC Color encoding]]}}→For more details on this topic, see NTSC Color encoding.{{Details3|[[article1|Article 1]], [[article2|Article 2]], and [[article3|Article 3]]|TOPIC}}→
"See also …"
[rætta wikitekst]{{See also|TOPIC PAGE|OTHER TOPIC PAGE}}→See also: TOPIC PAGE og OTHER TOPIC PAGE
- Note: use only when OTHER TOPIC PAGE is related to current article and contains a self-explanatory parenthetical.
{{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}}→
"Further information: …"
[rætta wikitekst]{{Further|PAGE}}→Further information: PAGE{{Further|PAGE1|PAGE2|PAGE3}}→{{Further2|[[PAGE1]], [[PAGE2]], and [[PAGE#3|PAGE3]]}}→
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) →{{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) →{{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) →{{About|||PAGE1|and|PAGE2}}→Fyri aðra nýtslu, sí PAGE1.
- Note:
{{for||PAGE1|PAGE2}}produces the same result.
{{About|USE1|section=yes}}→Henda section er um USE1. Fyri aðra nýtslu, sí Hatnote/doc (fleiri týdningar).
- 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.
{{About-distinguish|USE1|PAGE1}}→Henda síða er um USE1. Tað er ikki tað sama sum PAGE1.{{About-distinguish2|USE1|TEXT}}→Henda síða er um USE1. Tað er ikki tað sama sum TEXT.{{About-distinguish-custom|USE1|TEXT}}→Henda síða er um USE1. TEXT.
"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.
{{For|OTHER TOPIC}}→Fyri OTHER TOPIC, sí Hatnote/doc (Fleiri týdningar).{{For|OTHER TOPIC|PAGE1}}→Fyri OTHER TOPIC, sí PAGE1.{{For|OTHER TOPIC|PAGE1|PAGE2}}→{{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}}→{{For||PAGE1|PAGE2}}→
- 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.
{{Other uses}}→Fyri aðra nýtslu, sí Hatnote/doc (disambiguation).{{Other uses|PAGE1}}→Fyri aðra nýtslu, sí PAGE1.{{Other uses|PAGE1|PAGE2}}→Fyri aðra nýtslu, sí PAGE1.
- 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.
{{Other uses2|PAGE1}}→Fyri aðra nýtslu, sí PAGE1 (fleiri týdningar).
- Note: adds "(disambiguation)" to whatever is input as the PAGE1.
- Note:
{{Other uses|PAGE1 (disambiguation)}}produces the same result.
{{Two other uses|USE1|USE2|PAGE2}}→Henda síða er um USE1. Fyri USE2, sí PAGE2. For other uses, see Hatnote/doc (disambiguation).
- Note: same as {{about}}, except it forces a second use to be noted if unspecified by parameters.
{{Two other uses|USE1|USE2|PAGE2|USE3|PAGE3}}→{{Two other uses||USE2|PAGE2|USE3|PAGE3}}→{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}}Henda síða er um USE1. Fyri USE2, sí PAGE2. For USE3, see PAGE3. Fyri other uses, sí Hatnote/doc (fleiri týdningar).{{Three other uses||USE2|PAGE2|USE3|PAGE3}}→{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}→
"For other uses of …, see …"
[rætta wikitekst]{{Other uses of}}→For other uses of "Hatnote/doc", see Hatnote/doc (disambiguation).{{Other uses of|TOPIC}}→For other uses of "TOPIC", see TOPIC (disambiguation).{{Other uses of|TOPIC|PAGE1}}→For other uses of "TOPIC", see PAGE1.
"… 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|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}→{{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}→{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|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}}→
- 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}}→{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}→{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3|USE4|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:
{{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}→{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}→"REDIRECT1", "REDIRECT2", og "REDIRECT3" víðaristilla higar. Fyri aðra nýtslu, sí REDIRECT1 (fleiri týdningar), REDIRECT2 (fleiri týdningar), and REDIRECT3 (fleiri týdningar).{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3|USE|TEXT}}→"REDIRECT1", "REDIRECT2", og "REDIRECT3" víðaristilla higar. Fyri USE, sí TEXT.
- 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 ...
{{Redirect-distinguish|REDIRECT|PAGE1}}→"REDIRECT" víðaristillar higar. Má ikki mistakst fyri PAGE1.{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}→{{Redirect-distinguish2|REDIRECT|TEXT}}→"REDIRECT" víðaristillar higar. Má ikki mistakast fyri TEXT.
Similar proper names ("For other people named ...")
[rætta wikitekst]Other people
[rætta wikitekst]{{Other people}}→Fyri onnur fólk nevnd Hatnote/doc, sí Hatnote/doc (fleiri týdningar).{{Other people|NAME}}→Fyri onnur fólk nevnd NAME, sí NAME (fleiri týdningar).{{Other people|NAME|PAGE}}→Fyri onnur fólk named NAME, sí PAGE.{{Other people|NAME|PAGE|named=titled}}→Fyri onnur fólk titled NAME, sí PAGE.{{Other people2|PAGE}}→Fyri at lesa um onnur fólk við sama navni, sí PAGE.{{Other people3}}→Fyri at lesa um onnur fólk nevnd Hatnote/doc, sí Hatnote/doc (fleiri týdningar).
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
{{Other people3|PERSON1}}→This article is about PERSON1. Fyri at lesa um onnur fólk nevnd Hatnote/doc, sí Hatnote/doc (fleiri týdningar).{{Other people3|PERSON1|PERSON2}}→This article is about PERSON1. Fyri at lesa um PERSON2, sí Hatnote/doc (fleiri týdningar).{{Other people3|PERSON1|PERSON2|PAGE2}}→This article is about PERSON1. Fyri at lesa um PERSON2, sí PAGE2.{{Other people3|PERSON1||PAGE2}}→This article is about PERSON1. Fyri at lesa um onnur fólk nevnd Hatnote/doc, sí PAGE2.{{Other people5|NAME1|NAME2|NAME3|NAME4}}→ Fyrimynd:Other people5
- Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.
Other places
[rætta wikitekst]{{Other places}}, analogous to {{Other uses}} →Fyri onnur støð við sama navni, sí Hatnote/doc (fleiri týdningar).{{Other places|PAGE}}, analogous to {{Other uses2}} →Fyri onnur støð við sama navni, sí PAGE (fleiri týdningar).{{Other places3|PAGE}}, analogous to {{Other uses}} →Fyri at lesa um onnur støð við sama navni, sí PAGE.
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]{{Distinguish|PAGE1}}→Er ikki tað sama sum PAGE1.{{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}→{{Distinguish2|TEXT}}→Má ikki mistakst fyri TEXT.
"… redirects here. It is not to be confused with …"
[rætta wikitekst]{{Redirect-distinguish|REDIRECT|PAGE1}}→"REDIRECT" víðaristillar higar. Má ikki mistakst fyri PAGE1.{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}→{{Redirect-distinguish2|REDIRECT|TEXT}}→"REDIRECT" víðaristillar higar. Má ikki mistakast fyri TEXT.- Also may be used as
{{Redirect-distinguish2|REDIRECT}}→"REDIRECT" víðaristillar higar.
- Also may be used as
"For technical reasons, … redirects here. For … , see … ."
[rætta wikitekst]{{Technical reasons|REDIRECT}}→Av tøkniligum ávum, "REDIRECT" víðaristillar higar.{{Technical reasons|REDIRECT|PAGE}}→Av tøkniligum ávum, "REDIRECT" víðaristillar higar. Fyri REDIRECT, sí PAGE.{{Technical reasons|REDIRECT|DESCRIPTION|PAGE}}→Av tøkniligum ávum, "REDIRECT" víðaristillar higar. Fyri DESCRIPTION, sí PAGE.{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2}}→Av tøkniligum ávum, "REDIRECT" víðaristillar higar. Fyri DESCRIPTION1, sí PAGE1. Fyri DESCRIPTION2, sí PAGE2.{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2|DESCRIPTION3|PAGE3}}→Av tøkniligum ávum, "REDIRECT" víðaristillar higar. Fyri DESCRIPTION1, sí PAGE1. Fyri DESCRIPTION2, sí PAGE2. Fyri DESCRIPTION3, sí PAGE3.
Family names
[rætta wikitekst]Further information: Category:Hatnote templates for names
Miscellaneous (hurricanes, Pope Stephen, Wiki selfref)
[rætta wikitekst]These hatnotes are topic-specific. They are documented at their template page.
{{Key people}}{{Other hurricanes}}{{Pope Stephen ToP Dab}}{{Selfref}}
Categories
[rætta wikitekst]Category-specific templates:
{{Category see also|THIS|THAT|THE OTHER}}→ Fyrimynd:Category see also
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.
{{Cat main|MAIN ARTICLE}}→The main article for this category is MAIN ARTICLE.{{Category explanation|colourless green ideas}}→ Fyrimynd:Category explanation{{Category pair|TOPIC1|TOPIC2}}→ Fyrimynd:Category pair{{CatPreceding|OTHER TOPIC}}→Sí eisini undanfarna Category:OTHER TOPIC.{{CatSucceeding|OTHER TOPIC}}→ Fyrimynd:CatSucceeding{{Contrast|OTHERCAT|OTHERCAT2}}→{{Contrast|OTHERCAT|OTHERCAT2|plural=yes}}→
Lists
[rætta wikitekst]Further information: Category:Hatnote templates for lists
User pages
[rætta wikitekst]{{This user talk|TOPIC|PAGE1}}→
Hetta er ein Wikipedia brúkarakjaksíða. Fyri aðra nýtslu av TOPIC, sí PAGE1.
Notes
[rætta wikitekst]
 |
Henda fyrimynd eigur ikki at verða útskift. Do not use subst: with these templates, as that will prevent:
|
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:
- 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.
- 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.
- 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.
Hatnote templates | |
|---|---|
| Generic | |
| Other uses |
|
| For (other topic) | |
| Further information | |
| See also |
|
| Other people |
|
| Other places |
|
| Other topics |
|
| Other uses of (topic) |
|
| Redirect |
|
| "Not to be confused with..." |
|
| Hatnote categories | |
| TemplateData | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Hetta er TemplateData dokumentatiónin fyri hesa fyrimynd, ið verður brúkt av VisualEditor og øðrum tólum.
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.
| |||||||||||||||||||||||||