User:Evertiro/Shields: Difference between revisions

Latest revision as of 20:37, June 1, 2019

Purpose & Usage[edit | edit source]

This template provides a simple means to render custom scalable tags for use when applicable. Note that spaces must be url-safe, meaning that you must replace spaces with %20 (see examples).

Parameters:[edit | edit source]

label is the text for the (optional) label.
message is the text for the (recommended) message.
color determines the color used for the message background. The following built-in colors are available, custom colors can be defined by entering a hex color code:
- brightgreen
- green
- yellowgreen
- yellow
- orange
- red
- blue
- lightgrey
- blueviolet
- success
- important
- critical
- informational
- inactive

Examples[edit | edit source]

Code: (note %20 for spaces)

{{User:Evertiro/Shields|label=Hi!|message=I'm%20a%20shield.|color=blue}}

Result: <img src="https://img.shields.io/badge/Hi!-I'm%20a%20shield.-blue.svg" style="vertical-align: middle; height: 1.2rem" />

@@ Line 1: / Line 1: @@
-<includeonly><img src="https://img.shields.io/badge/{{{label|}}}-{{{message|}}}-{{{color|}}}.svg" style="vertical-align: middle" /></includeonly><noinclude>[[Category:Templates]]__NOTOC__
+<includeonly><img src="https://img.shields.io/badge/{{{label|}}}-{{{message|}}}-{{{color|}}}.svg" style="vertical-align: middle; height: 1.2rem" /></includeonly><noinclude>__NOTOC__
 ==Purpose & Usage==
-This template provides a simple means to render custom scalable tags for use when applicable.
+This template provides a simple means to render custom scalable tags for use when applicable. Note that spaces must be url-safe, meaning that you must replace spaces with %20 (see examples).
 ====Parameters:====
 * '''''label''''' is the text for the (optional) label.
-* '''''message''''' is the text for the (required) message.
+* '''''message''''' is the text for the (recommended) message.
 * '''''color''''' determines the color used for the message background. The following built-in colors are available, custom colors can be defined by entering a hex color code:
 ** brightgreen
@@ Line 21: / Line 21: @@
 ** inactive
 ==Examples==
-'''Code:''' (simplest call returns defaults for the template [size=80 (max), solid border])
+'''Code:''' (note %20 for spaces)
-<pre>{{Notice Small|text=Your text here.}}</pre>
+<pre>{{User:Evertiro/Shields|label=Hi!|message=I'm%20a%20shield.|color=blue}}</pre>
 '''Result:'''
-{{User:Evertiro/Shields|label=Test|message=Test 2|color=blue}}
+{{User:Evertiro/Shields|label=Hi!|message=I'm%20a%20shield.|color=blue}}
 </noinclude>