|
|
pagetemplates:utility-main [2017/09/04 00:30] madsiur [Info Table] |
pagetemplates:utility-main [2019/02/12 12:15] |
===== 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**. | |
| |
---- | |
| |
==== Demo Page ==== | |
| |
The utility demo page is available [[pagetemplates:utility|here]]. | |
| |
---- | |
| |
==== Creating an Utility Page ==== | |
| |
Click on one of these 3 red link to create your utility page using the template. The page will already be in the good namespace. For more info on the two plugins used for this, see [[https://www.dokuwiki.org/plugin:openas|openas]] and [[https://www.dokuwiki.org/plugin:newpagetemplate|newpagetemplate]] documentation. | |
| |
---- | |
| |
[[ff3:ff3us:util:snes_temp?do=edit&rev=&newpagetemplate=:pagetemplates:utility&newpagevars=|FF3us & FF6j Utility]] | |
| |
[[ff6a:utils:gba_temp?do=edit&rev=&newpagetemplate=:pagetemplates:utility&newpagevars=|FF6A Utility]] | |
| |
[[rh:util:rh_temp?do=edit&rev=&newpagetemplate=:pagetemplates:utility&newpagevars=|ROM Hacking Utility]] | |
| |
---- | |
| |
When the page is saved, rename it manually to utility name with the Dokuwiki menu option. | |
| |
---- | |
| |
| |
===== Demo Page Explanation ===== | |
| |
==== Header ==== | |
| |
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>**. | |
| |
---- | |
| |
3) **<nowiki><WRAP group><WRAP column></nowiki>** is left intact. | |
| |
---- | |
| |
==== Info Table ==== | |
| |
1) The following table has images 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> | |
| |
---- | |
| |
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}} | | |
</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. | |
| |
---- | |
| |
| |
| |
| |