More actions
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
{{Lua|Module:Check for unknown parameters|Module:String}} | {{Lua|Module:Check for unknown parameters|Module:String}} | ||
''' | '''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 == | == Usage == | ||
This should be limited to about 40 characters, as explained at | This should be limited to about 40 characters, as explained at WP:SDFORMAT, along with the other guidance at WP:SDCONTENT. | ||
If the page's title is sufficiently descriptive that a | If the page's title is sufficiently descriptive that a short description is not needed, use the following: | ||
== Parameters == | == Parameters == | ||
| Line 72: | Line 72: | ||
== About writing good short descriptions == | == About writing good short descriptions == | ||
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 | 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 86: | Line 86: | ||
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. | 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. | ||
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 | 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 Wikidata:Help:Description.)}} | ||
== Testing == | == Testing == | ||
For testing purposes, the display of this template can be enabled by adding a line to your | 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> | * <syntaxhighlight lang="CSS" inline>.shortdescription { display:block !important; }</syntaxhighlight> | ||
This can be easily removed or disabled when testing is finished. | This can be easily removed or disabled when testing is finished. | ||
| Line 107: | Line 107: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
There is a test version of this template available 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 the short description if supplied | ||
* displays nothing if <code>none</code> is supplied | * displays nothing if <code>none</code> is supplied | ||
* displays the description from Wikidata if <code>wikidata</code> is supplied. | * displays the description from Wikidata if <code>wikidata</code> is supplied. | ||
Taking | Taking as an example: | ||
* <code><nowiki>{{short description/test|Underwater diving where breathing is from equipment independent of the surface}}</nowiki></code> → {{short description/test|Underwater diving where breathing is from equipment independent of the surface }} | * <code><nowiki>{{short description/test|Underwater diving where breathing is from equipment independent of the surface}}</nowiki></code> → {{short description/test|Underwater diving where breathing is from equipment independent of the surface }} | ||
* <code><nowiki>{{short description/test|none}}</nowiki></code> → {{short description/test|none}} | * <code><nowiki>{{short description/test|none}}</nowiki></code> → {{short description/test|none}} | ||
| Line 134: | Line 134: | ||
:* For example, {{tl|Annotated link}} searches for the template in its uppercase "Short description" and lowercase form "short description"; either form is acceptable. | :* For example, {{tl|Annotated link}} searches for the template in its uppercase "Short description" and lowercase form "short description"; either form is acceptable. | ||
See related | See related RfD. | ||
{{Strong|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. | {{Strong|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. | ||
Revision as of 10:16, 9 April 2025
| This page uses Creative Commons Licensed content from Wikipedia (view authors). |
 | This is a documentation subpage for Template:Short description It may contain usage information, categories and other content that is not part of the original template page. |
 | This template can only be edited by administrators because it is transcluded onto one or more cascade-protected pages. |
 | This template uses Lua: |
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.
If the page's title is sufficiently descriptive that a short description is not needed, use the following:
Parameters
TemplateData for Short description
Creates a short description for a Wikipedia page, which is displayed in search results and other locations.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Description | 1 | The short description of the article or 'none'. It should be limited to about 40 characters.
| 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.
| 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.
| 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.
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 testing is finished.
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.
- displays the short description if supplied
- displays nothing if
noneis supplied - displays the description from Wikidata if
wikidatais supplied.
Taking as an example:
{{short description/test|Underwater diving where breathing is from equipment independent of the surface}}→{{short description/test|none}}→{{short description/test|wikidata}}→
Pagetype parameter
If is not set, then this template adds the article to a category based on the namespace:
- Category:Articles with short description (217)
- Category:Redirects with short description (0) Template:-- for redirects in any namespace
If is set, then this template adds the article to a category matching the parameter. For example:
- Category:Redirects with short description Template:--
pagetype = Redirect
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"; either form is acceptable.
See related RfD.
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 (4)
- 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 (7)
- Category:Pages with lower-case short description (0)