Template:Template demo: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
(Completed move)
(Updated documentation)
Line 26: Line 26:
=== Table style ===
=== Table style ===
Select this style with <code>style = table</code>. 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.
Select this style with <code>style = table</code>. 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 ====
<!-- Can't recursively use this template to demo itself. Sad --->
<pre>
{{Template demo
| style = table
| &lt;nowiki>{{CharLink|Shadowheart}}</nowiki>
| &lt;nowiki>{{DamageText|2d4 + 1|Fire}}</nowiki>
| &lt;nowiki>{{RarityItem|Hat of Fire Acuity}}</nowiki>
| &lt;nowiki>{{SAI|Fireball}}</nowiki>
}}
</pre>
==== Output ====
{{Template demo
{{Template demo
| style = table
| style = table
| <nowiki>{{CharLink|Shadowheart}}</nowiki>
| <nowiki>{{CharLink|Shadowheart}}</nowiki>
| <nowiki>{{DamageText|2d4 + 1|Fire}}</nowiki>
| <nowiki>{{DamageText|2d4 + 1|Fire}}</nowiki>
| <nowiki>{{RarityItem|Hat of Fire Acuity}}</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.
<!-- Can't recursively use this template to demo itself. Sad --->
<pre>
{{Template demo
| style = list
| &lt;nowiki>{{ImageQuote
| quote = The operations of these huge steel juggernauts are powered by engines of churning hellfire.
| image = Portrait Steel Watcher.png
| link = Adamantine Golem
}}</nowiki>
| &lt;nowiki>{{ImageQuote
| 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>
}}
</pre>
==== Output ====
==== Output ====
{{Template demo
{{Template demo
| style = list
| style = list
| <nowiki>
| <nowiki>{{ImageQuote
{{ImageQuote
| 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>{{ImageQuote
| <nowiki>
{{ImageQuote
| 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 52: Line 84:
| rounding = 20%
| rounding = 20%
| font-size = 100%
| font-size = 100%
}}
}}</nowiki>
</nowiki>
}}
}}
</noinclude>
</noinclude>

Revision as of 22:52, 19 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.

This template has two styles: a two-column table (style = table) and a list (style = list). The table is appropriate 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 Shadowheart
{{DamageText|2d4 + 1|Fire}} 2d4 + 1Damage TypesFire
{{RarityItem|Hat of Fire Acuity}} Hat of Fire Acuity
{{SAI|Fireball}} Fireball Fireball

List style

Select this style with style = list. This should be used to demo templates too large to fit within a table.

{{Template demo
| style = list
| <nowiki>{{ImageQuote
| 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>{{ImageQuote
| 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

Markup
{{ImageQuote
| 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
Portrait Steel Watcher.png
The operations of these huge steel juggernauts are powered by engines of churning hellfire.
Markup
{{ImageQuote
| 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
Portrait Scrying Eye.png
These levitating eyes transmit all that they see to the one who created them.