Template:Main/doc
This is a documentation subpage for Template:Main. It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
This template is used on 140,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in the template's /sandbox or /testcases subpages, or in your own user space. The tested changes can then be added in one single edit to the template. Please consider discussing any changes on the talk page before implementing them. |
When a Wikipedia article is large, it is often rewritten in summary style. This template is used after the heading of the summary, to link to the sub-article that has been (or will be) summarised. This template can also be used in the Category namespace, but the preferred template for categories is {{Cat main}}.
This template is not to be used as a substitute for inline links or as a "see also". Its usage should be restricted to the purpose described hereinbefore.
Usage
{{Main |Article 1 }}
You may also include additional links, up to ten in total:
{{Main |Article 1 |Article 2 |Article 3 |Article 4 |Article 5 |Article 6 |Article 7 |Article 8 |Article 9 |Article 10 }}
For each link, you may optionally specify a link appearance (this is for articles where a piped link would be used). Note that the extra parameters use a lower case 'L', eg. l1 not 11:
{{Main |Article 1 |Article 2 |Article 3 |Article 4 |Article 5 |Article 6 |Article 7 |Article 8 |Article 9 |Article 10 |l1=Article 1 link appearance |l2=Article 2 link appearance |l3=Article 3 link appearance |l4=Article 4 link appearance |l5=Article 5 link appearance |l6=Article 6 link appearance |l7=Article 7 link appearance |l8=Article 8 link appearance |l9=Article 9 link appearance |l10=Article 10 link appearance }}
Examples
Code | Result |
---|---|
{{Main|Article}} |
Main article: Article
|
{{Main|Article 1|Article 2|Article 3}} |
|
{{Main|Article 1|Article 2|Article 3|Article 4|Article 5}} |
|
{{Main|Article|l1=Alternative title}} |
Main article: Alternative title
|
{{Main|(15760) 1992 QB1|l1={{mp|(15760) 1992 QB|1}}}} |
Main article: (15760) 1992 QB1
|
{{main other}}
, to create main space only (article space only) content
This is a documentation subpage for Template:Main. It contains usage information, categories, interlanguage links and other content that is not part of the original template 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
{{Rellink|CUSTOM TEXT}}
→CUSTOM TEXT
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:
{{Main|Main Article}}
→Main article: Main Article{{Main|Main Article|Article2}}
→Main articles: Main Article and Article2{{Main list|Article1}}
→For a more comprehensive list, see Article1.
"For more details on …, see …"
{{Details}}
can supplement {{Main}}
in summary sections, or can indicate more details in nonsummary sections:
{{Details3}}
allows any text to links:
{{Details3|[[article 1]], [[article 2]], and [[article 3]]|TOPIC}}
→
"See also …"
{{See also|TOPIC PAGE|OTHER TOPIC PAGE}}
→See also: TOPIC PAGE and OTHER TOPIC PAGE
- Note: use only when OTHER TOPIC PAGE is related to current article and contains a self-explanatory parenthetical.
{{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}}
→
"Further information: …"
{{Further|PAGE}}
→Further information: PAGE{{Further|PAGE1|PAGE2|PAGE3}}
→{{Further2|[[PAGE1]], [[PAGE12], and [[PAGE#3|PAGE3]]}}
→
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 Main/doc (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 Main/doc (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 Main/doc (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) →{{About|||PAGE1|and|PAGE2}}
→
- Note:
{{for||PAGE1|PAGE2}}
produces the same result.
{{Other uses-section|USE}}
(disambiguous) →This section is about USE. For other uses, see Main/doc (disambiguation).
- Note: this hatnote says "section", instead of "article" or "page".
"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.
{{For|OTHER TOPIC}}
(disambiguous) →For OTHER TOPIC, see Main/doc (disambiguation).{{For|OTHER TOPIC|PAGE1}}
→For OTHER TOPIC, see PAGE1.{{For|OTHER TOPIC|PAGE1|PAGE2}}
→{{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}}
→{{For||PAGE1|PAGE2}}
→
- Variations
As with {{Other uses}}, there are a whole family of "for" templates.
{{For2|OTHER TOPIC|CUSTOM TEXT}}
→For OTHER TOPIC, see CUSTOM TEXT.
"For other uses, see …"
When such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.
{{Other uses}}
(disambiguous) →For other uses, see Main/doc (disambiguation).{{Other uses|PAGE1}}
→For other uses, see PAGE1.{{Other uses|PAGE1|PAGE2}}
→
- 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.
{{Other uses2|PAGE1}}
(disambiguous) →For other uses, see PAGE1 (disambiguation).
- Note: adds "(disambiguation)" to whatever is input as the PAGE1.
- Note:
{{Other uses|PAGE1 (disambiguation)}}
produces the same result.
{{Two other uses|USE1|USE2|PAGE2}}
→This page is about USE1. For USE2, see PAGE2. For other uses, see Main/doc (disambiguation).
- Note: same as {{about}}, except it forces a second use to be noted if unspecified by parameters.
{{Two other uses|USE1|USE2|PAGE2|USE3|PAGE3}}
→{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}}
This article is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For other uses, see Main/doc (disambiguation).{{Three other uses||USE2|PAGE2|USE3|PAGE3}}
→{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}
→This article is about USE1. For USE2, see PAGE2. For USE3, see PAGE3. For USE4, see Main/doc (disambiguation).
"For other uses of …, see …"
{{Other uses of}}
(disambiguous) →For other uses of "Main/doc", see Main/doc (disambiguation).{{Other uses of|TOPIC}}
(disambiguous) →For other uses of "TOPIC", see TOPIC (disambiguation).{{Other uses of|TOPIC|PAGE1}}
→For other uses of "TOPIC", see PAGE1.
"… redirects here. For other uses, see …"
{{Redirect|REDIRECT}}
(disambiguous) →
- REDIRECT [[{{{redirect}}}]]
{{Redirect|REDIRECT||PAGE1}}
→
- REDIRECT [[{{{redirect}}}]]
{{Redirect|REDIRECT|USE1|PAGE1}}
→
- REDIRECT [[{{{redirect}}}]]
{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}}
→
- REDIRECT [[{{{redirect}}}]]
{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
→
- REDIRECT [[{{{redirect}}}]]
{{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}
→
- REDIRECT [[{{{redirect}}}]]
{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}
→
- REDIRECT [[{{{redirect}}}]]
{{Redirect6|REDIRECT|USE1|PAGE1}}
(disambiguous) →"REDIRECT" redirects here. For USE1, see PAGE1. For other uses, see REDIRECT (disambiguation).{{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}}
→
- Variations
- For two sources:
{{Redirect2|REDIRECT1|REDIRECT2}}
(disambiguous) →"REDIRECT1" and "REDIRECT2" redirect here. For other uses, see REDIRECT1 (disambiguation).{{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}
→"REDIRECT1" and "REDIRECT2" redirect here. For USE, see PAGE1.{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}
→{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
→{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}
→{{Redirect3|REDIRECT|TEXT}}
→"REDIRECT" redirects here. TEXT.{{Redirect4|REDIRECT1|REDIRECT2}}
(disambiguous) →"REDIRECT1" and "REDIRECT2" redirect here. For other uses, see REDIRECT1 (disambiguation) and REDIRECT2 (disambiguation).
- For three sources:
{{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}
→{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}
(disambiguous) →"REDIRECT1", "REDIRECT2", and "REDIRECT3" redirect here. For other uses, see REDIRECT1 (disambiguation), REDIRECT2 (disambiguation), and REDIRECT3 (disambiguation).
{{Redirect-synonym|TERM|OTHER TOPIC}}
→"TERM" redirects here. TERM may also refer to OTHER TOPIC.{{Redirect text|REDIRECT|TEXT}}
→"REDIRECT" redirects here. TEXT.
- ... Not to be confused with ...
{{Redirect-distinguish|REDIRECT|PAGE1}}
→"REDIRECT" redirects here. It is not to be confused with PAGE1.{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}
→{{Redirect-distinguish2|REDIRECT|TEXT}}
→"REDIRECT" redirects here. It is not to be confused with TEXT.
"… If you are seeking another topic, … consider adding it to …."
{{Consider disambiguation|USE1|USE2|PAGE2}}
(disambiguous) →This article is about USE1. For USE2, see PAGE2. If you are seeking another topic, additional searches are listed at Main/doc (disambiguation).{{Consider disambiguation|USE1|USE2|PAGE2|PAGE3}}
→
- Note:USE1 can be omitted, resulting in language like {{For}} above.
Similar proper names ("For other people named ...")
Other people
{{Other people}}
(disambiguous) →For other people named Main/doc, see Main/doc (disambiguation).{{Other people|NAME}}
(disambiguous) →For other people named NAME, see NAME (disambiguation).{{Other people|NAME|PAGE}}
→For other people named NAME, see PAGE.{{Other people|NAME|PAGE|named=titled}}
→For other people titled NAME, see PAGE.{{Other people2|PAGE}}
→For other people of the same name, see PAGE.{{Other people3}}
(disambiguous) →For other people named Main/doc, see Main/doc (disambiguation).
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
{{Other people3|PERSON1}}
(disambiguous) →This article is about PERSON1. For other people named Main/doc, see Main/doc (disambiguation).{{Other people3|PERSON1|PERSON2}}
(disambiguous) →This article is about PERSON1. For PERSON2, see Main/doc (disambiguation).{{Other people3|PERSON1|PERSON2|PAGE2}}
→This article is about PERSON1. For PERSON2, see PAGE2.{{Other people3|PERSON1||PAGE2}}
→This article is about PERSON1. For other people named Main/doc, see PAGE2.{{Other people5|NAME1|NAME2|NAME3|NAME4}}
→
- Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.
Other places
{{Other places}}
, analogous to {{Other uses}} (disambiguous) →For other places with the same name, see Main/doc (disambiguation).{{Other places|PAGE}}
, analogous to {{Other uses2}}(disambiguous) →For other places with the same name, see PAGE (disambiguation).{{Other places3|PAGE}}
, analogous to {{Other uses}} →For other places with the same name, see PAGE.
Other hurricanes
{{Other hurricanes}}
(disambiguous) →For other storms of the same name, see Main/doc (disambiguation).{{Other hurricanes|PAGE1}}
→For other storms of the same name, see PAGE1.{{Other hurricanes|PAGE1|THIS}}
→This page is about THIS. For other storms of the same name, see PAGE1.{{Other hurricanes||THIS}}
→This page is about THIS. For other storms of the same name, see Main/doc (disambiguation).
Other ships
For articles on ships:
{{Other ships|SHIP1}}
→For other ships of the same name, see SHIP1.
Distinguish
"Not to be confused with …"
{{Distinguish|PAGE1}}
→Not to be confused with PAGE1.{{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}
→{{Distinguish2|TEXT}}
→Not to be confused with TEXT.
"… redirects here. It is not to be confused with …"
{{Redirect-distinguish|REDIRECT|PAGE1}}
→"REDIRECT" redirects here. It is not to be confused with PAGE1.{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}
→{{Redirect-distinguish2|REDIRECT|TEXT}}
→"REDIRECT" redirects here. It is not to be confused with TEXT.
Wikipedia self-reference
{{Selfref|ANYTEXT}}
→ANYTEXT
Categories
Category-specific templates:
{{Category see also|THIS|THAT|THE OTHER}}
→
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.
{{Cat main|MAIN ARTICLE}}
→The main article for this category is MAIN ARTICLE.{{Category explanation|colourless green ideas}}
→This category is for colourless green ideas.{{Category pair|TOPIC1|TOPIC2}}
→See also the preceding Category:TOPIC1 and the succeeding Category:TOPIC2.{{CatPreceding|OTHER TOPIC}}
→See also the preceding Category:OTHER TOPIC.{{CatSucceeding|OTHER TOPIC}}
→See also the succeeding Category:OTHER TOPIC.{{Contrast|OTHERCAT|OTHERCAT2}}
→{{Contrast|OTHERCAT|OTHERCAT2|plural=yes}}
→
Family names
Lists
User pages
{{This user talk|TOPIC|PAGE1}}
→
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.
See also
|