View source for Template:Hatnote/doc/Hatnote Templates Documentation View history

{{Documentation subpage}}<noinclude>{{mbox|type=notice|text=Note this is a documentation page to cover all hatnote templates. For documentation on the {{tl|Hatnote}} template, please see the [[Template:Hatnote/doc|documentation]] page.}}

==Hatnote templates==
<div style="float:right; padding: 0 1em;">{{navbar|Hatnote templates documentation|text=Overview of hatnote templates:}}</div>
{{clear}}
For a summary page on how to use these templates, see [[Wikipedia:HATTEST|the example page here]]. For the full editing guideline on hatnotes, see [[Wikipedia:Hatnote]].

===Generic===
* {{tlx|Hatnote|CUSTOM TEXT}} → {{Hatnote|CUSTOM TEXT}}
:{{tlx|Hatnote|For other senses of this term, see <nowiki>[[</nowiki>etc…<nowiki>]]</nowiki>}} &rarr; {{Hatnote|For other senses of this term, see [[etc…]]}}

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

===="''For more details on …, see …''"====
{{tlx|Details}} can indicate more details in nonsummary sections:
* {{tlx|Details|PAGE1}} → {{Details|PAGE1}}

* {{tlx|Details|PAGE1|TOPIC}} → {{Details|PAGE1|TOPIC}}


===Other uses of the same title===

===="''This page is about … For other uses …''"====
{{tlx|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".''

* {{tlx|About|USE1}} → {{About|USE1}}
* {{tlx|About|USE1<nowiki>||</nowiki>PAGE2}} (When the disambiguation page has a different name – Note the empty second parameter) → {{About|USE1||PAGE2}}
* {{tlx|About|USE1|USE2|PAGE2}} (When there is only one other use) → {{About|USE1|USE2|PAGE2}}
* {{tlx|About|USE1|USE2|PAGE2|and|PAGE3}} (Two pages for USE2) → {{About|USE1|USE2|PAGE2|and|PAGE3}}
* {{tlx|About|USE1|USE2|PAGE2#SUBSECTION{{tl|!}}PAGE2TITLE}} (Using the {{tl|!}} template to give the link a different title) &rarr; {{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}}
* {{tlx|About|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}} (When there are up to four other uses – You should generally create a [[Wikipedia:Disambiguation|disambiguation page]] at this point) → {{About|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}
* {{tlx|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}} 
* {{tlx|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}}
* {{tlx|About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}} → {{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}} 
* {{tlx|About|<nowiki>|</nowiki>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||USE2|PAGE2|USE3|PAGE3|other uses}}
* {{tlx|About|<nowiki>||</nowiki>PAGE1|and|PAGE2}} → {{About|||PAGE1|and|PAGE2|_nocat=1}}

==Notes==
'''Do not use [[Wikipedia:Substitution|subst:]] with these templates''', as that will prevent: 
# propagating changes as the template is modified; and the
# ''[[Special:Whatlinkshere/{{NAMESPACE}}:{{PAGENAME}}|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:
# 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 {{tl|Hatnote}} instead? Before creating a new template, see the [[Wikipedia:Template namespace|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 [[Wikipedia:Template sandbox and test cases|Template sandbox and test cases]].

==See also==
*[[Wikipedia:Hatnote]]
*{{tl|Shortcut}}

<noinclude>

[[Category:Hatnote templates documentation|Documentation]]
[[Category:Incomplete templates]]
</noinclude>