Editing Template:Short description/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High risk| 1400000 |all-pages = yes}}
{{Warning|Please do not use redirects for this template, as 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 the template, use the correct spelling; it is not difficult to remember.}}

'''[[Template:Short description]]''' is used to add a [[Wikipedia:Short description|short description]] to a Wikipedia article, which can be edited from within Wikipedia. 

== Usage ==
{{tld|Short description|''Write your short description here''}}

== Parameters ==
{{TemplateData header|noheader=1}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Description",
			"description": "The short description of the article",
			"example": "Online free encyclopedia anyone can edit",
			"required": true,
			"type": "content"
		},
		"2": {
			"label": "2",
			"description": "Whether to override a short description if transcluded.  Should be unused or 'noreplace'.",
			"example": "noreplace",
			"required": false,
			"type": "string"
                },
		"pagetype": {
			"type": "string",
			"description": "The type of page. This puts it in the appropriate category. - &lt;foo>s with short description",
			"example": "Redirect",
			"required": false,
			"default": "The namespace of the page."
		}
	},
	"description": "Creates a short description for a Wikipedia article, which is used in the Visual Editor to provide context on wikilinks.",
	"format": "{{_|_ = _}}\n"
}
</templatedata>

== About writing good short descriptions ==
This page is about the short description ''template''—it does not provide guidelines for writing a good short description. However, [[Wikipedia:Short description]], offers quick, easy-to-understand guidelines for writing effective short descriptions. If you plan to use this template, you should make sure you understand [[Wikipedia:Short description#Content|how to write a good short description]].

== Template information ==
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.

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. However, this will not override the descriptions from Wikidata.

Short descriptions do not necessarily serve 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. 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:
* {{tld|Short description|Use of oxygen as medical treatment}}
or
* {{tld|Short description|1{{=}}Use 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.
* {{tld|Short description/test}} displays the short description if supplied
* {{tld|Short description/test}} displays nothing if <code>none</code> is supplied
* {{tld|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}}

== Aliases ==
* While there are <span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Short_description|hidetrans=1&hidelinks=1&limit=500}} redirects to this template]</span>, '''they should not be used'''.

==Bots== 
Bots adding short descriptions without manual supervision should use {{para|bot}} with the value being the bot task. For example [[Wikipedia:Bots/Requests for approval/PearBOT 5]] uses <code>|bot=PearBOT 5</code>. Any user may remove the parameter if the description is acceptable. If it's not please report it to the bot operator.

== Maintenance categories ==
* {{clc|Pages using short description with unknown parameters}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
}}</includeonly>