Template:Hatnote

From LIMSWiki
Revision as of 17:59, 1 August 2011 by LIMSinstitute (talk | contribs) (1 revision)
Jump to navigationJump to search
{{{1}}}
[edit] [purge] Template documentation

Usage

Using {{Hatnote|text}} formats text into the standard stylistic for a LIMSwiki hatnote, a short note placed at the top of an article to provide disambiguation of closely related terms or summarize a topic, explaining its boundaries. That produces a short note placed at the top of an article to provide disambiguation of closely related terms or summarize 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.

The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal LIMSwiki markup.

Code

<div class="dablink"></div>

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Hatnote

Template for creating a standard LIMSwiki hatnote. A hatnote is a short note placed at the top of an article to provide disambiguation of closely related terms or summarize a topic, explaining its boundaries.

Template parameters

ParameterDescriptionTypeStatus
Text1

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

Stringrequired

Redirects

Generic

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

Other uses (of the title)

"This page is about … For other uses …"

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

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

  • {{About|USE1}}
  • {{About|USE1||PAGE2}} (When the disambiguation page has a different name — Note the empty second parameter) →
  • {{About|USE1|USE2|PAGE2}} (When there is only one other use) →
  • {{About|USE1|USE2|PAGE2|and|PAGE3}} (Two pages for USE2) →
  • {{About|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}} (When there are up to five 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) →
  • {{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}}
  • {{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}}
Note: {{for||PAGE1|PAGE2}} produces the same result.
Note: this hatnote says "section", instead of "article" or "page".

"See also …"

Note: use when OTHER TOPIC is related to that of the current article and already contains a self-explanatory parenthetical.

"For …, see …"

{{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 are a whole family of "for" templates.

  • {{For2|OTHER TOPIC|CUSTOM TEXT}}

"For other uses, see …"

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 …"

"For more details on …, see …"

{{Details}} is used to make summary style explicit. To be used in a section for which there is also a separate article on the subject.

{{Details3}} allows any text to links:

"… redirects here. For other uses, see …"

  • {{Redirect|REDIRECT}} (disambiguous) →
  • {{Redirect|REDIRECT||PAGE1}}
  • {{Redirect|REDIRECT|USE1|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}}
Variations
  • {{Redirect-acronym|TERM|PAGE}}
  • {{Redirect2|REDIRECT1|REDIRECT2}} (disambiguous) →
  • {{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}
  • {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}
  • {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
  • {{Redirect3|REDIRECT|TEXT}}
  • {{Redirect4|REDIRECT1|REDIRECT2}} (disambiguous) →
  • {{Redirect6|REDIRECT|USE1|PAGE1}} (disambiguous) →
  • {{Redirect6|REDIRECT|USE1|PAGE1|‌|PAGE2}}
  • {{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}
Note: If the number of pages redirecting to the target page is two, {{Redirect2}} can be used instead. If the number is three and there are three corresponding disambiguation pages, {{Redirect10}} can be used.
... Not to be confused with ...

"Further information: …"

Other people, places, etcetera

Other people

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

Other hurricanes

For articles on storms:

Other ships

For articles on ships:

Distinguish

"Not to be confused with …"

"… redirects here. It is not to be confused with …"

"Main article: …" etcetera

LIMSwiki self-reference

Categories

Category-specific templates produce bold category names.

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.

Family names

Lists

User pages

Notes

Do not use subst: with these templates, as that will prevent:

  1. propagating changes as the template is modified; and the
  2. What links here (WLH) listing.

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 {{dablink}} instead?
  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?

See also