Template:Void/doc
This template does nothing visually. Technically, it throws away its parameters and outputs the null string.
Usage
{{ void | ... }}
Use cases
It is useful for programming advanced templates, and is often used within a template to the right of an equals sign. It may also be used in a template to disambiguate parsing of braces.
It can also be used to temporarily disable code, and unlike "commenting out" with <!-- -->
, it nests. This means that {{void|foo {{void|bar}} baz}}
is valid, whereas <!-- foo <!-- bar --> baz -->
will produce baz -->
.
It provides a particularly concise way of temporarily disabling templates, so the template name becomes the (ignored) first unnamed parameter. For example, suppose you have a page under {{{{#uesc:construction}}{{#or:|}}}} for several days, and wish to remove that template between active editing sessions. Rather than delete the unused template, you can leave it in the wikisource and change from {{construction|...}}
to {{void|construction|...}}
.
Another possible application would be to temporarily disable an infobox on an article page while a problem with the infobox template itself is resolved.
Furthermore, the template can be [[wikipedia:{{#uesc:<esc>{{#or:{{#lstfnd:doc|ar, bg, cs, da, el, es, fi, hi, id, it, ja, lt, lv, nl, no, ro, sk, sv, th, tr, vi, yue,de, fr, hu, ko, ru, pl, pt, uk, zh, es-formal|,}}|en}}</esc>}}:WP:Substitution|substituted]]: {{subst:void}}
. This saves (and effectively purges) the page without saving a record in the page history, similar to a null edit, which is particularly useful for bots.
Alternatives
It is also possible to use {{ns:0}}
, the empty/void/null string for the main namespace.
It can be used in place of <nowiki/>
tags to break character sequence parsing, for example {{{{#uesc:green}}{{#or:||{''a''}{{{{#uesc:void}}{{#or:|}}}}}}}}
to force the first closing brace to be treated as part of the template parameter instead of as the end of the template expression.
Examples
Code | Result |
---|---|
{{void}} |
|
A{{void|B|C|D}}E |
AE |
{{green|{''a''}}} |
{a} |
{{green|{''a''}{{void}}}} |
{a} |
See also
- The original template on Wikipedia: [[wikipedia:{{#uesc:<esc>{{#or:{{#lstfnd:doc|ar, bg, cs, da, el, es, fi, hi, id, it, ja, lt, lv, nl, no, ro, sk, sv, th, tr, vi, yue,de, fr, hu, ko, ru, pl, pt, uk, zh, es-formal|,}}|en}}</esc>}}:Template:Void|Template:Void]]
{{category/db-{{#or:{{#lstfnd:doc|ar, bg, cs, da, el, es, fi, hi, id, it, ja, lt, lv, nl, no, ro, sk, sv, th, tr, vi, yue,de, fr, hu, ko, ru, pl, pt, uk, zh, es-formal|,}}|en}}}}[[Category:{{#or:|Lua error in package.lua at line 80: module 'Module:Tr/loaddata-{{#or:{{#lstfnd:doc|ar, bg, cs, da, el, es, fi, hi, id, it, ja, lt, lv, nl, no, ro, sk, sv, th, tr, vi, yue,de, fr, hu, ko, ru, pl, pt, uk, zh, es-formal|,}}|en}}' not found.{{#or:|Template documentation}}}} ]]