Extension:SpriteSheet

The SpriteSheet extension allows uploaded images to be divided into sprite sheets or custom slices to be displayed without having to use an external image editor. The resulting sprites and slices are dynamically generated using CSS.


 * Project Homepage: Documentation at Github
 * Mediawiki Extension Page:
 * Source Code: Source Code at Github
 * Bugs: Issue Tracker at Github
 * Licensing: SpriteSheet is released under The GNU Lesser General Public License, version 3.0.

Configuration
There are two available rights that may be assigned to groups, 'edit_sprites' and 'spritesheet_rollback'. The 'edit_sprites' permission gives the ability to edit sprite sheets, sprites, slices, assign names, and delete. The 'spritesheet_rollback' allows the ability to rollback changes from the change log.

Default permissions:

#sprite - Parser Tag
The #sprite tag format accepts X and Y coordinate positions to select a section of the image in a traditional column and row format.

Basic Syntax:

It can also be spaced across lines for readability:

With optional resize and link:

Example
To display the sprite located at column 4, row 2:



#ifsprite - Parser Tag
The #ifsprite tag is used to display a named sprite if it exists. If the named sprite does not actually exist yet it will instead return the given wiki text.

Basic Syntax:

#slice - Parser Tag
The #slice tag takes X and Y positioning along with width and height sizing to select a section of the image. All four parameters take units in pixels(px) or percentages(%), but they all must use the same unit.

Basic Syntax:

It can also be spaced across lines for readability:

With optional resize and link:

#ifslice - Parser Tag
The #ifslice tag is used to display a named slice if it exists. If the named slice does not actually exist yet it will instead return the given wiki text.

Basic Syntax:

Naming Sprites/Slices


After a sprite or slice has been selected a pop up will open under the tag preview. This allows a custom name to be set for the selection that can be recalled later. It uses the same #sprite and #slice parser tags with the "name" parameter instead of specifying the positioning.

MediaWiki 1.39.x LTS Test Plan
The items listed here are general issues related to MediaWiki 1.39.x LTS. They are not addressing any issues that are specific to this extension.


 * Extension considered active for MediaWiki 1.39.x LTS