Nodyn:Short description/doc

Dyma is-ddalen dogfennaeth ar gyfer Nodyn:Short description.
Mae'n cynnwys gwybodaeth defnydd, categorïau, dolenni rhyngiaith a chynnwys eraill sydd ddim yn rhan o nodyn dudalen wreiddiol.

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

See the monthly parameter usage report for this template.

TemplateData for Short description

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

Paramedrau'r nodyn
This template has custom formatting.
Paramedr		Disgrifiad	Math	Statws
Description	`1`	The short description of the article. Enghraifft Online free encyclopedia anyone can edit	Cynnwys	angenrheidiol
2	`2`	Whether to override a short description if transcluded. Should be unused or 'noreplace'. Enghraifft noreplace	Llinyn	dewisol
pagetype	`pagetype`	The type of page. This puts it in the appropriate category - Things with short description Yn ddiofyn El espacio de nombres de la página. Enghraifft Redirect	Llinyn	dewisol
bot	`bot`	Name of bot which added the short description. Should be added by the editing bot, as in [[Special:Diff/925779924]] Enghraifft PearBOT 5	Llinyn	dewisol

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

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 Plymio sgwba (Q1096878) as an example:

{{short description/test|Underwater diving where breathing is from equipment independent of the surface}} → Nodyn:Short description/test
{{short description/test|none }} → Nodyn:Short description/test
{{short description/test|wikidata }} → Nodyn:Short description/test

Pagetype parameter

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

Category:Articles with short description (1)
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) Nodyn:-- for redirects in any namespace

If Nodyn:Param is set, then this template adds the article to a category matching the parameter. For example:

Category:Disambiguation pages with short description (0) Nodyn:-- pagetype = Disambiguation page

Aliases

Llwybr(au) brys: WP:SDNOALIASES

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.

Bot parameter

Bots adding short descriptions without manual supervision may optionally 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:

Category:Category:Articles with short description added by PearBOT 5 (0)