< Template:Hatnote | doc
m (PesachZ moved page Template:Hatnote Templates Documentation to Template:Hatnote/doc/Hatnote Templates Documentation without leaving a redirect: orphaned doc page, moving to relevant parent) |
m (add notice for hatnote/doc) |
||
Line 1: | Line 1: | ||
{{Documentation subpage}}< | {{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> |
Revision as of 20:08, 23 August 2016
Note this is a documentation page to cover all hatnote templates. For documentation on the {{Hatnote}} template, please see the documentation page. |
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
{{Hatnote|CUSTOM TEXT}}
→CUSTOM TEXT
More pages on the same topic ("Further information ...")
"For more details on …, see …"
{{Details}}
can indicate more details in nonsummary sections:
{{Details|PAGE1}}
→
- For more details on this topic, see PAGE1.
{{Details|PAGE1|TOPIC}}
→
- 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".
{{About|USE1}}
→This page is about USE1. For other uses, see Hatnote/doc/Hatnote Templates Documentation (disambiguation).{{About|USE1||PAGE2}}
(When the disambiguation page has a different name – Note the empty second parameter) →This page is about USE1. For other uses, see PAGE2.{{About|USE1|USE2|PAGE2}}
(When there is only one other use) →This page is about USE1. For USE2, see PAGE2.{{About|USE1|USE2|PAGE2|and|PAGE3}}
(Two pages for USE2) →{{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}}
(Using the {{!}} template to give the link a different title) →This page is about USE1. For USE2, see PAGE2TITLE.{{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) →{{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) →This page is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote/doc/Hatnote Templates Documentation (disambiguation).{{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|and}}
→This page is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see PAGE4 and Hatnote/doc/Hatnote Templates Documentation (disambiguation).{{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) →For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Hatnote/doc/Hatnote Templates Documentation (disambiguation).{{About|||PAGE1|and|PAGE2}}
→
Notes
Do not use subst: with these templates, as that will prevent:
- propagating changes as the template is modified; and the
- 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 {{Hatnote}} instead? Before creating a new template, see the 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 Template sandbox and test cases.