Difference between revisions of "Template:Short description/doc"

From Seeds of the Word
(→‎Maintenance categories: add to list of tracking categories)
 
m (1 revision imported)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High risk| 2000000+ |all-pages = yes}}
{{High risk|all-pages = yes}}
{{Warning|'''Please do not use redirects/shortcuts for this template''', as they cause problems with the [[User:Galobtter/Shortdesc helper|short description editing gadget]] and other maintenance tools.}}
{{Warning|'''Please do not use redirects/shortcuts for this template''', as they cause problems with the [[User:Galobtter/Shortdesc helper|short description editing gadget]] and other maintenance tools.}}


'''[[Template:Short description]]''' is used to add a [[Wikipedia:Short description|short description]] (which can be edited from within Wikipedia) to a Wikipedia page.  
'''[[Template:Short description]]''' is used to add a [[Wikipedia:Short description|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 ==
== Usage ==
Line 13: Line 13:
<templatedata>
<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": {
"params": {
"1": {
"1": {
"label": "Description",
"label": {
"description": "The short description of the article",
"en": "Description",
"example": "Online free encyclopedia anyone can edit",
"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,
"required": true,
"type": "content"
"type": "content"
},
},
"2": {
"2": {
"label": "2",
"label": {
"description": "Whether to override a short description if transcluded.  Should be unused or 'noreplace'.",
"en": "No replace?",
"example": "noreplace",
"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 transcluyeDebe estar sin usar o  con 'noreplace' (que significar no reemplazar)."
},
"example": {
"es": "noreplace"
},
"required": false,
"required": false,
"type": "string"
"type": "string",
"autovalue": "noreplace"
},
},
"pagetype": {
"pagetype": {
"type": "string",
"type": "string",
"description": "The type of page. This puts it in the appropriate category - Things with short description",
"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",
"example": "Redirect",
"required": false,
"required": false
"default": "The namespace of the page."
},
"bot": {
"description": "Name of bot which added the short description. Should be generated automatically, as in [[Special:Diff/925779924]] ",
"example": "PearBOT 5",
"type": "string"
}
}
},
},
"description": "Creates a short description for a Wikipedia article, which is used in the Visual Editor to provide context on wikilinks.",
"format": "{{_|_ = _}}\n"
"format": "{{_|_ = _}}\n"
}
}
Line 47: Line 65:


== About writing good short descriptions ==
== About writing good short descriptions ==
This page is about the short description ''template''—it does not provide guidelines for writing a good short description. However, [[Wikipedia:Short description]], offers quick, easy-to-understand guidelines for writing effective short descriptions. If you plan to use this template, you should make sure you understand [[Wikipedia:Short description#Content|how to write a good short description]].
This page is about the short description {{em|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 ==
== Template information ==
Line 57: Line 75:
Automatically generated descriptions within templates should set the second parameter as {{code|noreplace}} so they do not override any short descriptions specifically added to the transcluding article.
Automatically generated descriptions within templates should set the second parameter as {{code|noreplace}} so they do not override any short descriptions specifically added to the transcluding article.


Short descriptions are not required in other namespaces, but in some cases may be useful.
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 {{tnull|Short description|none}} may be used. However, this will not override the descriptions from Wikidata.


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.
If the article title alone is sufficient to ensure reliable identification of the desired article, a null value of {{tnull|Short description|none}} may be used.
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.


The idea is that a class can be set to display differently on desktop Wikipedia from how it displays on mobile view. The intention is to bring the short description within the ''immediate'' editing ability of most editors.
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. {{crossref|(See also [[d:Help:Description|Wikidata:Help:Description]].)}}


=== Example ===
=== Example ===
At [[Oxygen therapy]], add the following at the top of the article:
At [[Oxygen therapy]], add the following at the very top of the article, above everything else:
* {{tld|Short description|Use of oxygen as medical treatment}}
* {{tld|Short description|Use of oxygen as medical treatment}}
or
* {{tld|Short description|1{{=}}Use of oxygen as medical treatment}}
Use the second form if the text of the short description contains an equals sign (=). Avoid this if possible, as it affects alternative uses of the short description as in {{tl|annotated link}} ({{Phab|T216356}}, if implemented, will make usage of annotated link unnecessary.)


== Testing ==
== Testing ==
Line 78: Line 90:
This can be easily removed or disabled when finished testing.
This can be easily removed or disabled when finished testing.


If you wish to {{em|always}} see short descriptions, you may want a more utilitarian layout, such as:
If you want to {{em|always}} see short descriptions, you may prefer a more utilitarian layout, such as:


<syntaxhighlight lang="CSS">
<syntaxhighlight lang="CSS">
Line 103: Line 115:


===Pagetype parameter===
===Pagetype parameter===
If {{param|Pagetype}} is '''not''' set, then this template adds the article to a category based on the namespace:
If {{param|Pagetype}} is '''not''' set, then this template adds the article to a category based on the namespace:
* {{clc|Articles with short description}}
* {{clc|Articles with short description}}
* {{clc|Books with short description}}
* {{clc|Categories with short description}}
* {{clc|Categories with short description}}
* {{clc|Drafts with short description}}
* {{clc|Drafts with short description}}
* {{clc|Files with short description}}
* {{clc|Files with short description}}
* {{clc|Help pages with short description‎}}
* {{clc|Help pages with short description}}
* {{clc|Modules with short description}}
* {{clc|Modules with short description}}
* {{clc|Portals with short description}}
* {{clc|Portals with short description}}
* {{clc|Project pages with short description}}
* {{clc|Project pages with short description}}
* {{clc|Templates with short description}}
* {{clc|Templates with short description}}
* {{clc|User pages with short description‎}}
* {{clc|User pages with short description}}
* {{clc|Redirects with short description}} {{--}} for redirects in any namespace
* {{clc|Redirects with short description}} {{--}} for redirects in any namespace


If {{param|Pagetype}} '''is''' set, then this template adds the article to a category matching the parameter. For example:
If {{param|Pagetype}} '''is''' set, then this template adds the article to a category matching the parameter. For example:
* {{clc|Disambiguation pages with short description‎}} {{--}} {{code|pagetype {{=}} Disambiguation page}}
* {{clc|Disambiguation pages with short description}} {{--}} {{code|pagetype {{=}} Disambiguation page}}


{{anchor|No-aliases}}
== Aliases ==
== Aliases ==
While there are <span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Short_description|hidetrans=1&hidelinks=1&limit=500}} redirects to this template]</span>, '''they should not be used'''.
{{shortcut|WP:SDNOALIASES}}
While there are currently <span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Short_description|hidetrans=1&hidelinks=1&limit=500}} redirects to this template]</span>, '''they must not be used'''.


