12,170
edits
m
no edit summary
mNo edit summary |
mNo edit summary |
||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<includeonly>{{# | <includeonly>{{#lvardef: i | 1 }}{{#switch:{{{style|table}}} | ||
| table = <table class="wikitable"> | | table = <table class="wikitable"> | ||
<tr> | <tr> | ||
<!-- TODO: Improve the logic for determining if the table should have a caption column --> | |||
{{#if: {{{caption 1|}}}|<th>Example</th>}} | |||
<th>Markup</th> | <th>Markup</th> | ||
<th>Renders as</th> | <th>Renders as</th> | ||
</tr> | </tr> | ||
{{#while: | {{#while: | ||
| {{{{{# | | {{{{{#lvar: i }} |}}} | ||
| <tr><td>{{Demo|sep=</td><td>|nocat=yes|tag=pre|style=margin:0px;border:0px;|{{trim|{{{ {{# | | <tr> | ||
{{# | {{#if:{{{caption {{#lvar: i }}|}}}|<th>{{{caption {{#lvar: i }}|}}}</th>}} | ||
<td>{{Demo|sep=</td><td>|nocat=yes|tag=pre|style=margin:0px;border:0px;|{{trim|{{{ {{#lvar: i}} }}}}}}}</td> | |||
</tr> | |||
{{#lvardef: i | {{#expr: {{#lvar: i }} + 1 }} }} | |||
}}</table> | }}</table> | ||
| list = {{#while: | | list = {{#while: | ||
| {{{{{# | | {{{{{#lvar: i }} |}}} | ||
| <div class="bg3wiki-tooltip-box>{{#if:{{{caption {{# | | <div class="bg3wiki-tooltip-box>{{#if:{{{caption {{#lvar: i}}|}}}|<p>{{{caption {{#lvar: i}}|}}}</p>}}'''Markup'''{{Demo|sep='''Renders as<br>'''|nocat=yes|style=margin-top:0px;|tag=pre|{{trim|{{{ {{#lvar: i}} }}}}}}}</div> | ||
{{# | {{#lvardef: i | {{#expr: {{#lvar: i }} + 1 }} }} | ||
}} | }} | ||
| #default = Unknown style option <code>{{{style|}}}</code>. Expected <code>table</code> (default) or <code>list</code>. | | #default = Unknown style option <code>{{{style|}}}</code>. Expected <code>table</code> (default) or <code>list</code>. | ||
Line 22: | Line 27: | ||
This template has two styles: a two-column table (<code>style = table</code>) and a list (<code>style = list</code>). The table is appropriate for shorter, inline templates. For larger templates, the list style may be preferred. | This template has two styles: a two-column table (<code>style = table</code>) and a list (<code>style = list</code>). The table is appropriate for shorter, inline templates. For larger templates, the list style may be preferred. | ||
As with | As with {{Wikipedia|Template:Demo}}, the arguments to this template {{em|must}} be wrapped in <code><nowiki><nowiki>...</nowiki</nowiki><nowiki>></nowiki></code> tags or the parameters will be expanded before being passed to this template. | ||
== Examples == | == Examples == | ||
Line 45: | Line 50: | ||
| <nowiki>{{DamageText|2d4 + 1|Fire}}</nowiki> | | <nowiki>{{DamageText|2d4 + 1|Fire}}</nowiki> | ||
| <nowiki>{{RarityItem|Hat of Fire Acuity}}</nowiki> | | <nowiki>{{RarityItem|Hat of Fire Acuity}}</nowiki> | ||
| <nowiki>{{SAI|Fireball}}</nowiki> | |||
}} | |||
=== Table style with captions === | |||
If you want to add captions to the examples, you can do so with {{c|caption <number>}} parameters. This switches to a 3 column layout. | |||
==== Input ==== | |||
<!-- Can't recursively use this template to demo itself. Sad ---> | |||
<pre> | |||
{{Template demo | |||
| style = table | |||
| caption 1 = CharLink demo | |||
| <nowiki>{{CharLink|Shadowheart}}</nowiki> | |||
| caption 2 = DamageText demo | |||
| <nowiki>{{DamageText|2d4 + 1|Fire}}</nowiki> | |||
| caption 3 = RarityItem demo | |||
| <nowiki>{{RarityItem|Hat of Fire Acuity}}</nowiki> | |||
| caption 4 = SAI demo | |||
| <nowiki>{{SAI|Fireball}}</nowiki> | |||
}} | |||
</pre> | |||
==== Output ==== | |||
{{Template demo | |||
| style = table | |||
| caption 1 = CharLink demo | |||
| <nowiki>{{CharLink|Shadowheart}}</nowiki> | |||
| caption 2 = DamageText demo | |||
| <nowiki>{{DamageText|2d4 + 1|Fire}}</nowiki> | |||
| caption 3 = RarityItem demo | |||
| <nowiki>{{RarityItem|Hat of Fire Acuity}}</nowiki> | |||
| caption 4 = SAI demo | |||
| <nowiki>{{SAI|Fireball}}</nowiki> | | <nowiki>{{SAI|Fireball}}</nowiki> | ||
}} | }} | ||
=== List style === | === List style === | ||
Select this style with <code>style = list</code>. This should be used to demo templates too large to fit within a table. | Select this style with <code>style = list</code>. This should be used to demo templates too large to fit within a table. You can also optionally caption the examples as with the table style. | ||
<!-- Can't recursively use this template to demo itself. Sad ---> | <!-- Can't recursively use this template to demo itself. Sad ---> | ||
==== Input ==== | ==== Input ==== | ||
Line 62: | Line 98: | ||
}} | }} | ||
</nowiki> | </nowiki> | ||
| caption 2 = | | caption 2 = This example demonstrates many of the optional style parameters. | ||
| <nowiki> | | <nowiki> | ||
{{Quote fancy | {{Quote fancy | ||
Line 86: | Line 122: | ||
}} | }} | ||
</nowiki> | </nowiki> | ||
| caption 2 = | | caption 2 = This example demonstrates many of the optional style parameters. | ||
| <nowiki> | | <nowiki> | ||
{{Quote fancy | {{Quote fancy | ||
Line 128: | Line 164: | ||
"caption 1": { | "caption 1": { | ||
"label": "Example 1 caption", | "label": "Example 1 caption", | ||
"description": "An additional caption or title for the example if you want to add additional context | "description": "An additional caption or title for the example if you want to add additional context.", | ||
"example": "This example demos the {{c|style}} optional parameter.", | "example": "This example demos the {{c|style}} optional parameter.", | ||
"type": "string", | "type": "string", | ||
Line 135: | Line 171: | ||
"caption 2": { | "caption 2": { | ||
"label": "Example 2 caption", | "label": "Example 2 caption", | ||
"description": "An additional caption or title for the example if you want to add additional context | "description": "An additional caption or title for the example if you want to add additional context.", | ||
"example": "This example demos the {{c|style}} optional parameter.", | "example": "This example demos the {{c|style}} optional parameter.", | ||
"type": "string", | "type": "string", | ||
Line 142: | Line 178: | ||
"caption 3": { | "caption 3": { | ||
"label": "And so on...", | "label": "And so on...", | ||
"description": "An additional caption or title for the example if you want to add additional context | "description": "An additional caption or title for the example if you want to add additional context.", | ||
"example": "This example demos the {{c|style}} optional parameter.", | "example": "This example demos the {{c|style}} optional parameter.", | ||
"type": "string", | "type": "string", |