Template:Details/doc View history

Revision as of 22:43, 27 July 2014

This is a documentation subpage for Template:Details.
It contains usage information, categories and other content that is not part of the original template page.

This template is used to make summary style explicit. It looks like this:

For more details on this topic, see Article.

It is used in sections for which there is also a separate article on the subject.

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.
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 three 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 using 1= before the page name, like this: {{details|1=2+2=4}}.

Pages that contain this error message are tracked in Category:Hatnote templates with errors.

Template:Hatnote templates documentation Template:Collapse top

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.
Template parametersParameter Description Type Status
Article 1 The name of the article that you want to link to
String required
Topic 2 A brief description of the topic for which more details will be provided. If left blank, the template will read 'For more information on this topic...'
String optional
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]]".)
Line optional
Category category Set to "no", "n", "false", or "0" to suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the hatnote text is omitted.
Unknown optional

Template:Collapse bottom

@@ Line 36: / Line 36: @@
 * {{details|category=no}}
-If you see this error message, it is for one of four reasons:
+If you see this error message, it is for one of <!--four-->three reasons:
 # No parameters were specified (the template code was <code><nowiki>{{details}}</nowiki></code>). Please use <code><nowiki>{{details|</nowiki>''page''<nowiki>}}</nowiki></code> instead.
 # Some parameters were specified, but the page name wasn't included. For example, the template text <code><nowiki>{{details|selfref=yes}}</nowiki></code> will produce this error. Please use (for example) <code><nowiki>{{details|</nowiki>''page''<nowiki>|selfref=yes}}</nowiki></code> 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 <code><nowiki>{{details|2+2=4}}</nowiki></code> will produce this error. To work around this, you can specify the parameter name explictly by using <code>1=</code> before the page name, like this: <code><nowiki>{{details|1=2+2=4}}</nowiki></code>.
-# You tried to access [[Module:Details]] directly by using <code><nowiki>{{#invoke:details|details|</nowiki>''text''<nowiki>}}</nowiki></code>. Use of #invoke in this way has been disabled for performance reasons. Please use <code><nowiki>{{details|</nowiki>''text''<nowiki>}}</nowiki></code> instead.
+<!-- LUA is not installed at this time. # You tried to access [[Module:Details]] directly by using <code><nowiki>{{#invoke:details|details|</nowiki>''text''<nowiki>}}</nowiki></code>. Use of #invoke in this way has been disabled for performance reasons. Please use <code><nowiki>{{details|</nowiki>''text''<nowiki>}}</nowiki></code> instead. -->
 Pages that contain this error message are tracked in [[:Category:Hatnote templates with errors]].