Jump to: navigation, search

Template:Sprite/doc: Difference between revisions

m (1 revision)
 
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{documentation}}
{{doc/start}}<!-- Documentation here -->
<!-- Documentation here -->
{{lua}}
{{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.
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.
Line 65: Line 64:
== See also ==
== See also ==
{{Sprite see also}}
{{Sprite see also}}
 
{{doc/end}}
<includeonly>
<includeonly>
<!-- Template categories/interwiki here -->
<!-- Template categories/interwiki here -->
[[Category:Sprite templates]]
[[Category:Sprite templates]]


[[fr:Modèle:Sprite]]
</includeonly>
</includeonly>
<noinclude>
<noinclude>
<!-- Documentation categories/interwiki here -->
<!-- Documentation categories/interwiki here -->
[[fr:Modèle:Sprite/doc]]
</noinclude>
</noinclude>

Latest revision as of 15:34, 12 May 2017

Template-info.png Documentation
Lua logo.svg
This template uses Module:Sprite, a script written in the Lua programming language. Please see wp:Lua and mw:Extension:Scribunto to learn more about 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

{{Sprite
|pos=1
|align=text-top
|image=BlockCSS.png
|link=Grass Block
|text=Grass
|size=16
|sheetsize=256
}}

gives:
Grass

Parameter Function Default value
align Sets the vertical alignment of the image to the text. middle
class Add additional classes to .sprite None
css Add styling to .sprite None
defaultpos The default position used if no position is set. 1
image Sprite sheet image, without prefix None
link Create a link to this page None
name Sets the name for this spritesheet, used to:
  1. get the position definitions: Module:Sprite/<name>
  2. part of the classname if it's in the imgClasses table: <name:lower>-sprite
  3. part of the image name, if image isn't set: <name>Sprite.png
None
pos Position index of the sprite, depends on size and sheetsize (left to right, starting at top-left sprite) defaultpos
scale Scale the sprite larger or smaller 1
sheetsize Width of the whole sheet in pixels. Must be multiple of size 256
size Size of each sprite in pixels, width and height 16
text Show some text after the sprite, if link is set, this text will also be linked. None
title Set a title to be displayed when hovering over the sprite or text, overrides the link's title. None

See also

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.




Cookies help us deliver our services. By using our services, you agree to our use of cookies.