Template:Details/doc

From Wikipedia, the free encyclopedia
Jump to: navigation, search

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.

Usage[edit]

Basic usage
{{details|PAGE1}}
With more than one article
{{details|PAGE1|PAGE2|PAGE3}}
With a topic
{{details|topic=TOPIC|PAGE1|PAGE2}}
All parameters
{{details|topic=TOPIC|PAGE1|PAGE2#SECTION|selfref=yes|category=no}}

Parameters[edit]

This template can take any number of unnamed parameters (at least one is required), which are the target pages. Links to 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.

In addition, this template accepts the following named parameters:

  • topic - 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 {{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 an error would be produced.

Examples[edit]

  • {{details|Article}}
  • {{details|topic=some topic|Article}}

Errors[edit]

If no page name is supplied, the template will output the following message:

  • Error: no page name specified (help).

If you see this error message, it is for one of four reasons:

  1. No parameters were specified (the template code was {{details}}). Please use {{details|page}} instead.
  2. 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.
  3. 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 explicitly by using 1= before the page name, like this: {{details|1=2+2=4}}.
  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.

TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools.

See the monthly error report for this template.

TemplateData for 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.

Template parameters

This template has custom formatting.

Parameter Description Type Status
Topic topic

A brief description of the topic for which more details will be provided. If left blank, the template will read 'For more details on this topic...'

Default
empty
Example
empty
Auto value
empty
String suggested
Page 1 1

The name of the first page that you want to link to

Default
empty
Example
empty
Auto value
empty
Page required
Page 2 2

The name of the second page that you want to link to

Default
empty
Example
empty
Auto value
empty
Page suggested
Page 3 3

The name of the third page that you want to link to

Default
empty
Example
empty
Auto value
empty
Page suggested
Self reference selfref

Set to "yes" if the hatnote text is a self-reference to Wikipedia that would not make sense on mirrors or forks of the Wikipedia site. (E.g. "For the Wikipedia Sandbox, see [[WP:SAND]]".)

Default
empty
Example
empty
Auto value
empty
Boolean optional
Category category

Set to "no", "n", "false", or "0" to suppress the error tracking category (Category:Hatnote templates with errors). This only has an effect if an error would be produced.

Default
empty
Example
empty
Auto value
empty
Boolean optional

See also[edit]

  • {{Summarize}} for use where details of one article need to be summed up in another
  • {{Summarize section}} for use where part of an article contains too many details