Template:Short description

Template documentation

This documentation is  transcluded from Template:Short description/doc. (Edit | history)
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.

Warning!

Please do not use redirects/shortcuts for this template, as they cause problems with the short description editing gadget and other maintenance tools.

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 mobile 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

Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Short description

{
	"description": {
		"en": "Creates a short description, for a Wikipedia article, which is used in the Visual Editor to provide context on wikilinks.",
		"es": "Crea una breve descripción, para un artículo de Wikipedia, que se utiliza en el Editor Visual para proporcionar contexto en los wikilinks (wikienlaces)."
	},
	"params": {
		"1": {
			"label": {
				"en": "Description",
				"es": "Descripción"
			},
			"description": {
				"en": "The short description of the article or 'none'.",
				"es": "La descripción corta del artículo"
			},
			"example": {
				"en": "Chinese encyclopedia writer (1947–2001)",
				"es": "La enciclopedia en línea que cualquiera puede editar"
			},
			"required": true,
			"type": "content"
		},
		"2": {
			"label": {
				"en": "No replace?",
				"es": "2"
			},
			"description": {
				"en": "Should be unused or 'noreplace'. Templates with noreplace will not replace a short description defined by an earlier template. Mainly for use within transcluded templates.",
				"es": "Se anula una descripción corta si se transcluye.  Debe estar sin usar o  con 'noreplace' (que significar no reemplazar)."
			},
			"example": {
				"es": "noreplace"
			},
			"required": false,
			"type": "string",
			"autovalue": "noreplace"
		},
		"pagetype": {
			"type": "string",
			"description": {
				"en": "The type of page. This puts it in the appropriate category - Things with short description. Normally unneeded, since handled through namespace detection.",
				"es": "El tipo de página. La coloca en la categoría apropiada - Cosas con descripción corta"
			},
			"example": "Redirect, Disambiguation page",
			"required": false
		}
	},
	"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. 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. (See also  Wikidata:Help:Description.)

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 finished testing.

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 " as an example:

• {{short description/test|Underwater diving where breathing is from equipment independent of the surface}} → Template:Short description/test
• {{short description/test|none}} → Template:Short description/test
• {{short description/test|wikidata}} → Template:Short description/test

Pagetype parameter

If {{{Pagetype}}} is not set, then this template adds the article to a category based on the namespace:

• Category:Articles with short description (0)
• Category:Categories with short description (0)
• Category:Drafts with short description (0)
• Category:Files with short description (0)
• Category:Help pages with short description (0)
• Category:Modules with short description (0)
• Category:Portals with short description (0)
• Category:Project pages with short description (0)
• Category:Templates with short description (2)
• Category:Redirects with short description (0) Template:-- for redirects in any namespace

If {{{Pagetype}}} is set, then this template adds the article to a category matching the parameter. For example:

• Category:Disambiguation pages with short description (0) Template:-- pagetype = Disambiguation page

Aliases

While there are currently redirects to this template, they must not be used.

Other templates and gadgets attempt to extract the description from pages by explicitly searching for the use of the {{Short description}} template.

For example, {{Annotated link}} searches for templates "Short description" or "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

• Category:Templates that generate short descriptions (2)
• Category:Modules that create a short description (0)
• Category:Short description matches Wikidata (0)
• Category:Short description is different from Wikidata (0)
• Category:Short description with empty Wikidata description (0)

Maintenance categories

• Category:Pages using short description with unknown parameters (0)
• Category:Articles with long short description (0)
• Category:Pages with lower-case short description (0)

See also

• {{Auto short description}}
• {{Annotated link}}
• Wikipedia:Short descriptions — background information
• Wikipedia:WikiProject Short descriptions — project to add Short descriptions to all articles