Templete:Short description

Template:SHORTDESC:

 Editors can experiment in this template's sandbox and test case pages.

<templatestyles src="Module:Message box/ombox.css"></templatestyles>

Template:Warning

<templatestyles src="Module:Message box/ambox.css"></templatestyles>

* Module:Check for unknown parameters
* Module:String

**Template:Short description** is used to add a short description (which can be edited from within Wikipedia) to a Wikipedia page. These descriptions appear in Wikipedia searches and elsewhere, and help users identify the desired article.

## Usage

`{{Short description|*Write your short description here*}}`

This should be limited to about 40 characters, as explained at WP:SDFORMAT, along with the other guidance at WP:SDCONTENT.

## Parameters

**TemplateData for Templete:Short description**

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

Template parameters

This template has custom formatting.

## About writing good short descriptions

This page is about the short description *template*; it does not provide guidelines for writing a good short description. If you plan to use this template, you should make sure you read and follow the detailed guidance at WP:HOWTOSD. General information can be found at Wikipedia:Short description.

## Template information

Eventually all articles should have a short description:

* by directly using this template, in which case the short description will be unique to the article
* transcluded in another template, such as a disambiguation template, where a generic short description is adequate for a large class of pages
* where the short description is assembled from data in an infobox

Automatically generated descriptions within templates should set the second parameter as `noreplace` so they do not override any short descriptions specifically added to the transcluding article.

Short descriptions are not normally needed for non-article pages, such as redirects, but can be added if useful.

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

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. 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. Template:Crossref

### Example

At Oxygen therapy, add the following at the very top of the article, above everything else:

* `{{Short description|Use of oxygen as medical treatment}}`

## Testing

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

* `.shortdescription { display:block !important; }`

This can be easily removed or disabled when testing is finished.

If you want to *always* see short descriptions, you may prefer a more utilitarian layout, such as:

```
.shortdescription {
 display:block !important;
 white-space: pre-wrap;
}
.shortdescription::before {
 content: "\A[Short description:\0020";
}
.shortdescription::after {
 content: "]\A";
}

```

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

* `{{Short description/test}}` displays the short description if supplied
* `{{Short description/test}}` displays nothing if `none` is supplied
* `{{Short description/test}}` displays the description from Wikidata if `wikidata` is supplied.

Taking Template:Q as an example:

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

**Script error: No such module "LuaCall".**

* `{{short description/test|none}}` →

**Script error: No such module "LuaCall".**

* `{{short description/test|wikidata}}` →

**Script error: No such module "LuaCall".**

### Pagetype parameter

If Template:Param is **not** set, then this template adds the article to a category based on the namespace:

1. REDIRECT Template:Category link with count

1. REDIRECT Template:Category link with count Template:-- for redirects in any namespace

If Template:Param **is** set, then this template adds the article to a category matching the parameter. For example:

* Category:Redirects with short description Template:-- `pagetype = Redirect`

## Aliases

<templatestyles src="Module:Shortcut/styles.css"></templatestyles>Shortcut<templatestyles src="Plainlist/styles.css"></templatestyles>* WP:SDNOALIASES

While there are currently redirects to this template, **they must not be used**, for the reasons below:

* Other templates and gadgets attempt to extract short descriptions from pages by explicitly searching for the transclusions of the {{Short description}} template.
* For example, {{Annotated link}} searches for the template in its uppercase "Short description" and lowercase form "short description".

**Do not** start the template with a space: `{{ Short description...`. While this does create a valid short description, the space will prevent searches for the `{{Short description...` text.

## Tracking categories

1. REDIRECT Template:Category link with count

1. REDIRECT Template:Category link with count

1. REDIRECT Template:Category link with count

1. REDIRECT Template:Category link with count

1. REDIRECT Template:Category link with count

## Maintenance categories

1. REDIRECT Template:Category link with count

1. REDIRECT Template:Category link with count

1. REDIRECT Template:Category link with count

## See also

* `{{Auto short description}}`
* `{{Annotated link}}`
* `{{laal}}` – displays an article's pagelinks alongside its short description
* Wikipedia:Short descriptions — background information
* Wikipedia:WikiProject Short descriptions — project to add Short descriptions to all articles