Template:Main/doc
40px | 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. |
When a Wikipedia article is large, it is often rewritten in summary style. This template is used below 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 above.
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|Template:Mp]]
|
Contents
- {{main other}}, to create Main space only (article space only) content
40px | 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
Other uses (of the 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) → Template:Other uses-section
- Note: this hatnote says "section", instead of "article" or "page".
"See also …"
- {{See also|OTHER TOPIC|OTHER TOPIC2}} → Template:See also
- Note: use when OTHER TOPIC is related to that of the current article and already contains a self-explanatory parenthetical.
- {{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}} → Template:See also2
"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) → Template:For
- {{For|OTHER TOPIC|PAGE1}} → Template:For
- {{For|OTHER TOPIC|PAGE1|PAGE2}} → Template:For
- {{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}} → Template:For
- {{For||PAGE1|PAGE2}} → Template:For
- Variations
As with {{Other uses}}, there are a whole family of "for" templates.
- {{For2|OTHER TOPIC|CUSTOM TEXT}} → Template:For2
"For other uses, see …"
When such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.
- {{Other uses}} (disambiguous) → Template:Other uses
- {{Other uses|PAGE1}} → Template:Other uses
- {{Other uses|PAGE1|PAGE2}} → Template:Other uses
- 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) → Template:Other uses2
- 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}} → Template:Two other uses
- 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}} → Template:Two other uses
- {{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}} Template:Three other uses
- {{Three other uses||USE2|PAGE2|USE3|PAGE3}} → Template:Three other uses
- {{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}} → Template:Three other uses
"For other uses of …, see …"
- {{Other uses of}} (disambiguous) → Template:Other uses of
- {{Other uses of|TOPIC}} (disambiguous) → Template:Other uses of
- {{Other uses of|TOPIC|PAGE1}} → Template:Other uses of
"For more details on …, see …"
{{Details}} is used to make summary style explicit. To be used in a section for which there is also a separate article on the subject.
- {{Details|Article|TOPIC}} → Template:Details
{{Details3}} allows any text to links:
- {{Details3|[[article 1]], [[article 2]], and [[article 3]]|TOPIC}} → Template:Details3
"… redirects here. For other uses, see …"
- {{Redirect|REDIRECT}} (disambiguous) → Template:Redirect
- {{Redirect|REDIRECT||PAGE1}} → Template:Redirect
- {{Redirect|REDIRECT|USE1|PAGE1}} → Template:Redirect
- {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}} → Template:Redirect
- {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} → Template:Redirect
- {{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}} → Template:Redirect
- {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}} → Template:Redirect
- Variations
- {{Redirect-synonym|TERM|OTHER TOPIC}} → Template:Redirect-synonym
- {{Redirect2|REDIRECT1|REDIRECT2}} (disambiguous) → Template:Redirect2
- {{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}} → Template:Redirect2
- {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}} → Template:Redirect2
- {{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}} → Template:Redirect2
- {{Redirect3|REDIRECT|TEXT}} → Template:Redirect3
- {{Redirect4|REDIRECT1|REDIRECT2}} (disambiguous) → Template:Redirect4
- {{Redirect6|REDIRECT|USE1|PAGE1}} (disambiguous) → Template:Redirect6
- {{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}} → Template:Redirect6
- {{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}} → Template:Redirect7
- Note: If the number of pages redirecting to the target page is two, {{Redirect2}} can be used instead. If the number is three and there are three corresponding disambiguation pages, {{Redirect10}} can be used.
- {{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}} (disambiguous) → Template:Redirect10
- ... Not to be confused with ...
- {{Redirect-distinguish|REDIRECT|PAGE1}} → Template:Redirect-distinguish
- {{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}} → Template:Redirect-distinguish
- {{Redirect-distinguish2|REDIRECT|TEXT}} → Template:Redirect-distinguish2
"Further information: …"
- {{See|OTHER TOPIC}} → Template:See
- {{See|Iraq and weapons of mass destruction|Saddam Hussein and al-Qaeda|Downing Street memo|Bush-Blair memo}} → Template:See
- {{Further|[[Article 1]], [[Article 2]], and [[Article Something#3|Article 3]]}} → Template:Further
Other people, places, etcetera
Other people
- {{Other people}} (disambiguous) → Template:Other people
- {{Other people|NAME}} (disambiguous) → Template:Other people
- {{Other people|NAME|PAGE}} → Template:Other people
- {{Other people|NAME|PAGE|namedTemplate:=titled}} → Template:Other people
- {{Other people2|PAGE}} → Template:Other people2
- {{Other people3}} (disambiguous) → Template:Other people3
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
- {{Other people3|PERSON1}} (disambiguous) → Template:Other people3
- {{Other people3|PERSON1|PERSON2}} (disambiguous) → Template:Other people3
- {{Other people3|PERSON1|PERSON2|PAGE2}} → Template:Other people3
- {{Other people3|PERSON1||PAGE2}} → Template:Other people3
- {{Other people5|NAME1|NAME2|NAME3|NAME4}} → Template:Other people5
- 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) → Template:Other places
- {{Other places|PAGE}}, analogous to {{Other uses2}}(disambiguous) → Template:Other places
- {{Other places3|PAGE}}, analogous to {{Other uses}} → Template:Other places3
Other hurricanes
For articles on storms:
- {{Other hurricanes}} (disambiguous) → Template:Other hurricanes
- {{Other hurricanes|PAGE1}} → Template:Other hurricanes
- {{Other hurricanes|PAGE1|THIS}} → Template:Other hurricanes
- {{Other hurricanes||THIS}} → Template:Other hurricanes
Other ships
For articles on ships:
- {{Other ships|SHIP1}} → Template:Other ships
Distinguish
"Not to be confused with …"
- {{Distinguish|PAGE1}} → Template:Distinguish
- {{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}} → Template:Distinguish
- {{Distinguish2|TEXT}} → Template:Distinguish2
"… redirects here. It is not to be confused with …"
- {{Redirect-distinguish|REDIRECT|PAGE1}} → Template:Redirect-distinguish
- {{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}} → Template:Redirect-distinguish
- {{Redirect-distinguish2|REDIRECT|TEXT}} → Template:Redirect-distinguish2
"Main article: …" etc.
- {{Main|Main Article}} → Main article: Main Article
- {{Main|Main Article|Article2}} → Main articles: Main Article and Article2
- {{Main list|Article1}} → Template:Mainlist
- {{ArticlePreceeding|George Washington}} → Template:ArticlePreceeding
- {{ArticleSucceeding|Thomas Jefferson}} → Template:ArticleSucceeding
- {{ArticlePair|George Washington|Thomas Jefferson}} → Template:ArticlePair
Wikipedia self-reference
- {{Selfref|ANYTEXT}} → ANYTEXT
- See: Manual of Style (self-references to avoid) for more details.
Categories
Category-specific templates produce bold category names.
- {{Category see also|THIS|THAT|THE OTHER}} → Template:Category see also
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.
- {{CatPreceding|OTHER TOPIC}} → Template:CatPreceding
- {{CatSucceeding|OTHER TOPIC}} → Template:CatSucceeding
- {{Category pair|TOPIC1|TOPIC2}} → Template:Category pair
- {{Contrast|OTHERCAT|OTHERCAT2}} → Template:Contrast
- {{Contrast|OTHERCAT|OTHERCAT2|pluralTemplate:=yes}} → Template:Contrast
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
Template:Navbox hatnote templates