Template:Template short description/doc

From The Global Wiki
< Template:Template short description
Revision as of 01:03, 19 January 2023 by Ofngv (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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").