Both sides previous revision
Previous revision
Next revision
|
Previous revision
|
pagetemplates:utility-main [2017/09/03 18:09] madsiur [Creating an Utility Page] |
pagetemplates:utility-main [2017/09/04 02:19] madsiur [Header] |
---- | ---- |
| |
===== Namespace Creation ===== | ==== 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. | 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. |
---- | ---- |
| |
==== Demo Page ==== | ==== Creating a Page ==== |
| |
The utility demo page is available [[pagetemplates:utility-demo|here]]. | 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]].\\ |
| |
==== Creating an Utility Page ==== | 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: |
| |
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. | <code> |
| <WRAP group> |
| <WRAP column leftalign> |
| ~~OpenAS>rh:util:SAVEAS_PAGE#pagetemplates:utility-rh~~ |
| </WRAP> |
| </WRAP> |
| </code> |
| |
---- | ---- |
| |
[[ff3:ff3us:util:snes_temp?do=edit&rev=&newpagetemplate=:pagetemplates:utility&newpagevars=|FF3us & FF6j Utility]] | ===== Template Page Explanation ===== |
| |
[[ff6a:utils:gba_temp?do=edit&rev=&newpagetemplate=:pagetemplates:utility&newpagevars=|FF6A Utility]] | ==== Header ==== |
| |
[[rh:util:rh_temp?do=edit&rev=&newpagetemplate=:pagetemplates:utility&newpagevars=|ROM Hacking Utility]] | 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. |
| |
---- | ---- |
| |
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. | 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>**. | 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 ==== | ==== Info Table ==== |
| |
1) The following table has images available. Use the one that fit the most the utility. | 1) The following images for FF6 utilities are available. Use the one that fit the most the utility. |
| |
<WRAP group> | <WRAP group> |
<WRAP column centeralign> | <WRAP column centeralign> |
| **FF3us**\\ |
{{pagetemplates:title:ff3us.png}}\\ | {{pagetemplates:title:ff3us.png}}\\ |
<nowiki>{{pagetemplates:title:ff3us.png}}</nowiki></WRAP> | <nowiki>{{pagetemplates:title:ff3us.png}}</nowiki></WRAP> |
<WRAP column centeralign> | <WRAP column centeralign> |
| **FF6j**\\ |
{{pagetemplates:title:ff6j.png}}\\ | {{pagetemplates:title:ff6j.png}}\\ |
<nowiki>{{pagetemplates:title:ff6j.png}}</nowiki></WRAP> | <nowiki>{{pagetemplates:title:ff6j.png}}</nowiki></WRAP> |
<WRAP column centeralign> | <WRAP column centeralign> |
| **FF6 Advance**\\ |
{{pagetemplates:title:ff6a.png}}\\ | {{pagetemplates:title:ff6a.png}}\\ |
<nowiki>{{pagetemplates:title:ff6a.png}}</nowiki></WRAP> | <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> | </WRAP> |
| |
| FF6A (U) | <nowiki>{{pagetemplates:game:ff6au.png?nolink}}</nowiki> | {{pagetemplates:game:ff6au.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}} | | | 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> |
</WRAP> | </WRAP> |