Nwuan a̱tyin ka a li Ta‌̱mpi‌̱let:Demo/doc

{{Documentation subpage}}
{{Lua|Module:Demo}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
This template simply places template code in a {{tag|pre}} tag and then places the template below the pre tag.
<pre>
{{demo
|br =
|demo_kill_categories =
|&lt;nowiki>{{your template}}&lt;/nowiki>
}}
</pre>

'''{{red|IMPORTANT}}''': You must wrap include {{tag|nowiki}} tags around the source to be demonstrated (or use {{t|escape}}, which has a demo-escape example), like so:
<pre>{{demo|&lt;nowiki>[template source]</nowiki>}}</pre>

*Failure to wrap {{tag|nowiki}} tags around the source may cause the source to be executed before it reaches this template:{{demo|{{fail}}}}

=== Pre style ===
Set <code>style=</code> to add any CSS text to the {{tag|pre}} tag.

For example, <code>{{escape|mode=kill|{*{demo!style{{=}}display:inline!&lt;nowiki>{*{done}*}</nowiki>}*}|*|char=!|{{!}}}}</code>, would result in:


{{demo|style=display:inline|<nowiki>{{done}}</nowiki>}}

=== Line breaks ===
You can change the number of line breaks between the pre tag and the template by setting <code>br=</code> to a number. The default is 1.
<pre>{{demo|br=3|&lt;nowiki>{{done}}</nowiki>}}</pre>
{{demo|br=5|<nowiki>{{done}}</nowiki>}}


====Alternative separator====
You may also include an alternative separator by setting {{para|br}} to something other than a number and it will take the place of the br tags. For example, {{para|br|&lt;td>}} can make demo fit in a table:

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


=== Category removal ===
For templates that add categories (e.g. {{t|Asbox}}), set {{para|demo_kill_categories|}} (or {{para|nocat|}}) 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|br=0|<nowiki>
{{#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
}}</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_br}} instead of {{para|br}} (all args you don't want being passed should be prefixed with 'demo_' if not already)

== Redirects ==
* {{tl|Template Pre}}
* {{tl|Tpre}}
* {{tl|Doc pre}}

== 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 utility templates]]
[[Category:Wikitext processing templates]]
}}</includeonly>
<templatedata>
{
	"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"
		}
	}
}
</templatedata>