« Modèle:Sprite/doc » : différence entre les versions

De WikiField
Aller à la navigation Aller à la recherche
mcen>MajrBot
m Switch documentation page template
 
Squirkiz (discussion | contributions)
contributeur, Administrateurs
485 modifications
m 1 révision importée
 
(2 versions intermédiaires par 2 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
{{documentation header}}
{{doc/début}}
<!-- Documentation here -->
Ce modèle permet de créé un « sprite » à partir d'une image mosaïque. Utilisé fréquemment lorsque de nombreuses petites images sont affichées, ce qui permet de réduire le nombre total de connexions HTTP.
{{lua}}
This template creates a sprite from a sheet image. Commonly used when many small images are displayed on one page to reduce the total amount of HTTP connections.


== Examples ==
== Utilisation ==
<pre>
<pre>
{{Sprite
{{Sprite
|pos=1
|pos=1
|align=text-top
|align=text-top
|image=BlockCSS.png
|image=BlocCSS.png
|link=Grass Block
|lien=Herbe
|text=Grass
|taille=16
|size=16
|tailleimage=256
|sheetsize=256
}}
}}
</pre>
</pre>
gives: {{Sprite
donne : {{Sprite
|pos=1
|pos=1
|align=text-top
|align=text-top
|image=BlockCSS.png
|image=BlocCSS.png
|link=Grass Block
|lien=Herbe
|text=Grass
|taille=16
|size=16
|tailleimage=256
|sheetsize=256
}}
}}


{| class="wikitable"
{|class="wikitable"
! Parameter
!Paramètre
! Function
!Fonction
! Default value
!Valeur par défaut
|-
|-
| <code>align</code> || Sets the [http://css-tricks.com/what-is-vertical-align/ vertical alignment] of the image to the text. || middle
| <code>pos</code> || Position du sprite sur la mosaïque, depends de <code>taille</code> et de <code>tailleimage</code> (numérotés de gauche à droite en partant du haut). || 1
|-
|-
| <code>class</code> || Add additional classes to .sprite || ''None''
| <code>align</code> || Défini [http://css-tricks.com/what-is-vertical-align/ l'alignment vertical] de l'image par rapport au texte. || middle
|-
|-
| <code>css</code> || Add styling to .sprite || ''None''
| <code>image</code> || Image mosaïque. || [[:Fichier:BlocCSS.png|BlocCSS.png]]
|-
|-
| <code>defaultpos</code> || The default position used if no position is set. || 1
| <code>lien</code> || Pour rajouter un lien sur le sprite. || ''Aucune''
|-
|-
| <code>image</code> || Sprite sheet image, without prefix || ''None''
| <code>taille</code> || Taille de chaque sprite en pixels (largeur = hauteur). || 16
|-
|-
| <code>link</code> || Create a link to this page || ''None''
| <code>tailleimage</code> || Taille de l'image mosaïque en pixels (largeur = hauteur), doit être un multiple de <code>taille</code>. || 256
|-
| <code>name</code>
| Sets the name for this spritesheet, used to:
# get the position definitions: Module:Sprite/<name>
# part of the classname if it's in the imgClasses table: <code><name:lower>-sprite</code>
# part of the image name, if <code>image</code> isn't set: <code><name>Sprite.png</code>
| ''None''
|-
| <code>pos</code> || Position index of the sprite, depends on <code>size</code> and <code>sheetsize</code> (left to right, starting at top-left sprite) || <code>defaultpos</code>
|-
| <code>scale</code> || Scale the sprite larger or smaller || 1
|-
| <code>sheetsize</code> || Width of the whole sheet in pixels. Must be multiple of <code>size</code> || 256
|-
| <code>size</code> || Size of each sprite in pixels, width and height || 16
|-
| <code>text</code> || Show some text after the sprite, if <code>link</code> is set, this text will also be linked. || ''None''
|-
| <code>title</code> || Set a title to be displayed when hovering over the sprite or text, overrides the link's title. || ''None''
|}
|}
 
{{doc/fin}}<noinclude>
== See also ==
[[en:Template:Sprite/doc]]
{{Sprite see also}}
 
<includeonly>
<!-- Template categories/interwiki here -->
[[Category:Sprite templates]]
 
[[fr:Modèle:Sprite]]
</includeonly>
<noinclude>
<!-- Documentation categories/interwiki here -->
[[fr:Modèle:Sprite/doc]]
</noinclude>
</noinclude>

Dernière version du 11 octobre 2019 à 17:51

Ce modèle permet de créé un « sprite » à partir d'une image mosaïque. Utilisé fréquemment lorsque de nombreuses petites images sont affichées, ce qui permet de réduire le nombre total de connexions HTTP.

Utilisation

{{Sprite
|pos=1
|align=text-top
|image=BlocCSS.png
|lien=Herbe
|taille=16
|tailleimage=256
}}

donne :

Paramètre Fonction Valeur par défaut
pos Position du sprite sur la mosaïque, depends de taille et de tailleimage (numérotés de gauche à droite en partant du haut). 1
align Défini l'alignment vertical de l'image par rapport au texte. middle
image Image mosaïque. BlocCSS.png
lien Pour rajouter un lien sur le sprite. Aucune
taille Taille de chaque sprite en pixels (largeur = hauteur). 16
tailleimage Taille de l'image mosaïque en pixels (largeur = hauteur), doit être un multiple de taille. 256

Ceci est la page de documentation, elle doit être insérée dans la page principale du modèle. Voir {{doc}} pour plus d'informations.

en:Template:Sprite/doc

Récupérée de "https://mediawiki.squirkiz.fr/index.php?title=Modèle:Sprite/doc&oldid=1860"