Template:Template demo: Difference between revisions
m (Removed outdated caption notes) |
mNo edit summary |
||
Line 27: | 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 {{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 | 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 == |
Latest revision as of 01:32, 5 November 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, the arguments to this template must be wrapped in <nowiki>...</nowiki>
tags or the parameters will 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}} |
If you want to add captions to the examples, you can do so with caption <number>
parameters. This switches to a 3 column layout.
Input
{{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> }}
Output
Example | Markup | Renders as |
---|---|---|
CharLink demo | {{CharLink|Shadowheart}} | Shadowheart |
DamageText demo | {{DamageText|2d4 + 1|Fire}} | 2d4 + 1Fire |
RarityItem demo | {{RarityItem|Hat of Fire Acuity}} | Hat of Fire Acuity |
SAI demo | {{SAI|Fireball}} |
List style
Select this style with style = list
. 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.
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> | caption 2 = This example demonstrates many of the optional style parameters. | <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
This example demonstrates many of the optional style parameters.
Markup{{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. This parameter must be surrounded by <nowiki> tags to work correctly.
| Content | optional |
Example 2 | 2 | Example markup/wikitext to demo. This parameter must be surrounded by <nowiki> tags to work correctly.
| Content | optional |
And so on... | 3 | Example markup/wikitext to demo. This parameter must be surrounded by <nowiki> tags to work correctly.
| Content | optional |
Example 1 caption | caption 1 | An additional caption or title for the example if you want to add additional context.
| String | optional |
Example 2 caption | caption 2 | An additional caption or title for the example if you want to add additional context.
| String | optional |
And so on... | caption 3 | An additional caption or title for the example if you want to add additional context.
| String | optional |
Style | style | Select the layout style appropriate for the template being demoed.
| String | optional |