Template:Main/doc

From Wiki
Revision as of 20:07, 6 January 2014 by AlexNik (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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 can also be used in articles leads when an article is not the "main" article for its subject, but this is controversial. When there are multiple articles, distinct enough to warrant separate articles, but not enough to be very separate subjects. One to be the main article describing the topic, and the others avoiding unnecessary duplication of the main article. A good example would be geography articles where two terms have somewhat different meanings or "contexts", but refer to roughly the same geographic area, e.g. Balkans and Southeast Europe. The Balkans article is the main article, the Southeast Europe article doesn't try to be a duplicate of the Balkans article by having much info on History, natural resources, etc, it leaves that to the Balkans article. This can be thought of as a halfway point between having fully separate articles, and having a redirect.

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 purposes described above.

Usage

{{Main|Article 1}}

You may also include additional links, up to ten in total:

{{Main |Article 1 |Article 2 | ... |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', for example, l1, not 11:

{{Main |Article 1 | ... |Article 10 | l1=Article 1 link appearance | ... | l10=Article 10 link appearance }}

Examples

Code Result
{{Main|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|(15760) 1992 QB1|l1={{mp|(15760) 1992 QB|1}}}}
  • {{main other}}, to create main space only (article space only) content

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}}
{{Hatnote|For other senses of this term, see [[etc…]]}}

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:

"For more details on …, see …"

{{Details}} can supplement {{Main}} in summary sections, or can indicate more details in nonsummary sections:

  • {{Details|PAGE1}}
  • {{Details|PAGE1|TOPIC}}

{{Details3}} allows any text to links:

"See also …"

Note: use only when OTHER TOPIC PAGE is related to current article and contains a self-explanatory parenthetical.

"Further information: …"

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}}
  • {{About|USE1||PAGE2}} (When the disambiguation page has a different name – Note the empty second parameter) →
  • {{About|USE1|USE2|PAGE2}} (When there is only one other use) →
  • {{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) →
  • {{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) →
  • {{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}}
  • {{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.
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.

Variations

As with {{Other uses}}, there is a whole family of "for" templates.Script error

  • {{For2|OTHER TOPIC|CUSTOM TEXT}}

"For other uses, see …"

When such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.

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.

Note: adds "(disambiguation)" to whatever is input as the PAGE1.
Note: {{Other uses|PAGE1 (disambiguation)}} produces the same result.
Note: same as {{about}}, except it forces a second use to be noted if unspecified by parameters.

"For other uses of …, see …"

"… redirects here. For other uses, see …"

  • {{Redirect|REDIRECT}} (disambiguous) →
  • {{Redirect|REDIRECT||PAGE1}}
  • {{Redirect|REDIRECT|USE1|PAGE1}}
  • {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}}
  • {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}
  • {{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}
  • {{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}
  • {{Redirect6|REDIRECT|USE1|PAGE1}} (disambiguous) →
  • {{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}}
Variations
  • For two sources:
    • {{Redirect2|REDIRECT1|REDIRECT2}} (disambiguous) →
    • {{Redirect2|REDIRECT1|REDIRECT2|USE}}
    • {{Redirect2|REDIRECT1|REDIRECT2||PAGE1}}
    • {{Redirect2|REDIRECT1|REDIRECT2|USE|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}}
    • {{Redirect4|REDIRECT1|REDIRECT2}} (disambiguous) →
    • {{Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}}
  • For three sources:
  • {{Redirect3|REDIRECT|TEXT}} or {{Redirect text|REDIRECT|TEXT}}
  • {{Redirect-synonym|TERM|OTHER TOPIC}}
... Not to be confused with ...

Similar proper names ("For other people named ...")

Other people

Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.

Other places

Other hurricanes

Other ships

For articles on ships:

Other popes named Stephen

Distinguish

"Not to be confused with …"

"… redirects here. It is not to be confused with …"

"For technical reasons, … redirects here. For … , see … ."

Wikipedia self-reference

Categories

Category-specific templates:

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.

Family names

Lists

User pages

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



TemplateData

This is the TemplateData documentation for the template used by the new VisualEditor.

Main/doc

This template is used after the heading of a section, to link to the sub-article(s) that is entirely about this topic. The final template will show in italics: Main article: Article 1, Article 2 and Article 3

Template parameters
ParameterDescriptionTypeDefaultStatus
Article 1 page location1Gives the name of the first article to which you want to linkstringemptyrequired
Article 2 page location2Gives the name of the second article to which you want to linkstringemptyoptional
Article 3 page location3Gives the name of the third article to which you want to linkstringemptyoptional
Article 4 page location4Gives the name of the fourth article to which you want to linkstringemptyoptional
Article 5 page location5Gives the name of the fifth article to which you want to linkstringemptyoptional
Article 6 page location6Gives the name of the sixth article to which you want to linkstringemptyoptional
Article 7 page location7Gives the name of the seventh article to which you want to linkstringemptyoptional
Article 8 page location8Gives the name of the eighth article to which you want to linkstringemptyoptional
Article 9 page location9Gives the name of the ninth article to which you want to linkstringemptyoptional
Article 10 page location10Gives the name of the tenth article to which you want to linkstringemptyoptional
Article 1 visible link textl1Gives the text which will appear in the hyperlink to article 1. If not set, the article name will be used.stringemptyoptional
Article 2 visible link textl2Gives the text which will appear in the hyperlink to article 2. If not set, the article name will be used.stringemptyoptional
Article 3 visible link textl3Gives the text which will appear in the hyperlink to article 3. If not set, the article name will be used.stringemptyoptional
Article 4 visible link textl4Gives the text which will appear in the hyperlink to article 4. If not set, the article name will be used.stringemptyoptional
Article 5 visible link textl5Gives the text which will appear in the hyperlink to article 5. If not set, the article name will be used.stringemptyoptional
Article 6 visible link textl6Gives the text which will appear in the hyperlink to article 6. If not set, the article name will be used.stringemptyoptional
Article 7 visible link textl7Gives the text which will appear in the hyperlink to article 7. If not set, the article name will be used.stringemptyoptional
Article 8 visible link textl8Gives the text which will appear in the hyperlink to article 8. If not set, the article name will be used.stringemptyoptional
Article 9 visible link textl9Gives the text which will appear in the hyperlink to article 9. If not set, the article name will be used.stringemptyoptional
Article 10 visible link textl10Gives the text which will appear in the hyperlink to article 10. If not set, the article name will be used.stringemptyoptional