Template:Template short description/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 22:11, 25 April 2021

This is a documentation subpage for Template:Template short description.
It may contain usage information, categories and other content that is not part of the original template page.

Template:Template short description is used to create templated short description. It performs extra checks to avoid undesirable short descriptions from being added by templates and if the following conditions are satisfied it will add the first unnamed parameter as a short description:

There is no {{Short description}} template on the page
The description is at or below a certain length (default 40 per WP:SDFORMAT, adjustable with |max_length= if determined necessary. It is often preferable to attempt shortening the descriptions if this is a major issue.)
If the template is an infobox it can also check if the infobox is in the lead. If no pattern is given this condition is ignored. It does not handle redirects.

Parameters

Parameter	Explanation
`text`	The short description text.
`max_length`	The number of characters the short description is allowed to be (non-inclusive).
`infobox_pattern`	A lua pattern matching the template name (such as "[Ii]nfobox [Ss]chool").

@@ Line 3: / Line 3: @@
 '''Template:Template short description''' is used to create templated short description. It performs extra checks to avoid undesirable short descriptions from being added by templates and if the following conditions are satisfied it will add the first unnamed parameter as a short description:
 * There is no {{tl|Short description}} template on the page
-* The description is under a certain length (default 40 per [[WP:SDFORMAT]], adjustable with {{para|max_length}} if determined necessary. It is often preferable to attempt shortening the descriptions if this is a major issue.)
+* The description is at or below a certain length (default 40 per [[WP:SDFORMAT]], adjustable with {{para|max_length}} if determined necessary. It is often preferable to attempt shortening the descriptions if this is a major issue.)
 * If the template is an infobox it can also check if the infobox is in the lead. If no pattern is given this condition is ignored. It does not handle redirects.