View source for Template:Details/doc

{{documentation subpage}}
{{tsh|more}}
{{lua|Module:Details}}

This template is used to make [[Wikipedia:Summary style|summary style]] explicit. It looks like this:

{{details|Article}}

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

== Usage ==
;Basic usage:
:{{tlx|details|PAGE1}} → {{details|PAGE1}}
; With more than one article:
:{{tlx|details|PAGE1|PAGE2|PAGE3}} → {{details|PAGE1|PAGE2|PAGE3}}
; With a topic:
:{{tlx|details|<nowiki>topic=TOPIC</nowiki>|PAGE1|PAGE2}} → {{details|topic=TOPIC|PAGE1|PAGE2}}
; All parameters:
:{{tlx|details|<nowiki>topic=TOPIC</nowiki>|PAGE1|PAGE2#SECTION|<nowiki>selfref=yes</nowiki>|<nowiki>category=no</nowiki>}} → {{details|topic=TOPIC|PAGE1|PAGE2#SECTION|selfref=yes|category=no}}

== Parameters ==
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 [[Help:Colon trick|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:
* <code>topic</code> - the name of the topic. If this is not specified, the text "this topic" is used.
* <code>selfref</code> - if set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See {{tl|selfref}} for more information.
* <code>category</code> - 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 ==

* <code><nowiki>{{details|Article}}</nowiki></code> → {{details|Article}}
* <code><nowiki>{{details|topic=some topic|Article}}</nowiki></code> → {{details|topic=some topic|Article}}

== Errors ==

If no page name is supplied, the template will output the following message:
* {{details|category=no}}

If you see this error message, it is for one of four 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 explicitly 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.

If you see this error message and are unsure of what to do, please post a message on [[WP:HD|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}}
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"description": "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.",
	"params": {
		"1": {
			"label": "Page 1",
			"description": "The name of the first page that you want to link to",
			"type": "wiki-page-name",
			"required": true
		},
		"2": {
			"label": "Page 2",
			"description": "The name of the second page that you want to link to",
			"type": "wiki-page-name",
			"suggested": true
		},
		"3": {
			"label": "Page 3",
			"description": "The name of the third page that you want to link to",
			"type": "wiki-page-name",
			"suggested": true
		},
		"topic": {
			"label": "Topic",
			"description": "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...'",
			"type": "string",
			"required": false,
			"suggested": true
		},
		"selfref": {
			"type": "boolean",
			"label": "Self reference",
			"description": "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]]\".)"
		},
		"category": {
			"label": "Category",
			"description": "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.",
			"type": "boolean"
		}
	},
	"paramOrder": [
		"topic",
		"1",
		"2",
		"3",
		"selfref",
		"category"
	],
	"format": "inline"
}
</templatedata>
{{Collapse bottom}}

==See also==
* {{tl|Summarize}} for use where details of one article need to be summed up in another
* {{tl|Summarize section}} for use where part of an article contains too many details

<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Cross-reference templates|{{PAGENAME}}]]
[[Category:Wikipedia page-section templates|{{PAGENAME}}]]
[[Category:Exclude in print|{{PAGENAME}}]]
[[Category:Hatnote templates]]

}}</includeonly>