Template:Short description/doc

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
This should be limited to about 40 characters, as explained at WP:SDFORMAT, along with the other guidance at WP:SDCONTENT.

Parameters
{	"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" }

About writing good short descriptions
This page is about the short description ; 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 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 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.

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

Testing
For testing purposes, the display of this template can be enabled by adding a line to your Special:MyPage/common.css: This can be easily removed or disabled when testing is finished.

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

There is a test version of this template available as Template:Short description/test which displays its text by default.
 * displays the short description if supplied
 * displays nothing if  is supplied
 * displays the description from Wikidata if  is supplied.

Taking as an example:

Pagetype parameter
If is not set, then this template adds the article to a category based on the namespace:
 * for redirects in any namespace
 * for redirects in any namespace

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

Aliases
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: {{code| {{ Short description... }}. While this does create a valid short description, the space will prevent searches for the {{code| {{Short description... }} text.