Template:Short description/doc - Revision history

Matt at 09:24, 16 April 2025

2025-04-16T09:24:07Z

← Older revision		Revision as of 05:24, 16 April 2025
Line 127:		Line 127:

	== Aliases ==		== Aliases ==
	~~{{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>, {{Strong\|they must not be used}}, for the reasons below:		While there are currently <span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Short_description\|hidetrans=1&hidelinks=1&limit=500}} redirects to this template]</span>, {{Strong\|they must not be used}}, for the reasons below:

Matt at 12:39, 14 April 2025

2025-04-14T12:39:31Z

← Older revision		Revision as of 08:39, 14 April 2025
Line 119:		Line 119:
	If is '''not''' set, then this template adds the article to a category based on the namespace:		If 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\|Redirects with short description}} ~~{{--}}~~ for redirects in any namespace		* {{clc\|Redirects with short description}} for redirects in any namespace

	If '''is''' set, then this template adds the article to a category matching the parameter. For example:		If '''is''' set, then this template adds the article to a category matching the parameter. For example:
	* {{cl\|Redirects with short description}} ~~{{--}}~~ {{code\|pagetype {{=}} Redirect }}		* {{cl\|Redirects with short description}} {{code\|pagetype {{=}} Redirect }}

	{{anchor\|No-aliases}}		{{anchor\|No-aliases}}

Matt at 21:34, 9 April 2025

2025-04-09T21:34:52Z

← Older revision		Revision as of 17:34, 9 April 2025
Line 2:		Line 2:
	{{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}}~~
	{{cascade-protected template}}		{{cascade-protected template}}
	{{Lua\|Module:Check for unknown parameters\|Module:String}}		{{Lua\|Module:Check for unknown parameters\|Module:String}}

Matt at 14:16, 9 April 2025

2025-04-09T14:16:40Z

