Wiktenauer logo.png

Template:Strip whitespace/doc

From Wiktenauer
< Template:Strip whitespace
Revision as of 03:03, 23 September 2012 by Michael Chidester (talk | contribs) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This is a simple little template, for use in other templates to strip any trailing and/or leading whitespace from unnamed parameters.

In MediaWiki templates, trailing and/or leading whitespace is automatically removed from named parameters, but not from unnamed parameters. (Thus we can choose whether this removal is applied, but the choice cannot be made independently of the choice to use named or unnamed parameters. This is apparently some ancient design mistake with which we are now stuck forevermore, in the name of backward-compatibility.[1])

Usage

The template takes either a parameter, "x", or one unnamed parameter. The value should be numbered parameter from which the whitespace is to be removed. Do not substitute this template - that is, if used as {{subst:strip whitespace}}, the resulting wikicode is not "clean".

e.g. {{strip whitespace | x = {{{1|}}} }}

or e.g. {{strip whitespace | {{{4|}}} }}

Notes
  1. Unfortunately the reverse, avoiding the removal of whitespace while using a named parameter, is not possible.

See also

  • {{Trim}}, which does nearly the exact same thing, but which may be substituted.