Template:Void/doc: Difference between revisions
| [checked revision] | [checked revision] |
Caleb Cooper (talk | contribs) Created page with "{{Documentation subpage}} {{Template shortcut|^|Nul|Null}} {{High-use}} {{Commons Import}} This template does nothing visually. Technically, it throws away its parameters and..." |
Caleb Cooper (talk | contribs) No edit summary |
||
| Line 7: | Line 7: | ||
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 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. Unlike "[[commenting out]]" with <code><nowiki><!-- --></nowiki></code>, it nests. This means that <code><nowiki>{{void|foo {{void|bar}} baz}}</nowiki></code> is valid, whereas <code><nowiki><!-- foo <!-- bar --> baz --></nowiki></code> will produce <code><!-- foo <!-- bar --> baz --></code>. |
It can also be used to temporarily disable code. Unlike "[[Wikipedia:commenting out|commenting out]]" with <code><nowiki><!-- --></nowiki></code>, it nests. This means that <code><nowiki>{{void|foo {{void|bar}} baz}}</nowiki></code> is valid, whereas <code><nowiki><!-- foo <!-- bar --> baz --></nowiki></code> will produce <code><!-- foo <!-- bar --> baz --></code>. |
||
It provides a particularly concise way of temporarily disabling ''templates'', by prefixing the template name with <code>^|</code>, making the template name becomes the (ignored) first unnamed parameter. For example, suppose you have a page {{tlx|Under construction}} for several days, and wish to change that to {{tlx|In use}} during active editing sessions. Rather than delete the unused template, you can leave both templates in the wikisource and change from <code><nowiki>{{^|In use|...}}{{Under construction|...}}</nowiki></code> to <code><nowiki>{{In use|...}}{{^|Under construction|...}}</nowiki></code>. |
It provides a particularly concise way of temporarily disabling ''templates'', by prefixing the template name with <code>^|</code>, making the template name becomes the (ignored) first unnamed parameter. For example, suppose you have a page {{tlx|Under construction}} for several days, and wish to change that to {{tlx|In use}} during active editing sessions. Rather than delete the unused template, you can leave both templates in the wikisource and change from <code><nowiki>{{^|In use|...}}{{Under construction|...}}</nowiki></code> to <code><nowiki>{{In use|...}}{{^|Under construction|...}}</nowiki></code>. |
||
| Line 16: | Line 16: | ||
==Alternatives== |
==Alternatives== |
||
{{Tl|Null}} also redirects here. It is also possible to use <code><nowiki>{{ns:0}}</nowiki></code>, the empty/void/null string for the main [[ |
{{Tl|Null}} also redirects here. It is also possible to use <code><nowiki>{{ns:0}}</nowiki></code>, the empty/void/null string for the main [[mediawikiwiki:Help:Namespace|namespace]]. |
||
It can be used in place of <code><nowiki><nowiki/></nowiki></code> to break character sequence parsing, for example <code><nowiki>{{nowrap|{''a''}{{null}}}}</nowiki></code> to force the first closing brace to be treated as part of the template parameter instead of as the end of the template expression. |
It can be used in place of <code><nowiki><nowiki/></nowiki></code> to break character sequence parsing, for example <code><nowiki>{{nowrap|{''a''}{{null}}}}</nowiki></code> to force the first closing brace to be treated as part of the template parameter instead of as the end of the template expression. |
||
Latest revision as of 19:11, 24 October 2020
 | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 |
This page was automatically imported from Commons any changes will be overwritten, the source page is here () |
This template does nothing visually. Technically, it throws away its parameters and outputs the null string.
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. 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, by prefixing the template name with ^|, making the template name becomes the (ignored) first unnamed parameter. For example, suppose you have a page {{Under construction}} for several days, and wish to change that to {{In use}} during active editing sessions. Rather than delete the unused template, you can leave both templates in the wikisource and change from {{^|In use|...}}{{Under construction|...}} to {{In use|...}}{{^|Under 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.
A deeper no-op is {{subst:void|foobar}} or {{subst:^|foobar}}. It disappears completely upon saving.
Alternatives
{{Template:Void}} also redirects here. 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/> to break character sequence parsing, for example {{nowrap|{''a''}{{null}}}} to force the first closing brace to be treated as part of the template parameter instead of as the end of the template expression.
TemplateData
TemplateData for Void/doc
A template to show the null string, i.e. nothing. Any parameters are accepted and ignored.
| Parameter | Description | Type | Status | |||
|---|---|---|---|---|---|---|
| No parameters specified | ||||||
See also
- Template:Nothing - a template that displays an invisible HTML tag
- Template:Text - a template that just displays its first parameter unchanged.