This
documentation is
transcluded from
Template:Demo/doc.
(Edit | history)
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.
Usage
This template simply places template code in a
<pre>...</pre>
tag and then places the template below the pre tag.
{{demo
|br =
|demo_kill_categories =
|<nowiki>{{your template}}</nowiki>
}}
IMPORTANT: You must wrap include <nowiki>...</nowiki>
tags around the source to be demonstrated (or use {{Escape}}, which has a demo-escape example), like so:
{{demo|<nowiki>[template source]</nowiki>}}
- Failure to wrap
<nowiki>...</nowiki>
tags around the source may cause the source to be executed before it reaches this template:
Pre style
Set
style=
to add any CSS text to the
<pre>...</pre>
tag.
For example,
Template:Escape
, would result in:
Line breaks
You can change the number of line breaks between the pre tag and the template by setting
br=
to a number. The default is 1.
{{demo|br=3|<nowiki>{{done}}</nowiki>}}
Alternative separator
You may also include an alternative separator by setting
|br = to something other than a number and it will take the place of the br tags. For example,
|br = <td> can make demo fit in a table:
Category removal
For templates that add categories (e.g.
{{Asbox}}), set
|demo_kill_categories = (or
|nocat = ) to anything to prevent them from showing up in the output:
{{Asbox
| image = Ăstfold_vĂ„pen.svg
| pix = 30
| subject = [[Ăstfold]] location
| name = Template:Ăstfold-geo-stub
| category = Ăstfold geography stubs
| tempsort = *
}}
|
{{Asbox
| image = Ăstfold_vĂ„pen.svg
| pix = 30
| subject = [[Ăstfold]] location
| name = Template:Ăstfold-geo-stub
| category = Ăstfold geography stubs
| tempsort = *
}}
|
Module
If the template used is based on
Lua, you can pass args directly to the demonstrated module by invoking
Module:Demo like so: (this would reduce server stress)
{{#invoke:Demo|module|demo_br=0| demo_module=RoundN | demo_module_func = N2|demo_template = Round2
|bold_winner=high
|May 1|Team A|1|Team B|2
}} |
{{#invoke:Demo|module|demo_br=0| demo_module=RoundN | demo_module_func = N2|demo_template = Round2
|bold_winner=high
|May 1|Team A|1|Team B|2
}}
|
Note: It will attempt to preserve line breaks for unnamed params, but such is impossible for named params since those are stripped of whitespace/order before being passed to the module. Also note, you should use
|demo_br = instead of
|br = (all args you don't want being passed should be prefixed with 'demo_' if not already)
Redirects
* {{
Template Pre}}
* {{
Tpre}}
* {{
Doc pre}}
See also
* {{
Demo-inline}}, for an inline version of this template
* {{
Escape}} - which has an example of this template without nowiki tags
* {{
Nowiki template demo}} which uses
Module:Template test case
* {{
Automarkup}} which uses
Module:Automarkup
Other formatting templates
{{#lsth:Template:Template-linking_templates|Other formatting templates}}
{
"params": {
"1": {
"label": "Content",
"description": "must be wrapped in <nowiki>"
},
"br ": {
"description": "Number of line breaks, or wikitext to fill in as the linebreak"
},
"demo_kill_categories": {
"type": "boolean",
"aliases": [
"nocat"
]
},
"result_arg": {},
"style ": {
"label": "<pre> style"
}
}
}