Template:Inline emote/doc: Difference between revisions

From Irony Wiki
Jump to navigation Jump to search
(c)
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:


=== Configuration ===
=== Configuration ===
<code><nowiki>{{inline emote|IMAGE.png|SIZE}}</nowiki></code>
<code><nowiki>{{inline emote|IMAGE.png|TITLE|SIZE}}</nowiki></code>


When specifying the image, do ''not'' include File: at the beginning.
When specifying the image, do ''not'' include File: at the beginning.
Title is optional, but suggested. This is what will show up if you hover your cursor over the emote.


Size is optional. The default is 20px.
Size is optional. The default is 20px.
Line 11: Line 13:


=== Example ===
=== Example ===
<code><nowiki>{{inline emote|Trollface.svg}}</nowiki></code>
<code><nowiki>{{inline emote|Trollface.svg|:troll:}}</nowiki></code>


Outputs: {{inline emote|Trollface.svg}}
Outputs: {{inline emote|Trollface.svg|:troll:}}


=== Parameters ===
=== Parameters ===
Line 27: Line 29:
},
},
"2": {
"2": {
"label": "Title",
"description": "What will show up if you hover over the emote.",
"type": "string",
"suggested": true
},
"3": {
"label": "Size",
"label": "Size",
"description": "The width of the image. Format is \"20px\".",
"type": "string",
"type": "string",
"default": "20px"
"default": "20px"
}
}
},
},
"format": "inline"
"format": "inline",
"paramOrder": [
"1",
"2",
"3"
]
}
}
</templatedata>
</templatedata>

Latest revision as of 08:12, 2 December 2020

A way to easily create emotes to use in wiki pages.

Configuration[edit source]

{{inline emote|IMAGE.png|TITLE|SIZE}}

When specifying the image, do not include File: at the beginning.

Title is optional, but suggested. This is what will show up if you hover your cursor over the emote.

Size is optional. The default is 20px.

If creating a template using this, you should add the template page to Category:Wiki emotes by adding <noinclude>[[Category:Wiki emotes]]</noinclude>.

Example[edit source]

{{inline emote|Trollface.svg|:troll:}}

Outputs:

Parameters[edit source]

No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Image1

The image to use. Do not include "File:".

Example
Trollface.svg
Filerequired
Title2

What will show up if you hover over the emote.

Stringsuggested
Size3

The width of the image. Format is "20px".

Default
20px
Stringoptional