← Older revision		Revision as of 10:16, 9 April 2025
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 ~~[[Wikipedia:Short description\|~~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.		'''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 [[WP:SDFORMAT]], along with the other guidance at [[WP:SDCONTENT]].		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 ~~[[WP:SDNONE\|~~short description is not needed]], use the following:		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 [[WP:HOWTOSD]]. General information can be found at [[Wikipedia: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 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 ~~[[d:Help:Description\|~~Wikidata:Help:Description]].)}}		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 [[Special:MyPage/common.css]]:		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 [[Template:Short description/test]] which displays its text by default.		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 ~~{{Q\|Q1096878}}~~ as an example:		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 ~~[[Wikipedia:Redirects for discussion/Log/2021 July 20#Aliases for Short description template\|~~RfD]].		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.

Matt at 09:49, 9 April 2025

2025-04-09T09:49:21Z

← Older revision		Revision as of 05:49, 9 April 2025
Line 108:		Line 108:
	</syntaxhighlight>		</syntaxhighlight>
	There is a test version of this template available as [[Template:Short description/test]] which displays its text by default.		There is a test version of this template available as [[Template:Short description/test]] which displays its text by default.
	* ~~{{tld\|Short description/test}}~~ displays the short description if supplied		* displays the short description if supplied
	* ~~{{tld\|Short description/test}}~~ displays nothing if <code>none</code> is supplied		* displays nothing if <code>none</code> is supplied
	* ~~{{tld\|Short description/test}}~~ displays the description from Wikidata if <code>wikidata</code> is supplied.		* displays the description from Wikidata if <code>wikidata</code> is supplied.

	Taking {{Q\|Q1096878}} as an example:		Taking {{Q\|Q1096878}} as an example:

Matt at 09:46, 9 April 2025

2025-04-09T09:46:59Z

← Older revision		Revision as of 05:46, 9 April 2025
Line 9:		Line 9:

	== Usage ==		== Usage ==
	~~{{tld\|Short description\|''Write your short description here''}}~~

	This should be limited to about 40 characters, as explained at [[WP:SDFORMAT]], along with the other guidance at [[WP:SDCONTENT]].		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 [[WP:SDNONE\|short description is not needed]], use the following:		If the page's title is sufficiently descriptive that a [[WP:SDNONE\|short description is not needed]], use the following:

	~~{{tld\|Short description\|none}}~~

	== Parameters ==		== Parameters ==
Line 91:		Line 87:

	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]].)}}		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 ===~~
	~~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}}

	== Testing ==		== Testing ==

Matt at 09:00, 9 April 2025

2025-04-09T09:00:49Z

← Older revision		Revision as of 05:00, 9 April 2025
Line 126:		Line 126:

	===Pagetype parameter===		===Pagetype parameter===
	If ~~{{param\|Pagetype}}~~ is '''not''' set, then this template adds the article to a category based on the namespace:		If 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\|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 '''is''' set, then this template adds the article to a category matching the parameter. For example:
	* {{cl\|Redirects with short description}} {{--}} {{code\|pagetype {{=}} Redirect }}		* {{cl\|Redirects with short description}} {{--}} {{code\|pagetype {{=}} Redirect }}

Line 157:		Line 157:
	* {{clc\|Articles with long short description}}		* {{clc\|Articles with long short description}}
	* {{clc\|Pages with lower-case short description}}		* {{clc\|Pages with lower-case short description}}

	~~== See also ==~~

	* {{tlx\|Auto short description}}
	* {{tlx\|Annotated link}}
	* {{tlx\|laal}} – displays an article's pagelinks alongside its short description
	* [[Module:Is infobox in lead]]
	* [[Wikipedia:Short descriptions]] – background information
	* [[Wikipedia:WikiProject Short descriptions]] – project to add Short descriptions to all articles

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Matt at 08:09, 9 April 2025

2025-04-09T08:09:57Z

← Older revision		Revision as of 04:09, 9 April 2025
Line 4:		Line 4:
	{{High risk}}		{{High risk}}
	{{cascade-protected template}}		{{cascade-protected template}}
	~~{{Warning\|'''Please do not use redirects/shortcuts for this template''', as they cause problems with the [[Wikipedia:Shortdesc helper\|short description editing gadget]] and other maintenance tools.}}~~
	{{Lua\|Module:Check for unknown parameters\|Module:String}}		{{Lua\|Module:Check for unknown parameters\|Module:String}}

Matt at 14:47, 8 April 2025

2025-04-08T14:47:54Z

← Older revision		Revision as of 10:47, 8 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	~~<noinclude>~~
	~~{{pp\|small=yes}}~~
	~~</noinclude>~~
	{{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]]) -->

Matt at 21:23, 5 March 2025

2025-03-05T21:23:44Z

← Older revision		Revision as of 17:23, 5 March 2025
Line 1:		Line 1:
			{{wikipedia\|page name}}
	<noinclude>		<noinclude>
	{{pp\|small=yes}}		{{pp\|small=yes}}

← Older revision		Revision as of 05:00, 9 April 2025
Line 126:		Line 126:

	===Pagetype parameter===		===Pagetype parameter===
	If ~~{{param\|Pagetype}}~~ is '''not''' set, then this template adds the article to a category based on the namespace:		If 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\|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 '''is''' set, then this template adds the article to a category matching the parameter. For example:
	* {{cl\|Redirects with short description}} {{--}} {{code\|pagetype {{=}} Redirect }}		* {{cl\|Redirects with short description}} {{--}} {{code\|pagetype {{=}} Redirect }}

Line 157:		Line 157:
	* {{clc\|Articles with long short description}}		* {{clc\|Articles with long short description}}
	* {{clc\|Pages with lower-case short description}}		* {{clc\|Pages with lower-case short description}}

	~~== See also ==~~

	* {{tlx\|Auto short description}}
	* {{tlx\|Annotated link}}
	* {{tlx\|laal}} – displays an article's pagelinks alongside its short description
	* [[Module:Is infobox in lead]]
	* [[Wikipedia:Short descriptions]] – background information
	* [[Wikipedia:WikiProject Short descriptions]] – project to add Short descriptions to all articles

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|