Skip to content

Commit a1b92de

Browse files
committed
Documentation update.
1 parent 8d7db90 commit a1b92de

File tree

2 files changed

+27
-25
lines changed

2 files changed

+27
-25
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,20 @@ The #sprite tag format accepts X and Y coordinate positions to select a section
4040

4141
Basic Syntax:
4242

43-
{{#sprite:file=Example.png|column=0|row=0}}
43+
{{#sprite:file=File:Example.png|column=0|row=0}}
4444

4545
It can also be spaced across lines for readability:
4646

4747
{{#sprite:
48-
file=Example.png
48+
file=File:Example.png
4949
|column=0
5050
|row=0
5151
}}
5252

5353
With optional resize and link:
5454

5555
{{#sprite:
56-
file=Example.png
56+
file=File:Example.png
5757
|column=0
5858
|row=0
5959
|resize=300

README.wiki

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
{{ {{TNTN|Extension}}
1+
{{TNT|Extension
22
|name = SpriteSheet
3-
|license = {{EL|LGPL3}}
3+
|license = LGPL-3.0
44
|status = stable
55
|type = parser function
66
|author = Alexia E. Smith ([[User:Alexia E. Smith|Alexia E. Smith]]), Hydra Wiki Platform Team
7-
|version = 1.1.5
8-
|update = 2016-11-07
9-
|mediawiki = 1.23+
10-
|php = 5.5+
11-
|download = {{ {{TNTN|GithubDownload}} |HydraWiki|SpriteSheet}}
7+
|version = 1.2.0
8+
|update = 2018-07-09
9+
|mediawiki = 1.27+
10+
|php = 7.0+
11+
|download = {{TNT|GithubDownload|HydraWiki|SpriteSheet}}
1212
|hook1 = ParserFirstCallInit
1313
|hook2 = ImagePageShowTOC
1414
|hook3 = ImageOpenShowImageInlineBefore
1515
|hook4 = PageRenderingHash
1616
|hook5 = LoadExtensionSchemaUpdates
17-
|description = Adds a parser functions called <tt>#sprite</tt> and <tt>#slice</tt> to display defined sections of an image without having to use an external editor.
17+
|description = Adds a parser functions called <code>#sprite</code> and <code>#slice</code> to display defined sections of an image without having to use an external editor.
1818
|example = [http://help.gamepedia.com/Extension:SpriteSheet/Example Gamepedia Help Wiki]
1919
}}
2020

@@ -29,9 +29,9 @@ The '''SpriteSheet''' extension allows uploaded images to be divided into sprite
2929

3030
==Installation==
3131

32-
{{{{TNTN|ExtensionInstall}}
32+
{{TNT|ExtensionInstall
3333
|db-update=true
34-
|download-link=[https://github.com/HydraWiki/SpriteSheet/archive/v1.1.5.zip Download]}}
34+
|download-link=[https://github.com/HydraWiki/SpriteSheet/archive/v1.2.0.zip Download]}}
3535

3636
==Configuration==
3737
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.
@@ -52,20 +52,20 @@ The #sprite tag format accepts X and Y coordinate positions to select a section
5252

5353
Basic Syntax:
5454

55-
<pre><nowiki>{{#sprite:file=Example.png|column=0|row=0}}</nowiki></pre>
55+
<pre><nowiki>{{#sprite:file=File:Example.png|column=0|row=0}}</nowiki></pre>
5656

5757
It can also be spaced across lines for readability:
5858

5959
<pre><nowiki>{{#sprite:
60-
file=Example.png
60+
file=File:Example.png
6161
|column=0
6262
|row=0
6363
}}</nowiki></pre>
6464

6565
With optional resize and link:
6666

6767
<pre><nowiki>{{#sprite:
68-
file=Example.png
68+
file=File:Example.png
6969
|column=0
7070
|row=0
7171
|resize=300
@@ -92,11 +92,11 @@ file=Example.png
9292
:The Y Coordinate Position of the sprite to select. Coordinates use zero based numbering.
9393
|-
9494
| <code>resize</code>
95-
| '''Required:''' no, '''Default:''' <tt>null</tt>
95+
| '''Required:''' no, '''Default:''' <code>null</code>
9696
:Display size in pixel width of the sprite. Note: Will not resize larger than 100% of the original size.
9797
|-
9898
| <code>link</code>
99-
| '''Required:''' no, '''Default:''' <tt>null</tt>
99+
| '''Required:''' no, '''Default:''' <code>null</code>
100100
:Page name or external URL to have the sprite link to.
101101
|}
102102

@@ -139,11 +139,11 @@ file=File:Example.png
139139
:The named sprite to load.
140140
|-
141141
| <code>resize</code>
142-
| '''Required:''' no, '''Default:''' <tt>none</tt>
142+
| '''Required:''' no, '''Default:''' <code>none</code>
143143
:Display size in pixel width of the sprite. Note: Will not resize larger than 100% of the original size.
144144
|-
145145
| <code>wikitext</code>
146-
| '''Required:''' yes, '''Default:''' <tt>none</tt>
146+
| '''Required:''' yes, '''Default:''' <code>none</code>
147147
:The wiki text to parse and display if the named sprite is not found. Can be left blank to not display anything.
148148
|}
149149

@@ -212,11 +212,11 @@ file=Example.png
212212
:Height in in pixels or percentage starting from the Y position.
213213
|-
214214
| <code>resize</code>
215-
| '''Required:''' no, '''Default:''' <tt>null</tt>
215+
| '''Required:''' no, '''Default:''' <code>null</code>
216216
:Display size in pixel width of the sprite. Note: Will not resize larger than 100% of the original size.
217217
|-
218218
| <code>link</code>
219-
| '''Required:''' no, '''Default:''' <tt>null</tt>
219+
| '''Required:''' no, '''Default:''' <code>null</code>
220220
:Page name or external URL to have the sprite link to.
221221
|}
222222

@@ -260,11 +260,11 @@ file=File:Image_Name.png
260260
:The named slice to load.
261261
|-
262262
| <code>resize</code>
263-
| '''Required:''' no, '''Default:''' <tt>none</tt>
263+
| '''Required:''' no, '''Default:''' <code>none</code>
264264
:Display size in pixel width of the slice. Note: Will not resize larger than 100% of the original size.
265265
|-
266266
| <code>wikitext</code>
267-
| '''Required:''' yes, '''Default:''' <tt>none</tt>
267+
| '''Required:''' yes, '''Default:''' <code>none</code>
268268
:The wiki text to parse and display if the named slice is not found. Can be left blank to not display anything.
269269
|}
270270

@@ -285,4 +285,6 @@ After a sprite or slice has been selected a pop up will open under the tag previ
285285
<pre>{{#sprite:file=File:Hanamura-screenshot.jpg|name=Plaque}}</pre>
286286
<pre>{{#sprite:file=File:Hanamura-screenshot.jpg|name=Plaque|resize=800}}</pre>
287287
<pre>{{#slice:file=File:Hanamura-screenshot.jpg|name=Plaque}}</pre>
288-
<pre>{{#slice:file=File:Hanamura-screenshot.jpg|name=Plaque|resize=500}}</pre>
288+
<pre>{{#slice:file=File:Hanamura-screenshot.jpg|name=Plaque|resize=500}}</pre>
289+
290+
[[Category:Image extensions]]

0 commit comments

Comments
 (0)