Template:Emotes Animation/doc: Difference between revisions

From Unofficial Homecoming Wiki
Jump to navigation Jump to search
(update example, count parameter is no longer needed and does nothing)
(new format, new parameters, combines header and footer, allows new image file names)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
==Usage==
Creates a figure displaying one or more animations for an [[Emotes|emote]].
{| class="wikitable" style="width: 50%;float:left"
|-
!|Parameter
!|Use
!|Example
!|Default Value
|-
||emote
||Specify the emote to display
||Emote Dice2
||<nowiki>{{PAGENAME}}</nowiki>
|-
||noGW
||Use Mantid instead of Ghost Widow
||true
||
|}


Creates a box for displaying an animated GIF of an [[Emotes|emote]]. This template is intended for use on '''Emote {EMOTENAME}''' pages, and by default will attempt to display the ''Ghost_Widow_{EMOTENAME}.gif'' image. If the ''noGW'' parameter is specified, the ''Mantid_{EMOTENAME}.gif'' image will be used instead.
==Parameters==
; label
:  Optional. Text label for the figure. Default is page name.
; image 1
:  First image to display.
; alt 1
:  Optional, but recommended. Alt text for first image. Default is "variant 1".
; image 2, image 3, image 4, image 5
:  Optional. Additional images to display. Default is omitted.
; alt 2, alt 3, alt 4, alt 5
:  Optional. Alt text for additional images. Default is "variant 2" or "variant 3" etc.


The ''emote'' parameter can be used to specify an emote, rather than using the current page name for the emote. Note that since the default value for ''emote'' is <nowiki>{{PAGENAME}}</nowiki>, and this template is designed for use on the various [[:Category:Emote Animations|Emote Animation]] pages, the value for ''emote'' should begin with "Emote", followed by the emote name. This ensures that the correct image is pulled.
== Example ==
<pre>
{{Emotes Animation
| label  = Emote Ledgesit
| image 1 = Mantid Emote Ledgesit.gif
| alt 1  = Hands apart variant
| image 2 = Mantid Emote Ledgesit2.gif
| alt 2  = Hands together variant
}}
</pre>


{| class="wikitable"
{{Emotes Animation
|-
| label  = Emote Ledgesit
!|Code
| image 1 = Mantid Emote Ledgesit.gif
!|Output
| alt 1  = Hands apart variant
|-
| image 2 = Mantid Emote Ledgesit2.gif
| valign="top"|<tt><nowiki>{{Emotes Animation Header|title=Emote Experiment}}</nowiki><br>
| alt 2  = Hands together variant
<nowiki>{{Emotes Animation|emote=Emote Experiment1}}</nowiki><br>
}}
<nowiki>{{Emotes Animation|emote=Emote Experiment2}}</nowiki><br>
<nowiki>{{Emotes Animation Footer}}</nowiki></tt>
||{{Emotes Animation Header|title=Emote Experiment}}
{{Emotes Animation|emote=Emote Experiment1}}
{{Emotes Animation|emote=Emote Experiment2}}
{{Emotes Animation Footer|nocat=true}}
|}


==See also==
==See also==


* [[Template:Emotes Animation Header|Emotes Animation Header]]
* [[:Category:Emote Animations]]
* [[Template:Emotes Animation Footer|Emotes Animation Footer]]
* [[:Category:Emote Images]]
<includeonly><!--
<includeonly><!--
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
</includeonly>
</includeonly>

Revision as of 21:00, 7 May 2022

This is a documentation subpage for Template:Emotes Animation (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

Creates a figure displaying one or more animations for an emote.

Parameters

label
Optional. Text label for the figure. Default is page name.
image 1
First image to display.
alt 1
Optional, but recommended. Alt text for first image. Default is "variant 1".
image 2, image 3, image 4, image 5
Optional. Additional images to display. Default is omitted.
alt 2, alt 3, alt 4, alt 5
Optional. Alt text for additional images. Default is "variant 2" or "variant 3" etc.

Example

{{Emotes Animation
| label   = Emote Ledgesit
| image 1 = Mantid Emote Ledgesit.gif
| alt 1   = Hands apart variant
| image 2 = Mantid Emote Ledgesit2.gif
| alt 2   = Hands together variant 
}}
Emote Ledgesit
  • [[File:{{{image}}}|alt=animation]]
  • Hands together variant
Animations may take time to load

See also