Template:Capsule/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Doc/subpage}}
{{Doc/subpage}}
This template is designed to add a block with rounded corners with text inside.
This template is designed to add a block with rounded corners with text inside.


{{ModernTodo|Better documentation.}}
== Parameters and Examples ==
 
{| class=standard-table | style="width:100%;"
== Examples ==
|-
{{CodeBlock|style=1|<nowiki>{{Capsule|Hello, World!}}</nowiki>}}
! width=15% | Parameter
{{Capsule|Hello, World!}}
! Description
 
! Example
 
! width=30% | Preview
{{CodeBlock|style=1|<nowiki>{{Capsule|style=1|Hello, World!}}</nowiki>}}
|-
{{Capsule|style=1|Hello, World!}}
| align="center" | ''No parameters''
 
| Reverts to default styling
 
| {{CodeBlock|<nowiki>{{Capsule}}</nowiki>}}
{{CodeBlock|style=1|<nowiki>{{Capsule|style=2|Hello, World!}}</nowiki>}}
| {{Capsule}}
{{Capsule|style=2|Hello, World!}}
|-
 
| align="center" | {{code|{{param|1}}}} or {{code|{{param|text}}}}
 
| For text input
{{CodeBlock|style=1|<nowiki>{{Capsule|style=3|Some text}}</nowiki>}}
| {{CodeBlock|<nowiki>{{Capsule|Hello, world!}}</nowiki>}} {{CodeBlock|<nowiki>{{Capsule|text=Hello, world!}}</nowiki>}}
{{Capsule|style=3|Some text}}
| {{Capsule|Hello, world!}}
 
|-
 
! colspan=4 | Styling parameters
{{CodeBlock|style=1|<nowiki>{{Capsule|style=1|Some text}}</nowiki>}}
|-
{{Capsule|style=1|Some text}}
| align="center" | {{code|{{param|align}}}}
 
| For specifying text alignment
 
| {{CodeBlock|<nowiki>{{Capsule|Hello, world!|align=left}}</nowiki>}} {{CodeBlock|<nowiki>{{Capsule|Hello, world!|align=center}}</nowiki>}} {{CodeBlock|<nowiki>{{Capsule|Hello, world!|align=right}}</nowiki>}}
{{CodeBlock|style=1|<nowiki>{{Capsule
| {{Capsule|Hello, world!|align=left}} {{Capsule|Hello, world!|align=center}} {{Capsule|Hello, world!|align=right}}
| style = 1
|-
| bg = #294157
| align="center" | {{code|{{param|bg}}}}
| align = center
| Background value
| text = [[File:Icon-panorama.png|text-bottom|16px|link=]] <b style="color:white">Hello, World!</b>
| {{CodeBlock|<nowiki>{{Capsule|bg=#294157}}</nowiki>}}
}}</nowiki>}}
| {{Capsule|bg=#294157}}
{{Capsule
|-
| style = 1
| align="center" | {{code|{{param|radius}}}}
| bg = #294157
| For setting the border radius
| align = center
| {{CodeBlock|<nowiki>{{Capsule|radius=1em}}</nowiki>}}
| text = [[File:Icon-panorama-filled.png|text-bottom|16px|link=]] <b style="color:white">Hello, World!</b>
| {{Capsule|radius=1em}}
}}
|-
| align="center" | {{code|{{param|padding}}}}
| Padding value
| {{CodeBlock|<nowiki>{{Capsule|padding=2em}}</nowiki>}}
| {{Capsule|padding=2em}}
|-
| align="center" | {{code|{{param|margin}}}}
| Margin value
| {{CodeBlock|<nowiki>{{Capsule|margin=0 1em}}</nowiki>}}
| {{Capsule|margin=0 1em}}
|-
| align="center" | {{code|{{param|height}}}}
| For specifying capsule height
| {{CodeBlock|<nowiki>{{Capsule|height=100px}}</nowiki>}}
| {{Capsule|height=100px}}
|-
| align="center" | {{code|{{param|style}}}}
| Used to change preset styling of the capsule.
| {{CodeBlock|<nowiki>{{Capsule|style=1}}</nowiki>}} {{CodeBlock|<nowiki>{{Capsule|style=2}}</nowiki>}} {{CodeBlock|<nowiki>{{Capsule|style=3}}</nowiki>}}
| {{Capsule|style=1}} {{Capsule|style=2}} {{Capsule|style=3}}
|}

Latest revision as of 18:27, 23 July 2023

Edit-copy.png
This is a documentation subpage for Template:Capsule.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

This template is designed to add a block with rounded corners with text inside.

Parameters and Examples

Parameter Description Example Preview
No parameters Reverts to default styling
{{Capsule}}
{{{1}}} or {{{text}}} For text input
{{Capsule|Hello, world!}}
{{Capsule|text=Hello, world!}}
Hello, world!
Styling parameters
{{{align}}} For specifying text alignment
{{Capsule|Hello, world!|align=left}}
{{Capsule|Hello, world!|align=center}}
{{Capsule|Hello, world!|align=right}}
Hello, world!
Hello, world!
Hello, world!
{{{bg}}} Background value
{{Capsule|bg=#294157}}
{{{radius}}} For setting the border radius
{{Capsule|radius=1em}}
{{{padding}}} Padding value
{{Capsule|padding=2em}}
{{{margin}}} Margin value
{{Capsule|margin=0 1em}}
{{{height}}} For specifying capsule height
{{Capsule|height=100px}}
{{{style}}} Used to change preset styling of the capsule.
{{Capsule|style=1}}
{{Capsule|style=2}}
{{Capsule|style=3}}
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:Capsule/doc&oldid=330557"