Difference between revisions of "Module:Hatnote templates documentation"

From blackwiki
Jump to navigation Jump to search
test>SMcCandlish
Line 77: Line 77:
 
{{tl|For}} can be used instead of {{tl|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 {{tl|About}} as in:
 
{{tl|For}} can be used instead of {{tl|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 {{tl|About}} as in:
  
:''For example'': {{tlx|for|OTHER TOPIC|PAGE1}} is the same as {{tlx|About|<nowiki>|</nowiki>OTHER TOPIC|PAGE1}} (note the empty first parameter).<br/>
+
:''For example'': {{tlx|For|OTHER TOPIC|PAGE1}} is the same as {{tlx|About|<nowiki>|</nowiki>OTHER TOPIC|PAGE1}} (note the empty first parameter).<br/>
 
However, it is somewhat clearer when using the {{tl|For}} template, since the word "about" does not appear in the statement.
 
However, it is somewhat clearer when using the {{tl|For}} template, since the word "about" does not appear in the statement.
  

Revision as of 20:21, 26 October 2014

Hatnote templates

Hatnotes must be at the very top of the page or section.

Generic hatnote

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

If a link in a hatnote points to a disambiguation page, the link should include "(disambiguation)", even if that is a redirect. This indicates that the disambiguation link is intentional, and not an error (see WP:INTDABLINK):

Not {{hatnote|other uses|Springfield}}; but
{{hatnote|other uses|Springfield (disambiguation)}}, or
{{hatnote|other uses|Springfield (disambiguation)|Springfield}}
  • The wrapper template {{Hatnotes}} (plural) can be used to reduce the excessive vertical space between multiple hatnotes.

More pages on the same topic ("Further information ...")

"Main article: …"

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

"For more details on …, see …"

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

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

"See also …"

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

"Further information: …"

Other uses of the same title ("For …, see …")

"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#SUBSECTION{{!}}PAGE2TITLE}} (Using the {{!}} magic word to give the link a different title) → Script error: No such module "about".
  • {{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) → 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.
  • {{About|USE1|section=yes}}Script error: No such module "about".
Note: this hatnote says "section", instead of "article" or "page".

"This page is about … It is not to be confused with …"

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

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

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

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

Variations
... Not to be confused with ...

Similar proper names ("For other people named ...")

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 ships

For articles on ships:

Distinguish

"Not to be confused with …"

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

"For technical reasons, … redirects here. For … , see … ."

Family names

Miscellaneous (hurricanes, Pope Stephen, Wiki selfref)

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

Categories

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.

  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.

Lists

User pages

Template:This user talk

Notes

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.

See also


Template: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