Template:Short description

From Colonia Wiki
Revision as of 20:37, 9 May 2021 by en>Trialpears (Add <nowiki /> when none is used to prevent whitespace issues when used with adjacent newlines)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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

Parameters

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

TemplateData for Short description

<templatedata> { "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": "Online free encyclopedia anyone can edit", "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", "es": "El tipo de página. La coloca en la categoría apropiada - Cosas con descripción corta" }, "example": "Redirect", "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 <syntaxhighlight lang="text" class="" id="" style="" inline="1">noreplace</syntaxhighlight> 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:

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

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:

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

  • {{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 Lua error in Module:Wd at line 196: attempt to index field 'wikibase' (a nil value). (Q1096878) as an example:

  • {{short description/test|Underwater diving where breathing is from equipment independent of the surface}} → Underwater diving where breathing is from equipment independent of the surface
  • {{short description/test|none }} →
  • {{short description/test|wikidata }} → <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-8dfbc3c5">Lua error in Module:WikidataIB at line 2750: attempt to index field &#039;wikibase&#039; (a nil value).</span></strong>

Pagetype parameter

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

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

Aliases

Shortcut

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: <syntaxhighlight lang="text" class="" id="" style="" inline="1"> {{ Short description...</syntaxhighlight>. While this does create a valid short description, the space will prevent searches for the <syntaxhighlight lang="text" class="" id="" style="" inline="1">{{Short description...</syntaxhighlight> text.

Maintenance categories

See also

Retrieved from "https://colonia.lightni.ng/w/index.php?title=Template:Short_description&oldid=1651"