Template:Template demo: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
m (Added linebreak in the list style output)
m (Updated documentation)
Line 105: Line 105:
"1": {
"1": {
"label": "Example 1",
"label": "Example 1",
"description": "Example markup/wikitext to demo.",
"description": "Example markup/wikitext to demo. This parameter must be surrounded by <nowiki> tags to work correctly.",
            "example": "<nowiki>{{SAI|Fire Bolt}}</nowiki>",
             "type": "content",
             "type": "content",
"required": false
"required": false
Line 111: Line 112:
         "2": {
         "2": {
"label": "Example 2",
"label": "Example 2",
"description": "Example markup/wikitext to demo.",
"description": "Example markup/wikitext to demo. This parameter must be surrounded by <nowiki> tags to work correctly.",
            "example": "<nowiki>{{SAI|Fire Bolt}}</nowiki>",
             "type": "content",
             "type": "content",
"required": false
"required": false
},
},
         "3...": {
         "3": {
"label": "And so on...",
"label": "And so on...",
"description": "Example markup/wikitext to demo.",
"description": "Example markup/wikitext to demo. This parameter must be surrounded by <nowiki> tags to work correctly.",
            "example": "<nowiki>{{SAI|Fire Bolt}}</nowiki>",
             "type": "content",
             "type": "content",
"required": false
"required": false

Revision as of 00:46, 22 July 2024

Template documentation

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 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.

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

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

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.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Example 11

Example markup/wikitext to demo. This parameter must be surrounded by <nowiki> tags to work correctly.

Example
<nowiki>{{SAI|Fire Bolt}}</nowiki>
Contentoptional
Example 22

Example markup/wikitext to demo. This parameter must be surrounded by <nowiki> tags to work correctly.

Example
<nowiki>{{SAI|Fire Bolt}}</nowiki>
Contentoptional
And so on...3

Example markup/wikitext to demo. This parameter must be surrounded by <nowiki> tags to work correctly.

Example
<nowiki>{{SAI|Fire Bolt}}</nowiki>
Contentoptional
Stylestyle

Select the layout style appropriate for the template being demoed.

Suggested values
table list
Default
table
Stringoptional