Template:Template demo: Difference between revisions
mNo edit summary |
m (Updated documentation) |
||
Line 19: | Line 19: | ||
This template is designed to easily demo template usage and is intended for use within template documentation pages. It lets you display a set of template examples with the markup and rendered output displayed side-by-side. | This template is designed to easily demo template usage and is intended for use within template documentation pages. It lets you display a set of template examples with the markup and rendered output displayed side-by-side. | ||
== Usage == | |||
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. | ||
Line 54: | Line 55: | ||
{{Template demo | {{Template demo | ||
| style = list | | style = list | ||
| <nowiki>{{ | | <nowiki> | ||
{{Quote fancy | |||
| quote = The operations of these huge steel juggernauts are powered by engines of churning hellfire. | | quote = The operations of these huge steel juggernauts are powered by engines of churning hellfire. | ||
| image = Portrait Steel Watcher.png | | image = Portrait Steel Watcher.png | ||
| link = Adamantine Golem | | link = Adamantine Golem | ||
}}</nowiki> | }} | ||
| <nowiki>{{ | </nowiki> | ||
| <nowiki> | |||
{{Quote fancy | |||
| quote = These levitating eyes transmit all that they see to the one who created them. | | quote = These levitating eyes transmit all that they see to the one who created them. | ||
| image = Portrait Scrying Eye.png | | image = Portrait Scrying Eye.png | ||
Line 66: | Line 70: | ||
| rounding = 20% | | rounding = 20% | ||
| font-size = 100% | | font-size = 100% | ||
}}</nowiki> | }} | ||
</nowiki> | |||
}} | }} | ||
</pre> | </pre> | ||
Line 73: | Line 78: | ||
{{Template demo | {{Template demo | ||
| style = list | | style = list | ||
| <nowiki>{{ | | <nowiki> | ||
{{Quote fancy | |||
| quote = The operations of these huge steel juggernauts are powered by engines of churning hellfire. | | quote = The operations of these huge steel juggernauts are powered by engines of churning hellfire. | ||
| image = Portrait Steel Watcher.png | | image = Portrait Steel Watcher.png | ||
| link = Adamantine Golem | | link = Adamantine Golem | ||
}}</nowiki> | }} | ||
| <nowiki>{{ | </nowiki> | ||
| <nowiki> | |||
{{Quote fancy | |||
| quote = These levitating eyes transmit all that they see to the one who created them. | | quote = These levitating eyes transmit all that they see to the one who created them. | ||
| image = Portrait Scrying Eye.png | | image = Portrait Scrying Eye.png | ||
Line 85: | Line 93: | ||
| rounding = 20% | | rounding = 20% | ||
| font-size = 100% | | font-size = 100% | ||
}}</nowiki> | }} | ||
</nowiki> | |||
}} | }} | ||
Revision as of 19:10, 21 July 2024
This template is designed to easily demo template usage and is intended for use within template documentation pages. It lets you display a set of template examples with the markup and rendered output displayed side-by-side.
Usage
This template has two styles: a two-column table (style = table
) and a list (style = list
). The table is appropriate for shorter, inline templates. For larger templates, the list style may be preferred.
As with Template:Demo on Wikipedia, the arguments to this template must be wrapped in <nowiki>...</nowiki>
tags or the parameters with be expanded before being passed to this template.
Examples
Table style
Select this style with style = table
. It is also the default style used if the optional style parameter is omitted. This style should be used for shorter, inline templates that can fit nicely within a two-column table.
Input
{{Template demo | style = table | <nowiki>{{CharLink|Shadowheart}}</nowiki> | <nowiki>{{DamageText|2d4 + 1|Fire}}</nowiki> | <nowiki>{{RarityItem|Hat of Fire Acuity}}</nowiki> | <nowiki>{{SAI|Fireball}}</nowiki> }}
Output
Markup | Renders as |
---|---|
{{CharLink|Shadowheart}} | Shadowheart |
{{DamageText|2d4 + 1|Fire}} | 2d4 + 1Fire |
{{RarityItem|Hat of Fire Acuity}} | Hat of Fire Acuity |
{{SAI|Fireball}} |
List style
Select this style with style = list
. This should be used to demo templates too large to fit within a table.
Input
{{Template demo | style = list | <nowiki> {{Quote fancy | quote = The operations of these huge steel juggernauts are powered by engines of churning hellfire. | image = Portrait Steel Watcher.png | link = Adamantine Golem }} </nowiki> | <nowiki> {{Quote fancy | quote = These levitating eyes transmit all that they see to the one who created them. | image = Portrait Scrying Eye.png | link = Scrying Eye | height = 60px | rounding = 20% | font-size = 100% }} </nowiki> }}
Output
{{Quote fancy | quote = The operations of these huge steel juggernauts are powered by engines of churning hellfire. | image = Portrait Steel Watcher.png | link = Adamantine Golem }}Renders as
{{Quote fancy | quote = These levitating eyes transmit all that they see to the one who created them. | image = Portrait Scrying Eye.png | link = Scrying Eye | height = 60px | rounding = 20% | font-size = 100% }}Renders as
Template data
Display a list of template examples that displays the source wikitext and rendered result side-by-side. The template supports an arbitrary number of examples as unnamed arguments.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Example 1 | 1 | Example markup/wikitext to demo. | Content | optional |
Example 2 | 2 | Example markup/wikitext to demo. | Content | optional |
And so on... | 3... | Example markup/wikitext to demo. | Content | optional |
Style | style | Select the layout style appropriate for the template being demoed.
| String | optional |