Module:Hatnote templates documentation

From blackwiki
Revision as of 00:08, 18 March 2011 by 178.16.0.224 (talk)
Jump to navigation Jump to search

Hatnote templates

For a summary page on how to use these templates, see the example page here. For the full editing guideline on hatnotes, see Wikipedia:Hatnote.

Generic

{{Dablink|For other senses of this term, see etc...}}

Other uses

"This page is about ... For other uses ..."

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

"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 ..., 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 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:

"Further information: ..."

Example with multiple parameters

This template takes a single parameter of any length.

"See also ..."

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

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

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 persons}}, 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 ..."

"... is a common misspelling of ...

"Main article: ..." and more

Wikipedia self-reference

Note: used for hatnotes that don't make sense on mirrors of Wikipedia, such as linking an article from the main namespace to the Wikipedia namespace. (See: Manual of Style (self-references to avoid) for more details).

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.

  1. REDIRECT Template:Preceding category
  • From a page move: This is a redirect from a page that has been moved (renamed). This page was kept as a redirect to avoid breaking links, both internal and external, that may have been made to the old page name.
  1. REDIRECT Template:Succeeding category
  • From a page move: This is a redirect from a page that has been moved (renamed). This page was kept as a redirect to avoid breaking links, both internal and external, that may have been made to the old page name.

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? Before creating a new template, see: 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.

See also

Template:Navbox hatnote templates

Module documentation[view] [edit] [history] [purge]

Initial visibility: currently defaults to autocollapse

To set this template's initial visibility, the |state= parameter may be used:

  • |state=collapsed: {{Hatnote templates documentation|state=collapsed}} to show the template collapsed, i.e., hidden apart from its title bar
  • |state=expanded: {{Hatnote templates documentation|state=expanded}} to show the template expanded, i.e., fully visible
  • |state=autocollapse: {{Hatnote templates documentation|state=autocollapse}}
    • shows the template collapsed to the title bar if there is a {{navbar}}, a {{sidebar}}, or some other table on the page with the collapsible attribute
    • shows the template in its expanded state if there are no other collapsible items on the page

If the |state= parameter in the template on this page is not set, the template's initial visibility is taken from the |default= parameter in the Collapsible option template. For the template on this page, that currently evaluates to autocollapse.

TemplateData for VisualEditor

No description.

Template parameters

ParameterDescriptionTypeStatus
Statestate

no description

Unknownoptional

See also