Template:Demo/doc
This is a documentation subpage for Template:Demo. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
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:Template:Fail
Template:Fail
Pre style
Set style=
to add any CSS text to the <pre>...</pre>
tag.
For example, Script error: No such module "Escape".
, would result in:
{{done}}
Done
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>}}
{{done}}
Done
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:
{{done}} | Done |
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 = * }}
produces:
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 }}
Lua error in package.lua at line 80: module 'Module:RoundN' not found.
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}}
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Content | 1 | must be wrapped in <nowiki> | Unknown | optional |
Br | br | Number of line breaks, or wikitext to fill in as the linebreak | Unknown | optional |
Demo_kill_categories | demo_kill_categories nocat | no description | Boolean | optional |
Result_arg | result_arg | no description | Unknown | optional |
<pre> style | style | no description | Unknown | optional |