Difference between revisions of "Template:Details"
[unchecked revision] | [unchecked revision] |
(convert to use Module:Details) |
|||
Line 1: | Line 1: | ||
− | {{ | + | <includeonly>{{#invoke:details|details}}</includeonly><noinclude> |
− | + | {{documentation}} | |
− | {{ | + | <!-- Categories go on the /doc subpage, and interwikis go on Wikidata. --> |
− | |||
</noinclude> | </noinclude> |
Revision as of 10:39, 5 May 2014
This template is used to make summary style explicit. It looks like this:
It is used in sections for which there is also a separate article on the subject.
Contents
- 1 Usage
- 2 Parameters
- 3 Examples
- 4 Errors
- 5 Hatnote templates
- 6 Notes
- 7 See also
Usage
- Basic usage
{{details|article}}
- With a topic
{{details|article|topic}}
- All parameters
{{details|article|topic|selfref=yes|category=no}}
Parameters
This template accepts the following parameters:
-
1
- the page to link to (required). Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as page § section, rather than the MediaWiki default of page#section. -
2
- the name of the topic. If this is not specified, the text "this topic" is used. -
selfref
- if set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See Template:Selfref for more information. -
category
- if set to "no", "n", "false", or "0", suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the first positional parameter (the page to link to) is omitted.
Examples
-
{{details|Article}}
→For more details on this topic, see Article. -
{{details|Article|some topic}}
→For more details on some topic, see Article.
Errors
If no page name is supplied, the template will output the following message:
- For more details on this topic, see [[{{{1}}}]].
If you see this error message, it is for one of four reasons:
- No parameters were specified (the template code was
{{details}}
). Please use{{details|page}}
instead. - Some parameters were specified, but the page name wasn't included. For example, the template text
{{details|selfref=yes}}
will produce this error. Please use (for example){{details|page|selfref=yes}}
instead. - The page name was specified, but it contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code
{{details|2+2=4}}
will produce this error. To work around this, you can specify the parameter name explictly by using1=
before the page name, like this:{{details|1=2+2=4}}
. - You tried to access Module:Details directly by using
{{#invoke:details|details|text}}
. Use of #invoke in this way has been disabled for performance reasons. Please use{{details|text}}
instead.
If you see this error message and are unsure of what to do, please post a message on the help desk, and someone should be able to help you.
Pages that contain this error message are tracked in Category:Hatnote templates with errors.
Hatnote templates
For the full editing guideline on hatnotes, see Wikipedia:Hatnote.
Generic
-
{{Hatnote|CUSTOM TEXT}}
→CUSTOM TEXT
If a hatnote link leads to a disambiguation page without providing the "(disambiguation)" parameter, this parameter must be added manually. This indicates that the disambiguation link is intentional, and not an error (see WP:INTDABLINK for details):
-
{{Hatnote|For other senses of this term, see [[Page (disambiguation){{!}}Page]]}}
→For other senses of this term, see Page
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|Main Article|Article2}}
→
-
{{Main list|Article1}}
→ Template:Mainlist
"For more details on …, see …"
{{Details}}
can supplement {{Main}}
in summary sections, or can indicate more details in nonsummary sections:
{{Details3}}
allows changing the displayed name for links. Unlike {{Details}}
, it requires bracketed link notation:
-
{{Details3|[[NTSC#Color_encoding|NTSC Color encoding]]}}
→ Template:Details3 -
{{Details3|[[article 1|Article 1]], [[article 2|Article 2]], and [[article 3|Article 3]]|TOPIC}}
→ Template:Details3
Alternatively, the {{!}}
magic word can be used to change the displayed name for links:
-
{{Details|NTSC#Color_encoding{{!}}NTSC Color encoding}}
→For more details on this topic, see NTSC Color encoding.
"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}}
→ Template:See also2
"Further information: …"
-
{{Further|PAGE}}
→Further information: PAGE -
{{Further|PAGE1|PAGE2|PAGE3}}
→ -
{{Further2|[[PAGE1]], [[PAGE2]], 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 Details (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 {{!}} magic word 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 Details (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. For and, see Details (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}}
→For other uses, see PAGE1.
- Note:
{{for||PAGE1|PAGE2}}
produces the same result.
-
{{About|USE1|section=yes}}
→This page is about USE1. For other uses, see Details (disambiguation).
- Note: this hatnote says "section", instead of "article" or "page".
"This page is about … It is not to be confused with …"
{{About-distinguish}}
is a template for noting other uses when there could be confusion with another topic.
-
{{About-distinguish|USE1|PAGE1}}
→ Template:About-distinguish -
{{About-distinguish2|USE1|TEXT}}
→ Template:About-distinguish2
"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}}
→For OTHER TOPIC, see Details (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 is a whole family of "for" templates. {{For2}} allows custom text, such as quotation marks or a link from part of the "CUSTOM TEXT"
-
{{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}}
→For other uses, see Details (disambiguation). -
{{Other uses|PAGE1}}
→For other uses, see PAGE1. -
{{Other uses|PAGE1|PAGE2}}
→For other uses, see PAGE1.
- 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}}
→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 Details (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}}
→ -
{{Two other uses||USE2|PAGE2|USE3|PAGE3}}
→ -
{{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}}
→ Template:Other uses of -
{{Other uses of|TOPIC}}
→ Template:Other uses of -
{{Other uses of|TOPIC|PAGE1}}
→ Template:Other uses of
"… redirects here. For other uses, see …"
-
{{Redirect|REDIRECT}}
→"REDIRECT" redirects here. For other uses, see REDIRECT (disambiguation).
-
{{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}}
→"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}}
→"REDIRECT1" and "REDIRECT2" redirect here. For other uses, see REDIRECT1 (disambiguation). -
{{Redirect2|REDIRECT1|REDIRECT2|USE}}
→"REDIRECT1" and "REDIRECT2" redirect here. For USE, see REDIRECT1 (disambiguation). -
{{Redirect2|REDIRECT1|REDIRECT2||PAGE1}}
→"REDIRECT1" and "REDIRECT2" redirect here. For other uses, see PAGE1. -
{{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}}
→ -
{{Redirect4|REDIRECT1|REDIRECT2}}
→"REDIRECT1" and "REDIRECT2" redirect here. For other uses, see REDIRECT1 (disambiguation) and REDIRECT2 (disambiguation). -
{{Redirect4|REDIRECT1|REDIRECT2|USE|TEXT}}
→"REDIRECT1" and "REDIRECT2" redirect here. For USE, see TEXT.
-
- For three sources:
-
{{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}
→ Template:Redirect7 -
{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}
→"REDIRECT1", "REDIRECT2", and "REDIRECT3" redirect here. For other uses, see REDIRECT1 (disambiguation), REDIRECT2 (disambiguation), and REDIRECT3 (disambiguation). -
{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3|USE|TEXT}}
→"REDIRECT1", "REDIRECT2", and "REDIRECT3" redirect here. For USE, see TEXT.
-
- To specify the text following "redirects here.":
-
{{Redirect3|REDIRECT|TEXT}}
or{{Redirect text|REDIRECT|TEXT}}
→"REDIRECT" redirects here. TEXT. -
{{Redirect-synonym|TERM|OTHER TOPIC}}
→"TERM" redirects here. TERM may also refer to OTHER TOPIC.
-
- ... 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}}
→"REDIRECT" redirects here. It is not to be confused with TEXT.
Similar proper names ("For other people named ...")
Other people
-
{{Other people}}
→For other people named Details, see Details (disambiguation). -
{{Other people|NAME}}
→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}}
→For other people named Details, see Details (disambiguation).
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
-
{{Other people3|PERSON1}}
→This article is about PERSON1. For other people named Details, see Details (disambiguation). -
{{Other people3|PERSON1|PERSON2}}
→This article is about PERSON1. For PERSON2, see Details (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 Details, 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}} →For other places with the same name, see Details (disambiguation). -
{{Other places|PAGE}}
, analogous to {{Other uses2}} →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}}
→ 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}}
→For other ships of the same name, see SHIP1.
Other popes named Stephen
Distinguish
"Not to be confused with …"
-
{{Distinguish|PAGE1}}
→Not to be confused with PAGE1. -
{{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}
→ -
{{Distinguish2|TEXT}}
→ Template:Distinguish2 -
{{Distinct|PAGE1|PAGE2|PAGE3|PAGE4}}
or{{Distinct|[[PAGE1]]|[[PAGE2]]|[[PAGE3]]|[[PAGE4]]}}
→ -
{{Distinct|TEXT [[PAGE1]]}}
→This topic is distinct from TEXT PAGE1.
"… 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}}
→"REDIRECT" redirects here. It is not to be confused with TEXT.- Also may be used as
{{Redirect-distinguish2|REDIRECT}}
→"REDIRECT" redirects here.
- Also may be used as
"For technical reasons, … redirects here. For … , see … ."
-
{{Technical reasons|REDIRECT}}
→ Template:Technical reasons -
{{Technical reasons|REDIRECT|PAGE}}
→ Template:Technical reasons -
{{Technical reasons|REDIRECT|DESCRIPTION|PAGE}}
→ Template:Technical reasons -
{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2}}
→ Template:Technical reasons -
{{Technical reasons|REDIRECT|DESCRIPTION1|PAGE1|DESCRIPTION2|PAGE2|DESCRIPTION3|PAGE3}}
→ Template:Technical reasons
Wikipedia self-reference
-
{{Selfref|ANYTEXT}}
→ANYTEXT
Categories
Category-specific templates:
-
{{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.
-
{{Cat main|MAIN ARTICLE}}
→ Template:Cat main -
{{Category explanation|colourless green ideas}}
→ Template:Category explanation -
{{Category pair|TOPIC1|TOPIC2}}
→ Template:Category pair -
{{CatPreceding|OTHER TOPIC}}
→ Template:CatPreceding -
{{CatSucceeding|OTHER TOPIC}}
→ Template:CatSucceeding -
{{Contrast|OTHERCAT|OTHERCAT2}}
→ -
{{Contrast|OTHERCAT|OTHERCAT2|plural=yes}}
→
Family names
Lists
User pages
-
{{This user talk|TOPIC|PAGE1}}
→
Notes
This template should not be substituted. Do not use subst: with these templates, as that will prevent:
|
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
TemplateData | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Details This template is used to show readers where to find more details about a particular topic. It is usually placed at the top of a section or article.
|
The above documentation is transcluded from Template:Details/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |