Difference between revisions of "Template:Icon"
m (Added trim template do make the template easier to use.) |
m (Added <span> class after-icon, in hopes of fixing icon formating issue. It will not show up after text.) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | |||
− | |||
− | |||
<noinclude> | <noinclude> | ||
− | + | ==Description== | |
− | + | A Template used to insert Icons and Images in an easy way. | |
− | |||
− | |||
− | |||
− | |||
− | |||
+ | ==Usage== | ||
The default size is <code>x40px</code> meaning the icon is scaled until the '''height''' is 40 px. <br> | The default size is <code>x40px</code> meaning the icon is scaled until the '''height''' is 40 px. <br> | ||
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. | 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. | ||
+ | <br><br> | ||
+ | Syntax: | ||
+ | <code><nowiki> | ||
+ | {{icon | Nesting_MAINPAGE.png }} | ||
+ | </nowiki></code> | ||
− | + | Result: {{icon | Nesting_MAINPAGE.png }} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ==Changing Size== | |
+ | An alternative value for the height can also be provided. | ||
+ | <br> There can however be no space between the pipebar <code>|</code> and the size. | ||
+ | <br><br> | ||
+ | Syntax: | ||
+ | <code><nowiki> | ||
{{icon | Nesting_MAINPAGE.png |30 }} | {{icon | Nesting_MAINPAGE.png |30 }} | ||
+ | </nowiki></code> | ||
− | + | Result: {{icon | Nesting_MAINPAGE.png |30 }} | |
− | < | + | ---- |
− | + | <br> | |
− | </ | + | Syntax: |
+ | <code><nowiki> | ||
+ | {{icon | Nesting_MAINPAGE.png |50 }} | ||
+ | </nowiki></code> | ||
− | Result: | + | Result: {{icon | Nesting_MAINPAGE.png |50 }} |
− | {{icon | Nesting_MAINPAGE.png | 50 }} | ||
+ | ==Changing Height and Weight seperatly== | ||
Alternatively you can use the named parameters <code>w</code> and <code>h</code>. <br> | Alternatively you can use the named parameters <code>w</code> and <code>h</code>. <br> | ||
Note that these are max values so the more limiting one applies. <br> | Note that these are max values so the more limiting one applies. <br> | ||
− | In the following example, the height value is essentially ignored because the original image is a square so the width becomes the limiting factor. | + | In the following example, the height value is essentially ignored because the original image is a square so the width becomes the limiting factor. |
− | + | <br>(Were the original image 200 by 500, the result would be 20 by 50.) | |
− | + | <br><br> | |
− | < | + | Syntax: |
− | + | <code><nowiki> | |
− | < | ||
− | |||
− | |||
{{icon | Nesting_MAINPAGE.png | w = 20 | h = 50 }} | {{icon | Nesting_MAINPAGE.png | w = 20 | h = 50 }} | ||
+ | </nowiki></code> | ||
− | + | Result: {{icon | Nesting_MAINPAGE.png | w = 20 | h = 50 }} | |
− | + | ==Linking Page== | |
− | < | + | You can also provide a link. |
− | + | <br><br> | |
− | < | + | Syntax: |
− | + | <code><nowiki> | |
− | |||
{{icon | Nesting_MAINPAGE.png | link = Nesting }} | {{icon | Nesting_MAINPAGE.png | link = Nesting }} | ||
+ | </nowiki></code> | ||
− | + | Result: {{icon | Nesting_MAINPAGE.png | link = Nesting }} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ==Adding Caption== | |
+ | The Caption (alt text) will be the link by default but can be changed. | ||
+ | <br><br> | ||
+ | Syntax: | ||
+ | <code><nowiki> | ||
{{icon | Nesting_MAINPAGE.png | link = Nesting | caption = Blah }} | {{icon | Nesting_MAINPAGE.png | link = Nesting | caption = Blah }} | ||
+ | </nowiki></code> | ||
− | + | Result: {{icon | Nesting_MAINPAGE.png | link = Nesting | caption = Blah }} | |
− | + | ==Missing Image== | |
− | < | + | Should the image be missing, the following will be displayed: |
− | + | <br><br> | |
− | </ | + | Syntax: |
+ | <code><nowiki> | ||
+ | {{icon | link = Nesting }} | ||
+ | </nowiki></code> | ||
− | Result: | + | Result: {{icon | link = Nesting }} |
− | {{icon | link = Nesting }} | ||
[[Category: Templates]] | [[Category: Templates]] | ||
</noinclude> | </noinclude> | ||
+ | |||
+ | <includeonly> | ||
+ | [[File:{{{1|broken_error_image.png}}}|link={{{link|}}}|{{#if: {{{w|}}} {{{h|}}} | {{{w|}}}x{{{h|}}}px | x{{{2|40}}}px }} | alt={{{caption|{{{link}}}}}} |class=icon {{{class|}}}]]<span class="after-icon"></span> | ||
+ | </includeonly> |
Latest revision as of 16:29, 24 November 2024
Contents
Description
A Template used to insert Icons and Images in an easy way.
Usage
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.
Syntax:
{{icon | Nesting_MAINPAGE.png }}
Result:
Changing Size
An alternative value for the height can also be provided.
There can however be no space between the pipebar |
and the size.
Syntax:
{{icon | Nesting_MAINPAGE.png |30 }}
Result:
Syntax:
{{icon | Nesting_MAINPAGE.png |50 }}
Result:
Changing Height and Weight seperatly
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.)
Syntax:
{{icon | Nesting_MAINPAGE.png | w = 20 | h = 50 }}
Result:
Linking Page
You can also provide a link.
Syntax:
{{icon | Nesting_MAINPAGE.png | link = Nesting }}
Result:
Adding Caption
The Caption (alt text) will be the link by default but can be changed.
Syntax:
{{icon | Nesting_MAINPAGE.png | link = Nesting | caption = Blah }}
Result:
Missing Image
Should the image be missing, the following will be displayed:
Syntax:
{{icon | link = Nesting }}
Result: