===== Utility Page Description =====

This page explain the **Utility Page Template**.

----

==== Namespace Creation ====

Each utility must have its own namespace. As an example **ff3:ff3us:util:ff3usme** is one. Put there the files that can be downloaded. If you add screenshots, you can put them in **ff3:ff3us:util:ff3usme:screenshots** for Gallery purpose. Other sub-namespaces are fine too if it keep thing ordered.

For FF6 Advance, create your utility namespace in **ff6a:utils** and for General ROM hacking in **rh:util**. 

----

==== Creating a Page ====

Open the template page you need and in the **page id** textbox enter the wanted utility name which will become part of the namespace (such as ff3usme in ff3:ff3us:util:ff3usme). Click on the red link in yellow box after to edit your new page.

The FF3us / FF6j utility template page is available [[pagetemplates:utility-snes|here]].\\
The FF6 Advance utility template page is available [[pagetemplates:utility-gba|here]].\\
The ROM Hacking utility template page is available [[pagetemplates:utility-rh|here]].\\

When your new page is opened and ready to be edited, remove the first section on top of page. It is similar to this but will differ a bit depending of which template you use. However it's always the first 5 lines:

<code>
<WRAP group>
<WRAP column leftalign>
~~OpenAS>rh:util:SAVEAS_PAGE#pagetemplates:utility-rh~~
</WRAP>
</WRAP>
</code>

----

===== Template Page Explanation =====

==== Header ====

Notice: Any WRAP tag such as **<nowiki><WRAP group></nowiki>**, **<nowiki><WRAP column></nowiki>** or **<nowiki></WRAP></nowiki>** must not be removed from the template. The only exception is the above code block containing the first 5 lines of the template.

----

1) **<nowiki>~~NOTOC~~</nowiki>** at top of page is required for no table of content.

----

2) **<nowiki>====== utility name here ======</nowiki>** is replaced by the utility name. As an example **<nowiki>====== FF3usME ======</nowiki>**.

----

==== Info Table ====

1) The following images for FF6 utilities are available. Use the one that fit the most the utility.

<WRAP group>
<WRAP column centeralign>
**FF3us**\\
{{pagetemplates:title:ff3us.png}}\\
<nowiki>{{pagetemplates:title:ff3us.png}}</nowiki></WRAP>
<WRAP column centeralign>
**FF6j**\\
{{pagetemplates:title:ff6j.png}}\\
<nowiki>{{pagetemplates:title:ff6j.png}}</nowiki></WRAP>
<WRAP column centeralign>
**FF6 Advance**\\
{{pagetemplates:title:ff6a.png}}\\
<nowiki>{{pagetemplates:title:ff6a.png}}</nowiki></WRAP>
</WRAP>

----

The following images for ROM Hacking utilities are available. Use the one that fit the most the utility.

<WRAP group>
<WRAP column centeralign>
**SNES / SFC**\\
{{pagetemplates:title:snes.png}}\\
<nowiki>{{pagetemplates:title:snes.png}}</nowiki></WRAP>
<WRAP column centeralign>
**GBA**\\
{{pagetemplates:title:gba.png}}\\
<nowiki>{{pagetemplates:title:gba.png}}</nowiki></WRAP>
<WRAP column centeralign>
**SNES / SFC / GBA**\\
{{pagetemplates:title:snes-gba.png}}\\
<nowiki>{{pagetemplates:title:snes-gba.png}}</nowiki></WRAP>
</WRAP>

----

2) **author name here** is replaced with utility author's name.

----

3) The following table has the utility categories available. If you use more than one, put a space between each.

<WRAP group>
<WRAP column>
|  **Description**  |  **Code**  |  **Image**  |
| Assembly utility |  <nowiki>{{pagetemplates:type:asm.png?nolink}}</nowiki>  |  {{pagetemplates:type:asm.png?nolink}}  |
| Compression / Decompression |  <nowiki>{{pagetemplates:type:compression.png?nolink}}</nowiki>  |  {{pagetemplates:type:compression.png?nolink}}  |
| Debugging / Debuggers |  <nowiki>{{pagetemplates:type:debugging.png?nolink}}</nowiki>  |  {{pagetemplates:type:debugging.png?nolink}}  |
| Game Data |  <nowiki>{{pagetemplates:type:data.png?nolink}}</nowiki>  |  {{pagetemplates:type:data.png?nolink}}  |
| Graphics |  <nowiki>{{pagetemplates:type:graphic.png?nolink}}</nowiki>  |  {{pagetemplates:type:graphic.png?nolink}}  |
| Hex Editors |  <nowiki>{{pagetemplates:type:hex.png?nolink}}</nowiki>  |  {{pagetemplates:type:hex.png?nolink}}  |
| Level / Map |  <nowiki>{{pagetemplates:type:level.png?nolink}}</nowiki>  |  {{pagetemplates:type:level.png?nolink}}  |
| Music |  <nowiki>{{pagetemplates:type:music.png?nolink}}</nowiki>  |  {{pagetemplates:type:music.png?nolink}}  |
| Palette |  <nowiki>{{pagetemplates:type:palette.png?nolink}}</nowiki>  |  {{pagetemplates:type:palette.png?nolink}}  |
| Patching |  <nowiki>{{pagetemplates:type:patching.png?nolink}}</nowiki>  |  {{pagetemplates:type:patching.png?nolink}}  |
| Save File |  <nowiki>{{pagetemplates:type:savefile.png?nolink}}</nowiki>  |  {{pagetemplates:type:savefile.png?nolink}}  |
| Save State |  <nowiki>{{pagetemplates:type:savestate.png?nolink}}</nowiki>  |  {{pagetemplates:type:savestate.png?nolink}}  |
| Sound / SFX |  <nowiki>{{pagetemplates:type:sound.png?nolink}}</nowiki>  |  {{pagetemplates:type:sound.png?nolink}}  |
| Sprite |  <nowiki>{{pagetemplates:type:sprite.png?nolink}}</nowiki>  |  {{pagetemplates:type:sprite.png?nolink}}  |
</WRAP> 
</WRAP>

