View source for Template:Demo/doc

<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Template redirect|Template Pre|Doc pre}}
{{Template shortcut|tpre}}
{{Lua|Module:Demo}}
This template simply places template code (or any other code) in a {{tag|syntaxhighlight|params=lang="wikitext"}} tag and then places the rendering of that code below.
<syntaxhighlight lang="wikitext">
{{demo|<nowiki>{{your template}}</nowiki>}}
</syntaxhighlight>

'''{{red|IMPORTANT:}}''' You must wrap {{tag|nowiki}} tags around the source to be demonstrated (or use {{t|escape}}, which has a demo-escape example), like so:
<syntaxhighlight lang="wikitext" inline>{{demo|<nowiki>[template source]</nowiki>}}</syntaxhighlight>

Failure to wrap {{tag|nowiki}} tags around the source may cause the source to be executed before it reaches this template.
<syntaxhighlight lang="wikitext" inline>{{demo|{{fail}}}}</syntaxhighlight> produces:
{{demo|{{fail}}}}

=== Pre style ===
Set {{para|style}} to add any CSS text to the {{tag|pre}} tag.

For example, <syntaxhighlight lang="wikitext" inline>{{demo|style=margin-left: 1.6em;|<nowiki>{{done}}</nowiki>}}</syntaxhighlight> will produce:

{{demo|style=margin-left: 1.6em;|<nowiki>{{done}}</nowiki>}}

=== Separator ===
You can change the separator between the {{tag|syntaxhighlight|o}} and the template by setting the {{para|sep}} parameter.
<syntaxhighlight lang="wikitext">{{demo|sep=produces|<nowiki>{{done}}</nowiki>}}</syntaxhighlight>
{{demo|sep=produces|<nowiki>{{done}}</nowiki>}}

You may use {{para|sep|&lt;td>}} can make the demonstration fit in a table:

{| border="1"
|-
|{{demo|br=<td>|{{((}}done{{))}}}}
|}

Instead of using {{para|sep}}, you can also specify the number of line breaks between the code and the template in the {{para|br}} parameter.

=== Reverse order ===
Use {{para|reverse|1}} to show the code snippet and the result in reverse order:
<syntaxhighlight lang="wikitext">{{demo|reverse=1|<nowiki>{{tl|template}}</nowiki>}}</syntaxhighlight>

will produce

{{demo|reverse=1|<nowiki>{{tl|template}}</nowiki>}}

=== Category removal ===
For templates that add categories (e.g. {{t|Asbox}}), set {{para|nocat}} (or {{para|demo_kill_categories}}) to anything to prevent them from showing up in the output:
{{demo|br=produces:|demo_kill_categories=yes
|<nowiki>{{Asbox
| image = Østfold_våpen.svg
| pix = 30
| subject = [[Østfold]] location
| name = Template:Østfold-geo-stub
| category = Østfold geography stubs
| tempsort = *
}}
</nowiki>}}

=== Module ===
If the template used is based on [[Lua (programming language)|Lua]], you can pass args directly to the demonstrated module by invoking [[Module:Demo]] like so: (this would reduce server stress)
{{demo|<nowiki>
{{#invoke:Demo|module|demo_module=RoundN|demo_module_func=N2|demo_template=Round2
|bold_winner=high
|May 1|Team A|1|Team B|2
}}</nowiki>}}

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 {{para|demo_sep}} instead of {{para|sep}} (all args you don't want being passed should be prefixed with <code>demo_</code> if not already)

== TemplateData ==
{{TemplateData header}}


<templatedata>
{
	"params": {
		"1": {
			"label": "Content",
			"description": "must be wrapped in <nowiki>"
		},
		"sep": {
			"description": "Number of line breaks, or wikitext to fill in as the linebreak"
		},
		"nocat": {
			"type": "boolean",
			"aliases": [
				"demo_kill_categories"
			]
		},
		"result_arg": {},
		"style ": {
			"label": "<syntaxhighlight> style"
		},
		"reverse": {
			"label": "Reverse order",
			"description": "Show the code snippet and the result in reverse order",
			"type": "boolean",
			"default": "0",
			"autovalue": "1"
		}
	}
}
</templatedata>

== See also==
* {{tl|Demo-inline}}, for an inline version of this template
* {{tl|Escape}} - which has an example of this template without nowiki tags
* {{tl|Nowiki template demo}} which uses [[Module:Template test case]]
* {{tl|Automarkup}} which uses [[Module:Automarkup]]

===Other formatting templates===
{{#lsth:Template:Template-linking_templates|Other formatting templates}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Documentation assistance templates]]
[[Category:Programming typing-aid templates]]
[[Category:Template test cases| ]]
[[Category:Wikipedia formatting templates]]
[[Category:Wikitext processing templates]]
}}</includeonly>