Difference between revisions of "Template:Hatnote templates documentation"

From blackwiki
Jump to navigation Jump to search
test>Unused0029
(lower caps (less garish) for 'do not edit unless you know what you're doing)
test>Unused0029
(major changes - topics around {{about}} - add some explanations, move some sections; in ===For===, delete "unnecessary" examples; delete example&usage section as I think they add nothing/arent helpful)
Line 23: Line 23:
  
 
=== Otheruses ===
 
=== Otheruses ===
''Note: All of these templates are special cases of {{[[Template:Otheruses4|Otheruses4]]}}''
+
{{tl|About}} is the main template for giving other uses; it redirects to {{tl|otheruses4}}.
* <code>{{[[Template:Otheruses|otheruses]]}}</code> (disambiguous): {{otheruses}}
+
 
* <code>{{[[Template:Otheruses1|otheruses1]]|USE}}</code> (disambiguous): {{otheruses1|USE}}
 
* <code>{{[[Template:This|This]]|USE|PAGE}}</code>: {{this|USE|PAGE}}
 
* <code>{{[[Template:Otheruses2|otheruses2]]|PAGE}}</code> (disambiguous): {{otheruses2|PAGE}}
 
* <code>{{[[Template:Otheruses3|otheruses3]]|PAGE}}</code>: {{otheruses3|PAGE}}
 
 
* <code>{{[[Template:Otheruses4|otheruses4]]|USE1}}</code> (disambiguous): {{otheruses4|USE1}}
 
* <code>{{[[Template:Otheruses4|otheruses4]]|USE1}}</code> (disambiguous): {{otheruses4|USE1}}
 
* <code>{{[[Template:Otheruses4|otheruses4]]|USE1|USE2}}</code>: {{otheruses4|USE1|USE2}}
 
* <code>{{[[Template:Otheruses4|otheruses4]]|USE1|USE2}}</code>: {{otheruses4|USE1|USE2}}
Line 36: Line 32:
 
* <code>{{[[Template:otheruses4|otheruses4]]|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}} </code> (fully specified):
 
* <code>{{[[Template:otheruses4|otheruses4]]|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}} </code> (fully specified):
 
