Template:Short description: Difference between revisions

Revision as of 19:55, 23 August 2022

Template documentation[view] [edit] [history] [purge]

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

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

[Edit template data]
Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Description	`1`	The short description of the article or 'none'. Example Chinese encyclopedia writer (1947–2001)	Content	required
No replace?	`2`	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. Auto value `noreplace`	String	optional
pagetype	`pagetype`	The type of page. This puts it in the appropriate category - Things with short description. Normally unneeded, since handled through namespace detection. Example Redirect, Disambiguation page	String	optional

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 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}} → Template:Short description/test
{{short description/test|none }} → Template:Short description/test
{{short description/test|wikidata }} → Template:Short description/test

Pagetype parameter

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

Category:Articles with short description (91)
Category:Categories with short description (0)
Category:Drafts with short description (0)
Category:Files with short description (0)
Category:Help pages with short description (1)
Category:Modules with short description (0)
Category:Portals with short description (0)
Category:Project pages with short description (0)
Category:Templates with short description (5)
Category:User pages with short description (0)
Category:Redirects with short description (0) 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:Disambiguation pages with short description (0) Template:-- pagetype = Disambiguation page

Aliases

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

@@ Line 1: / Line 1: @@
-{{#ifeq:{{lc:{{{1|}}}}}|none|<nowiki /><!--Prevents whitespace issues when used with adjacent newlines-->|<div class="shortdescription nomobile noexcerpt noprint searchaux" style="display:none">{{{1|}}}{{SHORTDESC:{{{1|}}}|{{{2|}}}}}</div>}}<includeonly>[[Category:{{{pagetype|{{pagetype |defaultns = extended |plural=y}}}}} with short description{{#ifeq:{{{pagetype}}}|Disambiguation pages|s}}]]</includeonly><!-- Start tracking
+{{#ifeq:{{lc:{{{1|}}}}}|none|<nowiki /><!--Prevents whitespace issues when used with adjacent newlines-->|<div class="shortdescription nomobile noexcerpt noprint searchaux" style="display:none">{{{1|}}}{{SHORTDESC:{{{1|}}}|{{{2|}}}}}</div>}}<includeonly>{{#ifeq:{{pagetype |defaultns = all |user=exclude}}|exclude||[[Category:{{{pagetype|{{pagetype |defaultns = extended |plural=y}}}}} with short description{{#ifeq:{{{pagetype}}}|Disambiguation pages|s}}]]}}</includeonly><!-- Start tracking
 -->{{#invoke:Check for unknown parameters|check|unknown={{Main other|[[Category:Pages using short description with unknown parameters|_VALUE_{{PAGENAME}}]]}}|preview=Page using [[Template:Short description]] with unknown parameter "_VALUE_"|ignoreblank=y| 1 | 2 | pagetype | bot |plural }}<!--
 -->{{#ifexpr: {{#invoke:String|len|{{{1|}}}}}>100 | [[Category:{{{pagetype|{{pagetype |defaultns = extended |plural=y}}}}} with long short description]]}}<!--
+-->{{Short description/lowercasecheck|{{{1|}}}}}<!--
 -->{{Main other |{{SDcat |sd={{{1|}}} }} }}<noinclude>
 {{Documentation}}
 </noinclude>