View source for Template:Short description/doc

{{Documentation subpage}}
{{warning|Please do not use redirects for this template, they cause problems with the short description editing gadget and other maintenance tools. If you use the editing gadget there is no need for redirects. If you need to manually add, use the correct spelling, it is not difficult to remember.}}

== Usage ==
This template is intended to hold a short description of a Wikipedia article, which can be edited from within Wikipedia. Eventually all articles should have a short description, either directly by using this template, in which case the short description will be unique to the article, or transcluded in another template, such as a disambiguation template, where a generic short description is adequate for a large class of pages, or in a more complex form such as transcluded in a template like an infobox, where the short description is assembled from data in the infobox. 

Automatically generated descriptions within templates should give as a second parameter "noreplace" so they are overridden by any short descriptions manually added to the transcluding article.

Short descriptions are not required in other namespaces, but in some cases may be useful.

Please refer to [[Wikipedia:Short description]] and [[Wikipedia:WikiProject Short descriptions]] for more detailed information.

<!-- Probably should be linked to MOS, and this type of information provided there. -->

The short descriptions should enable a user to recognise the associated article they want from a list of search results. It is not necessarily the same function as the Wikidata description for an item and they do not have to be the same, but some overlap is expected in many cases.

The short description function is to disambiguate not only from current ambiguities, but also from reasonably probable future ambiguities. 

{{strong|The short description should concisely state what the article is about}}, not be a list of what it is not about, nor a list of what the reader might be looking for. Keep it short and simple. Avoid specialist terminology. As much detail as is necessary should be provided, no more—avoid listing examples. It will be displayed on mobile view along with other possible hits, and must be intelligible to the lay reader. Content of the short description should be considered part of the article content and should be managed in the same way as any other content. 

If the article title alone is sufficient to ensure reliable identification of the desired article, a null value of {{tnull|Short description|none}} may be used. 

Perhaps a bot might be used to import the initial short description from Wikidata – or not as preferred. Some Wikidata descriptions may be  unsuitable, and if imported, must be checked for relevance, accuracy and fitness for purpose. Responsibility for such imports lies with the importer.

The idea is that a class can be set to display differently on desktop Wikipedia from how it displays on mobile view. The intention is to bring the short description within the ''immediate'' editing ability of most editors.

Articles using this template can be found in [[:Category:Articles with short description]], which the template automatically sets.

=== Example ===

At [[Oxygen therapy]], add the following at the top of the article:

* {{tnull|Short description|Use of high concentrations of oxygen as medical treatment}}

or

* {{tnull|Short description|1{{=}}Use of high concentrations of oxygen as medical treatment}}

Use the second form if the text of the short description contains an equals sign (=).

== Testing ==

For testing purposes, the display of this template can be enabled by adding a line to your [[Special:MyPage/common.css]]:

* <syntaxhighlight lang="CSS" inline>.shortdescription { display:block !important; }</syntaxhighlight>

This can be easily removed or disabled when finished testing.

If you wish to {{em|always}} see short descriptions, you may want a more utilitarian layout, such as:

<syntaxhighlight lang="CSS">

.shortdescription {

  display:block !important;

  white-space: pre-wrap;

}

.shortdescription::before { 

  content: "\A[Short description:\0020";

}

.shortdescription::after { 

  content: "]\A";

}

</syntaxhighlight>

There is a test version of this template available as [[Template:Short description/test]] which displays its text by default.

* {{tnull|Short description/test}} displays the short description if supplied

* {{tnull|Short description/test}} displays nothing if <code>none</code> is supplied

* {{tnull|Short description/test}} displays the description from Wikidata if <code>wikidata</code> is supplied.

Taking {{Q|Q1096878}} as an example:

* <code><nowiki>{{short description/test|Underwater diving where breathing is from equipment independent of the surface}}</nowiki></code> → {{short description/test|Underwater diving where breathing is from equipment independent of the surface }}

* <code><nowiki>{{short description/test|none }}</nowiki></code> → {{short description/test|none}}

* <code><nowiki>{{short description/test|wikidata }}</nowiki></code> → {{short description/test|wikidata|qid=Q1096878}}

<includeonly>{{sandbox other||

<!-- Categories below this line, please; interwikis at Wikidata -->

<!-- Category:Articles with short description (maintenance category)? -->

}}</includeonly>

<templatedata>

{

	"params": {

		"1": {

			"label": "Description",

			"description": "The short description of the article",

			"example": "Online free encyclopedia anyone can edit",

			"required": true,

			"type": "content"

		},

		"pagetype": {

			"type": "string"

		}

	},

	"description": "Creates a short description for a Wikipedia article, which is used in the Visual Editor to provide context on wikilinks.",

	"format": "{{_|_ = _}}\n"

}

</templatedata>