Template:Hatnote/doc/Hatnote Templates Documentation View history

Hatnote templates documentation Incomplete templates
VisualWikitext
No edit summary
m (updated category)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Documentation subpage}}<!-- Note this is a documentation page to cover all hatnote templates.  
{{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==
==Hatnote templates==
<div style="float:right; padding: 0 1em;">{{navbar|Hatnote templates documentation|text=Overview of hatnote templates:}}</div>
<div style="float:right; padding: 0 1em;">{{navbar|Hatnote templates documentation|text=Overview of hatnote templates:}}</div>
Line 18: Line 18:
* {{tlx|Details|PAGE1|TOPIC}} → {{Details|PAGE1|TOPIC}}
* {{tlx|Details|PAGE1|TOPIC}} → {{Details|PAGE1|TOPIC}}


===="''See also …''"====
* {{tlx|See also|TOPIC PAGE|OTHER TOPIC PAGE}} → {{See also|TOPIC PAGE|OTHER TOPIC PAGE}}
:Note: use ''only'' when OTHER TOPIC PAGE is ''related'' to current article and contains a self-explanatory parenthetical.
* {{tlx|See also2|<nowiki>[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text</nowiki>}} → {{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}}


===Other uses of the same title===
===Other uses of the same title===
Line 36: Line 30:
* {{tlx|About|USE1|USE2|PAGE2}} (When there is only one other use) → {{About|USE1|USE2|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|and|PAGE3}} (Two pages for USE2) → {{About|USE1|USE2|PAGE2|and|PAGE3}}
* {{tlx|About|USE1|USE2|PAGE2#SUBSECTION{{tlf|!}}PAGE2TITLE}} (Using the {{tl|!}} template to give the link a different title) &rarr; {{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}}
* {{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|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}} (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}}  
Line 43: Line 37:
* {{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>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}}
* {{tlx|About|<nowiki>||</nowiki>PAGE1|and|PAGE2}} → {{About|||PAGE1|and|PAGE2|_nocat=1}}
* {{tlx|Other uses-section|USE}} (disambiguous) → {{Other uses-section|USE}}
:Note: this hatnote says "section", instead of "article" or "page".
===="''For other uses, see …''"====
When such a wordy hatnote as {{tl|About}} is not needed, {{tl|Other uses}} is often useful.
* {{tlx|Other uses}} (disambiguous) → {{Other uses}}
* {{tlx|Other uses|PAGE1}} → {{Other uses|PAGE1}}
* {{tlx|Other uses|PAGE1|PAGE2}} → {{Other uses|PAGE1|PAGE2}}
;Variations
There are, historically, a whole family of "other uses" templates for specific cases. {{tl|About}} is the standard hatnote for "other uses" and many of them can be specified using the {{tl|About}} template. However, the individual templates may be easier to use in certain contexts.
===Family names===
{{see|:Category:Hatnote templates for names}}
===Lists===
{{see|:Category:Hatnote templates for lists}}
===User pages===
* {{tlx|This user talk|TOPIC|PAGE1}} →<br/>
{{This user talk|TOPIC|PAGE1}}


==Notes==
==Notes==
Line 83: Line 53:


<noinclude>
<noinclude>
{{Documentation}} <!-- so this is for the /doc page of this documentation-template -->


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

Latest revision as of 17:45, 21 May 2017

 Note this is a documentation page to cover all hatnote templates. For documentation on the {{Hatnote}} template, please see the documentation page.

Hatnote templates

Overview of hatnote templates: view · talk · edit

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

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

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

"For more details on …, see …"

{{Details}} can indicate more details in nonsummary sections:

For more details on this topic, see PAGE1.
For more details on TOPIC, see PAGE1.


Other uses of the same title

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

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 {{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

Retrieved from "https://www.waze.com/wiki/USA/index.php?title=Template:Hatnote/doc/Hatnote_Templates_Documentation&oldid=154953"