:{{otheruses4|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}  
 
:{{otheruses4|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}  
 +
 +
====Variations====
 +
There are also variations of {{tl|about}}. These serve the same purpose, and are marginally easier to use for each individual purpose, but overall, it is complicated to have so many different templates.
 +
 +
All of these templates are special cases of {{tl|about}}.
 +
 +
* <code>{{[[Template:Otheruses|otheruses]]}}</code> (disambiguous): {{otheruses}}
 +
* <code>{{[[Template:Otheruses1|otheruses1]]|USE}}</code> (disambiguous): {{otheruses1|USE}}
 +
* <code>{{[[Template:This|This]]|USE|PAGE}}</code>: {{this|USE|PAGE}}
 +
* <code>{{[[Template:Otheruses2|otheruses2]]|PAGE}}</code> (disambiguous): {{otheruses2|PAGE}}
 +
* <code>{{[[Template:Otheruses3|otheruses3]]|PAGE}}</code>: {{otheruses3|PAGE}}
 
* <code>{{[[Template:Otheruses5|otheruses5]]}}</code>: {{otheruses5}} (this is for when there are both a singular and plural disambiguation page; only works when the plural is formed simply by adding "s" at the end.)
 
* <code>{{[[Template:Otheruses5|otheruses5]]}}</code>: {{otheruses5}} (this is for when there are both a singular and plural disambiguation page; only works when the plural is formed simply by adding "s" at the end.)
 
* <code>{{[[Template:Otheruses6|otheruses6]]|PAGE1|PAGE2}}</code>: {{otheruses6|PAGE1|PAGE2}} (for when there are two disambiguation pages, such as noun and adjective, or singular and irregular plural; there are only two parameters, at least one is required)
 
* <code>{{[[Template:Otheruses6|otheruses6]]|PAGE1|PAGE2}}</code>: {{otheruses6|PAGE1|PAGE2}} (for when there are two disambiguation pages, such as noun and adjective, or singular and irregular plural; there are only two parameters, at least one is required)
 +
 +
===== For (other topic) =====
 +
Note: {{tl|otheruses4}} ({{tl|about}} is a convenient redirect) can often be used instead of {{tl|for}}; you just have to add an empty first parameter (e.g. <code>{{[[Template:For|For]]|OTHER TOPIC|PAGE}}</code> becomes <code>{{[[Template:About|About]]||OTHER TOPIC|PAGE}}</code>
 +
* <code>{{[[Template:For|For]]}}</code> (disambiguous): {{for}}
 +
* <code>{{[[Template:For|For]]|OTHER TOPIC}}</code> (disambiguous): {{for|OTHER TOPIC}}
 +
* <code>{{[[Template:For|For]]|OTHER TOPIC|PAGE}}</code>: {{for|OTHER TOPIC|PAGE}}
 +
* <code>{{[[Template:For|For]]|OTHER TOPIC|PAGE1|PAGE2}}</code>: {{for|OTHER TOPIC|PAGE1|PAGE2}}
 +
* <code>{{[[Template:For2|For2]]|OTHER TOPIC|<nowiki>LINK TO [[PAGE1]] AND [[PAGE2]]</nowiki>}}</code>: {{for2|OTHER TOPIC|LINK TO [[PAGE1]] AND [[PAGE2]]}}
  
 
==== Other people ====
 
==== Other people ====
Line 61: Line 76:
 
* <code>{{[[Template:Otherhurricaneuses|otherhurricaneuses]]|DISAMBIG|THIS}}</code>: {{Otherhurricaneuses|DISAMBIG|THIS}}
 
* <code>{{[[Template:Otherhurricaneuses|otherhurricaneuses]]|DISAMBIG|THIS}}</code>: {{Otherhurricaneuses|DISAMBIG|THIS}}
 
* <code>{{[[Template:Otherhurricaneuses3|otherhurricaneuses3]]|USE1|USE2|MAIN}}</code>: {{Otherhurricaneuses3|USE1|USE2|MAIN}}
 
* <code>{{[[Template:Otherhurricaneuses3|otherhurricaneuses3]]|USE1|USE2|MAIN}}</code>: {{Otherhurricaneuses3|USE1|USE2|MAIN}}
 
=== For (other topic) ===
 
Note: {{tl|otheruses4}} ({{tl|about}} is a convenient redirect) can often be used instead of {{tl|for}}; you just have to add an empty first parameter (e.g. <code>{{[[Template:For|For]]|OTHER TOPIC|PAGE}}</code> becomes <code>{{[[Template:About|About]]||OTHER TOPIC|PAGE}}</code>
 
* <code>{{[[Template:For|For]]}}</code> (disambiguous): {{for}}
 
* <code>{{[[Template:For|For]]|OTHER TOPIC}}</code> (disambiguous): {{for|OTHER TOPIC}}
 
* <code>{{[[Template:For|For]]|OTHER TOPIC|PAGE}}</code>: {{for|OTHER TOPIC|PAGE}}
 
* <code>{{[[Template:For|For]]|OTHER TOPIC|PAGE1|PAGE2}}</code>: {{for|OTHER TOPIC|PAGE1|PAGE2}}
 
* <code>{{[[Template:For2|For2]]|OTHER TOPIC|<nowiki>LINK TO [[PAGE1]] AND [[PAGE2]]</nowiki>}}</code>: {{for2|OTHER TOPIC|LINK TO [[PAGE1]] AND [[PAGE2]]}}
 
  
 
==== Otherusesof (topic) ====
 
==== Otherusesof (topic) ====
Line 76: Line 83:
  
 
=== Redirect ===
 
=== Redirect ===
 
 
 
* <code>{{[[Template:Redirectstohere|Redirectstohere]]|REDIRECT notice}}</code> (To Document dependent link[s], Template also has a hidden mode, (Set "|hide=true") which enables it to document a section title is a redirect page target section, and so should not be changed.); Some examples: {{1}}{{Redirectstohere|REDIRECT}}, {{1}}{{Redirectstohere|REDIRECT|Another name|A Foreign name}} {{1}}&mdash; with a little care, bolding the titled redirects can substitute for awkward phrases involving multiple name forms of the main article title; particularly those of  the "also known as varieties"...{{1}}{{Redirectstohere|'''Gustavus II Adolf'''|'''Gustav Adolphus II'''|'''Gustavus Vasa II of Sweden'''}}{{2}}
 
* <code>{{[[Template:Redirectstohere|Redirectstohere]]|REDIRECT notice}}</code> (To Document dependent link[s], Template also has a hidden mode, (Set "|hide=true") which enables it to document a section title is a redirect page target section, and so should not be changed.); Some examples: {{1}}{{Redirectstohere|REDIRECT}}, {{1}}{{Redirectstohere|REDIRECT|Another name|A Foreign name}} {{1}}&mdash; with a little care, bolding the titled redirects can substitute for awkward phrases involving multiple name forms of the main article title; particularly those of  the "also known as varieties"...{{1}}{{Redirectstohere|'''Gustavus II Adolf'''|'''Gustav Adolphus II'''|'''Gustavus Vasa II of Sweden'''}}{{2}}
 
* <code>{{[[Template:Redirect|Redirect]]|REDIRECT}}</code> (disambiguous): {{Redirect|REDIRECT}}
 
* <code>{{[[Template:Redirect|Redirect]]|REDIRECT}}</code> (disambiguous): {{Redirect|REDIRECT}}

Revision as of 23:30, 9 April 2008

This is template documentation box for all of the Otheruses templates.

Such templates are not necessarily intended to be viewed directly. If they use variables, some links may appear broken. Do not replace these variables with hardcoded page names or URLs.


Otheruses templates

To discuss these templates as a whole, please see Wikipedia talk:Disambiguation If you wish to discuss general wordings, rather than the wording or formatting of this specific template, don't post here, or else what you say will probably go unnoticed.

For a summary page on how to use these templates, see Wikipedia:Otheruses templates (example usage).

Generic

For example, {{dablink|For other senses of this term, see [[etc...]]}}. This template is adaptable, but fails to standardize hatnotes.
(Similar to Dablink, but used for messages that wouldn't make sense on mirrors of Wikipedia, such as a link in the main article namespace that links to one in the Wikipedia namespace. See Wikipedia:Avoid self-references for more details.)

Otheruses

{{About}} is the main template for giving other uses; it redirects to {{otheruses4}}.

Script error: No such module "about".
  • {{otheruses4|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}} (fully specified):
Template:Otheruses4

Variations

There are also variations of {{about}}. These serve the same purpose, and are marginally easier to use for each individual purpose, but overall, it is complicated to have so many different templates.

All of these templates are special cases of {{about}}.

For (other topic)

Note: {{otheruses4}} ({{about}} is a convenient redirect) can often be used instead of {{for}}; you just have to add an empty first parameter (e.g. {{For|OTHER TOPIC|PAGE}} becomes {{About||OTHER TOPIC|PAGE}}

Other people

Other places

Template:Otherplaces

Template:Otherplaces2

Template:Otherplaces3

Otherhurricaneuses

For articles on storms.

Otherusesof (topic)

Redirect

Template:Redirect6

"Not to be confused with"...

Notes

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

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


Please do not edit these templates unless you know what you are doing

These templates may be used in thousands of articles, and changing the syntax could therefore break thousands of articles. If you wish to edit a disambiguation template first ask yourself:

  1. Is there already another template that will do this job? We have lots of disambiguation templates already, see Category:Disambiguation and redirection templates.
  2. Do I really need a template for this? Will it ever get used on any other articles, or should I just use {{dablink}} instead?
  3. Do I know what will happen if I change the parameters around? Will it break existing uses of the template, and if so, can I fix them all?

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