: Other templates and gadgets attempt to extract the description from pages by explicitly searching for the use of the {{tl|Short description}} template.
: Other templates and gadgets attempt to extract the description from pages by explicitly searching for the use of the {{tl|Short description}} template.
: For example, {{tl|Annotated link}} searches for templates "Short description" or "short description".
: For example, {{tl|Annotated link}} searches for templates "Short description" or "short description".


==Bot parameter==
'''Do not''' start the template with a space: {{code|<nowiki> {{ Short description...</nowiki>}}. While this does create a valid short description, the space will prevent searches for the {{code|<nowiki>{{Short description...</nowiki>}} text.
Bots adding short descriptions without manual supervision should set {{para|bot}} with the value being the bot task. For example [[Wikipedia:Bots/Requests for approval/PearBOT 5]] uses <code>|bot=PearBOT 5</code>. Any user may remove the parameter if the description is acceptable. If it's not please report it to the bot operator.
 
The bot name is added to the category. For example:
* {{clc|Category:Articles with short description added by PearBOT 5}}


== Maintenance categories ==
== Maintenance categories ==
* {{clc|Pages using short description with unknown parameters}}
* {{clc|Pages using short description with unknown parameters}}
* {{clc|Articles with long short description}}
* {{clc|Articles with long short description}}
* {{clc|Wikipedia pages with long short description‎}}
* {{clc|Wikipedia pages with long short description}}
* {{clc|Templates that generate short descriptions‎}}
* {{clc|Templates that generate short descriptions}}
* {{clc|Modules that create a short description}}
* {{clc|Modules that create a short description}}
* {{clc|Category:Short description matches Wikidata}}
* {{clc|Category:Short description matches Wikidata}}
Line 144: Line 152:


==See also ==
==See also ==
* {{tl|Auto short description}}
* {{tl|Auto short description}}
* {{tl|Annotated link}}
* [[Wikipedia:WikiProject Short descriptions]]
* [[Wikipedia:WikiProject Short descriptions]]



Latest revision as of 16:50, October 3, 2021

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.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Description1

The short description of the article or 'none'.

Example
Online free encyclopedia anyone can edit
Contentrequired
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
Stringoptional
pagetypepagetype

The type of page. This puts it in the appropriate category - Things with short description

Example
Redirect
Stringoptional

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

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

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.

Maintenance categories

See also