----

4) The following table has the game categories available. If you use more than one, put a space between each.

<WRAP group>
<WRAP column>
|  **Description**  |  **Code**  |  **Image**  |
| FF3us 1.0 |  <nowiki>{{pagetemplates:game:ff3us10.png?nolink}}</nowiki>  |  {{pagetemplates:game:ff3us10.png?nolink}}  |
| FF3us 1.1 |  <nowiki>{{pagetemplates:game:ff3us11.png?nolink}}</nowiki>  |  {{pagetemplates:game:ff3us11.png?nolink}}  |
| FF6j |  <nowiki>{{pagetemplates:game:ff6j.png?nolink}}</nowiki>  |  {{pagetemplates:game:ff6j.png?nolink}}  |
| FF6A (E) |  <nowiki>{{pagetemplates:game:ff6ae.png?nolink}}</nowiki>  |  {{pagetemplates:game:ff6ae.png?nolink}}  |
| FF6A (J) |  <nowiki>{{pagetemplates:game:ff6aj.png?nolink}}</nowiki>  |  {{pagetemplates:game:ff6aj.png?nolink}}  |
| FF6A (U) |  <nowiki>{{pagetemplates:game:ff6au.png?nolink}}</nowiki>  |  {{pagetemplates:game:ff6au.png?nolink}}  |
| Steam |  <nowiki>{{pagetemplates:game:steam.png?nolink}}</nowiki>  |  {{pagetemplates:game:steam.png?nolink}}  |
| General SNES |  <nowiki>{{pagetemplates:game:snes.png?nolink}}</nowiki>  |  {{pagetemplates:game:snes.png?nolink}}  |
| General SFC |  <nowiki>{{pagetemplates:game:sfc.png?nolink}}</nowiki>  |  {{pagetemplates:game:sfc.png?nolink}}  |
| General GBA |  <nowiki>{{pagetemplates:game:gba.png?nolink}}</nowiki>  |  {{pagetemplates:game:gba.png?nolink}}  |
</WRAP> 
</WRAP>

----

5) The following table has the Operating Systems available. If you use more than one, put a space between each.

<WRAP group>
<WRAP column>
|  **Description**  |  **Code**  |  **Image**  |
| Windows |  <nowiki>{{pagetemplates:os:windows.png?nolink}}</nowiki>  |  {{pagetemplates:os:windows.png?nolink}}  |
| OS X |  <nowiki>{{pagetemplates:os:apple.png?nolink}}</nowiki>  |  {{pagetemplates:os:apple.png?nolink}}  |
| Linux |  <nowiki>{{pagetemplates:os:linux.png?nolink}}</nowiki>  |  {{pagetemplates:os:linux.png?nolink}}  |
</WRAP> 
</WRAP>

----

6) **latest version number here** is replaced with most recent version number and the one matching the download link. In case you don't know, put **unknown**.

----

7) **YYYY/MM/DD** is replaced with release date of most recent version and the one matching the download link. In case of doubt, you can put just the year or **unknown**.

----

8) Thew download link is replaced with most recent version link. **<nowiki>{{ff3:ff3us:util:ff3usme:ff3usme6.8.0.zip|FF3usME 6.8.0}}</nowiki>** is an example.

==== Description ====

Put anything you want here, as long as it is relevant.

----

==== Links ====

Links like author's website, old versions, file(s) required, tutorials, etc.

----

==== Gallery ====

if you use the gallery plugin, a syntax example would be **<nowiki>gallery>ff3:ff3us:util:ff3usme?260x200&lightbox</nowiki>**. Alternatively the **ff3:ff3us:util:ff3usme:gallery** or **ff3:ff3us:util:ff3usme:screenshots** namespaces could be an option. See the [[wiki:explugins|Gallery documentation]] for more info. Alternatively you can also display individual images if you want.

----