Template:Demo/doc

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:

  ✗ Fail

  
  ✗ Fail

Pre style

Set style= to add any CSS text to the <pre>...</pre> tag.

For example, {{demo|style=display:inline|<nowiki>{{done}}</nowiki>}}, 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
}}

{{Round2
|bold_winner=high
|May 1|Team A|1|Team B|2
}}

	Final
	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}}

Related pages

• {{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

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	{{User:Ahunt/SSHFS}}	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	{{hatnote|lang=fr|Some text}} Some text	Shows code and example
{{xpd|Hatnote|Some hatnote text}}	"{{hatnote|Some hatnote text}}" gives " Some hatnote text " [1]	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Hatnote	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	[[Template:Hatnote]] [[Template:Hatnote|Hatnote]]	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	{{#invoke:Example|hello}}	Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}}	{{#invoke:Example|hello}}	Counterpart to {{tlx}} for linking to Lua modules
{{para|title|<var>book title</var>}}	|title=book title	Formats template parameters for display, with or without values
{{sclx|LASTING}}	[[WP:LASTING]]	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
{{tag|ref}} {{xtag|templatedata}}	<ref>...</ref> <templatedata>	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	{{d:Ping project}}	Wikidata counterpart to {{tl}}
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	{{#if}} {{#if:{{{1}}}|true|false}}	Parser function equivalent to {{tl}}

No description.

Template parameters

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