Template:Icon: Difference between revisions
(Created page with "<includeonly>[[File:{{{1}}}|frameless|middle|link=|x{{{2|40}}}px]]</includeonly><noinclude> Usage: {{code|<nowiki>{{icon|Flourish.jpg}}</nowiki>}} Result: {{icon|Flourish.jpg}} </noinclude>") |
No edit summary |
||
| (22 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>[[File:{{{1}}}| | <includeonly>[[File:{{trim | {{{1}}} }}|link={{{link|}}}|{{#if: {{{w|}}}{{{h|}}} | {{{w|}}}x{{{h|}}}px | x{{trim | {{{2|40}}} }}px }}|alt={{{caption|{{{link|{{{1}}} }}}}}}|class=bg3wiki-icon {{{class|}}}]]<span class="bg3wiki-after-icon"></span></includeonly><noinclude> | ||
{{documentation|content= | |||
Usage: <pre>{{icon | Flourish Icon.png }}</pre> | |||
Result: {{icon|Flourish. | Result: {{icon | Flourish Icon.png }} | ||
The default size is {{code|x40px}} meaning the icon is scaled until the '''height''' is 40 px. It's usually important to limit the height since the icons are used inline, and a very high inline image makes for an unpleasant text layout. | |||
An alternative value for the height can be provided like so: | |||
Usage: <pre>{{icon | Flourish Icon.png | 30 }}</pre> | |||
Result: {{icon | Flourish Icon.png | 30 }} | |||
Usage: <pre>{{icon | Flourish Icon.png | 50 }}</pre> | |||
Result: {{icon | Flourish Icon.png | 50 }} | |||
Alternatively you can use the named parameters {{code|w}} and {{code|h}}. Note that these are max values so the more limiting one applies. In the following example, the height value is essentially ignored because the original image is a square so the width becomes the limiting factor. (Were the original image 200 by 500, the result would be 20 by 50.) | |||
Usage: <pre>{{icon | Flourish Icon.png | w = 20 | h = 50 }}</pre> | |||
Result: {{icon | Flourish Icon.png | w = 20 | h = 50 }} | |||
You can also provide a link: | |||
Usage: <pre>{{icon | Flourish Icon.png | link = Flourish }}</pre> | |||
Result: {{icon | Flourish Icon.png | link = Flourish }} | |||
Caption (alt text) will be the link by default but can be changed: | |||
Usage: <pre>{{icon | Flourish Icon.png | link = Flourish | caption = Blah }}</pre> | |||
Result: {{icon | Flourish Icon.png | link = Flourish | caption = Blah }} | |||
Behavior when icon is missing: | |||
Usage: <pre>{{icon | Missing Filename 123.png | link = Flourish }}</pre> | |||
Result: {{icon | Missing Filename 123.png | link = Flourish }} | |||
Drop shadow: | |||
<pre> | |||
{{icon | Flourish Icon.png | class = bg3wiki-lightmode-drop-shadow }} | |||
</pre> | |||
{{icon | Flourish Icon.png | class = bg3wiki-lightmode-drop-shadow }} | |||
}} | |||
[[Category:Icon templates]] | |||
</noinclude> | </noinclude> | ||
Latest revision as of 15:27, 23 June 2024
{{icon | Flourish Icon.png }}
Result: 
The default size is x40px meaning the icon is scaled until the height is 40 px. It's usually important to limit the height since the icons are used inline, and a very high inline image makes for an unpleasant text layout.
An alternative value for the height can be provided like so:
Usage:{{icon | Flourish Icon.png | 30 }}
Result: 
{{icon | Flourish Icon.png | 50 }}
Result: 
Alternatively you can use the named parameters w and h. Note that these are max values so the more limiting one applies. In the following example, the height value is essentially ignored because the original image is a square so the width becomes the limiting factor. (Were the original image 200 by 500, the result would be 20 by 50.)
{{icon | Flourish Icon.png | w = 20 | h = 50 }}
Result: 
You can also provide a link:
Usage:{{icon | Flourish Icon.png | link = Flourish }}
Result:
Caption (alt text) will be the link by default but can be changed:
Usage:{{icon | Flourish Icon.png | link = Flourish | caption = Blah }}
Result:
Behavior when icon is missing:
Usage:{{icon | Missing Filename 123.png | link = Flourish }}
Result: File:Missing Filename 123.png
Drop shadow:
{{icon | Flourish Icon.png | class = bg3wiki-lightmode-drop-shadow }}