Template:Short description: Difference between revisions
meta>TheDJ (Add classes for marking content to be best effort hidden from print, text extracts and mobile) |
meta>RexxS (add tracking category to list articles with short descriptions) |
||
| Line 1: | Line 1: | ||
<span class="shortdescription nomobile noexcerpt noprint" style="display:none">{{{1|}}}</span><noinclude> | <span class="shortdescription nomobile noexcerpt noprint" style="display:none">{{{1|}}}</span><noinclude> | ||
<!-- to implement this, set the class to display:none and remove the inline style here --> | <!-- to implement this, set the class to display:none and remove the inline style here --> | ||
{{main other|[[Category:Articles with short descriptions]]|}} | |||
{{documentation}}</noinclude> | {{documentation}}</noinclude> | ||
Revision as of 18:39, 11 December 2017
 | This template is used on 2,530,000+ pages, or roughly 38426% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | Please do not use redirects/shortcuts for this template, as they cause problems with the short description editing gadget and other maintenance tools. |
Template:Short description is used to add a short description (which can be edited from within Wikipedia) to a Wikipedia page.
Usage
{{Short description|Write your short description here}}
Parameters
TemplateData for Short description
Creates a short description for a Wikipedia article, which is used in the Visual Editor to provide context on wikilinks.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Description | 1 | The short description of the article
| Content | required |
| 2 | 2 | Whether to override a short description if transcluded. Should be unused or 'noreplace'.
| String | optional |
| pagetype | pagetype | The type of page. This puts it in the appropriate category - Things with short description
| String | optional |
| bot | bot | Name of bot which added the short description. Should be generated automatically, as in [[Special:Diff/925779924]]
| 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. 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 how to write a good 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 required in other namespaces, but in some cases may be 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. 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. 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.
Example
At Oxygen therapy, add the following at the top of the article:
{{Short description|Use of oxygen as medical treatment}}
or
{{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 {{annotated link}} (T216356, if implemented, will make usage of annotated link unnecessary.)
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 wish to always see short descriptions, you may want 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 ifnoneis supplied{{Short description/test}}displays the description from Wikidata ifwikidatais 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}}→{{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:
- Category:Articles with short description (28)
- Category:Books with short description (0)
- Category:Categories with short description (0)
- Category:Drafts with short description (0)
- Category:Files with short description (0)
- Category:Help pages with short description (0)
- Category:Modules with short description (0)
- Category:Portals with short description (0)
- Category:Project pages with short description (0)
- Category:Templates with short description (0)
- Category:User pages with short description (0)
- Category:Redirects with short description (0) — for redirects in any namespace
If {{{Pagetype}}} is set, then this template adds the article to a category matching the parameter. For example:
- Category:Disambiguation pages with short description (0) — <syntaxhighlight lang="text" class="" id="" style="" inline="1">pagetype = Disambiguation page</syntaxhighlight>
Aliases
While there are redirects to this template, they should 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".
Bot parameter
Bots adding short descriptions without manual supervision should set |bot= with the value being the bot task. For example Wikipedia:Bots/Requests for approval/PearBOT 5 uses |bot=PearBOT 5. 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:
Maintenance categories
- Category:Pages using short description with unknown parameters (0)
- Category:Articles with long short description (1)
- Category:Wikipedia pages with long short description (0)
- 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)
