Difference between revisions of "Help:Adding a format"

From XentaxWiki
Jump to: navigation, search
(Filling out the Template)
(everything needs a complete overhaul)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
''This page isn't complete and could definitely be improved. Make changes yourself, or suggest them on the [[Talk:Adding a Format|talk page]]. The [[GRAFTemplate1 Help]] page could also use a lot of work, feel free to make changes or add information.''
+
<!-- ''This page isn't complete and could definitely be improved. Make changes yourself, or suggest them on the [[Help talk:Adding a format|talk page]]. The [[GRAFTemplate1 Help]] page could also use a lot of work, feel free to make changes or add information.''
  
== Introduction ==
+
Adding a format to the Xentax WIKI is a very easy process. The aim of this tutorial is to walk you through it, step-by-step. You may use the Table of Contents (above) to skip directly to a section, or just read the whole thing through.
 +
 
 +
== Naming the Page ==
 
<div style="float:right;margin-left:10px;background-color:#EEEEEE;border:solid black 1px;width:20%;padding:10px">
 
<div style="float:right;margin-left:10px;background-color:#EEEEEE;border:solid black 1px;width:20%;padding:10px">
 
<font size="+2">FAQ</font><br>
 
<font size="+2">FAQ</font><br>
Line 8: Line 10:
 
If a format you are adding is used by multiple versions of the same game (for instance, the PC version and the XBox version, or the demo and the full version), list each version as its own entry in the list of GRAFS and link them all to the same format page. You must also list them seperately in the 'Games' section of that format page.<br>
 
If a format you are adding is used by multiple versions of the same game (for instance, the PC version and the XBox version, or the demo and the full version), list each version as its own entry in the list of GRAFS and link them all to the same format page. You must also list them seperately in the 'Games' section of that format page.<br>
 
</div>
 
</div>
Adding a format to the Xentax WIKI is a very easy process. The aim of this tutorial is to walk you through it, step-by-step. You may use the Table of Contents (above) to skip directly to a section, or just read the whole thing through.
 
 
=== Naming the Page ===
 
 
First and foremost, make sure the format you want to add isn't already on the WIKI. You can do this by [[Special:Search|searching]] for the game's title or any strings in the format (for instance, header strings) and examining any results that come up. If your format is already on the WIKI, add your game's name to the list at the bottom of the format page, keeping alphabetical order, and then add your game to the list of [[GRAFs]].
 
First and foremost, make sure the format you want to add isn't already on the WIKI. You can do this by [[Special:Search|searching]] for the game's title or any strings in the format (for instance, header strings) and examining any results that come up. If your format is already on the WIKI, add your game's name to the list at the bottom of the format page, keeping alphabetical order, and then add your game to the list of [[GRAFs]].
  
 
If you pass the search test (i.e. the game isn't on the WIKI), you will next need to edit the correct list on the [[GRAFs]] page and add the title of the game to the list. The current list is sorted alphabetically, so please follow that convention!
 
If you pass the search test (i.e. the game isn't on the WIKI), you will next need to edit the correct list on the [[GRAFs]] page and add the title of the game to the list. The current list is sorted alphabetically, so please follow that convention!
  
==== Naming Conventions ====
+
=== Naming Conventions ===
 
Firstly, find where your game would be on the GRAFs page. insert a new line with an asterisk (*) at the beginning of the line, followed by the game's name. Make sure to watch capitalization!<br>
 
Firstly, find where your game would be on the GRAFs page. insert a new line with an asterisk (*) at the beginning of the line, followed by the game's name. Make sure to watch capitalization!<br>
 
For example:
 
For example:
Line 28: Line 27:
 
Dreamcast: {{DreamcastTag}}
 
Dreamcast: {{DreamcastTag}}
 
Gamecube:  {{GamecubeTag}}
 
Gamecube:  {{GamecubeTag}}
 +
PC:        {{PCTag}}
 
PS1:      {{PS1Tag}}
 
PS1:      {{PS1Tag}}
 
PS2:      {{PS2Tag}}
 
PS2:      {{PS2Tag}}
 
PSP:      {{PSPTag}}
 
PSP:      {{PSPTag}}
 
X-Box:    {{XBoxTag}}</pre>
 
X-Box:    {{XBoxTag}}</pre>
''To request tags for additional platforms, please leave a comment on the [[Talk:Adding a Format]] page.''<br>
+
''To request tags for additional platforms, please leave a comment on the [[Help talk:Adding a format|talk]] page.''<br>
This will result in one of the following labels: {{3DOTag}} {{DreamcastTag}} {{GamecubeTag}} {{PS1Tag}} {{PS2Tag}} {{PSPTag}} {{XBoxTag}}
+
This will result in one of the following labels: {{3DOTag}} {{DreamcastTag}} {{GamecubeTag}} {{PCTag}} {{PS1Tag}} {{PS2Tag}} {{PSPTag}} {{XBoxTag}}
  
 
''NOTE: There is a difference between the PS1 and the PSX!!! The PS1 was the original Playstation system released by Sony, and the PSX was a souped-up version of the PS1 released shortly thereafter, with the intention of being an all-in-one media center. The PSX failed miserably, the PS1 did not. I'm not sure if there are any differences between games on the PS1 and those on the PSX (if they are even seperate), but still, watch when you post a format for the PS1 or the PSX!!!''
 
''NOTE: There is a difference between the PS1 and the PSX!!! The PS1 was the original Playstation system released by Sony, and the PSX was a souped-up version of the PS1 released shortly thereafter, with the intention of being an all-in-one media center. The PSX failed miserably, the PS1 did not. I'm not sure if there are any differences between games on the PS1 and those on the PSX (if they are even seperate), but still, watch when you post a format for the PS1 or the PSX!!!''
Line 43: Line 43:
 
* Sample Game {{DemoTag}} {{XBoxTag}} ( '''[[GFFC|*.xxx]]''' )
 
* Sample Game {{DemoTag}} {{XBoxTag}} ( '''[[GFFC|*.xxx]]''' )
  
==== Linking Conventions ====
+
=== Linking Conventions ===
 
After adding the name of the game, you'll have to create a link. When choosing the name of the new page, you should use the game's name, with the same capitalization used on the game's box or case.
 
After adding the name of the game, you'll have to create a link. When choosing the name of the new page, you should use the game's name, with the same capitalization used on the game's box or case.
 
* If the game is a demo, you will also want to include the text '''(Demo)''' immediately after the game's name.
 
* If the game is a demo, you will also want to include the text '''(Demo)''' immediately after the game's name.
Line 58: Line 58:
 
* Sample Game {{DemoTag}} {{XBoxTag}} ( '''[[GFFC|*.archive001]]''' ) ( '''[[GFFC|*.xyz]]''' ) ( '''[[GFFC|*.abc *.zzz]]''' )
 
* Sample Game {{DemoTag}} {{XBoxTag}} ( '''[[GFFC|*.archive001]]''' ) ( '''[[GFFC|*.xyz]]''' ) ( '''[[GFFC|*.abc *.zzz]]''' )
  
=== Editing the page ===
+
== Editing the page ==
 
When you've submitted the edited page, it will create a red link that you can click on to edit the new page. Click on it, and copy the following text onto it (NOTE: this may not be the most current template to use. Make sure to check the page [[Sample Game 1 PAK]] for the most current template, as that is where changes are first made):
 
When you've submitted the edited page, it will create a red link that you can click on to edit the new page. Click on it, and copy the following text onto it (NOTE: this may not be the most current template to use. Make sure to check the page [[Sample Game 1 PAK]] for the most current template, as that is where changes are first made):
 
  <nowiki>{{GRAFPageHeader}}</nowiki>
 
  <nowiki>{{GRAFPageHeader}}</nowiki>
Line 86: Line 86:
 
  <nowiki>{{GRAFPageFooter}}</nowiki>
 
  <nowiki>{{GRAFPageFooter}}</nowiki>
  
==== Filling out the Template ====
+
=== Filling out the Template ===
  
 
<blockquote>''Note: This was moved from [[Sample Game 1 PAK]], and has undergone some copyediting, though there is still much to do.''</blockquote>
 
<blockquote>''Note: This was moved from [[Sample Game 1 PAK]], and has undergone some copyediting, though there is still much to do.''</blockquote>
  
===== Header and Misc Information =====
+
==== Header and Misc Information ====
  
 
  {{[[Template:GRAFPageHeader|GRAFPageHeader]]}}
 
  {{[[Template:GRAFPageHeader|GRAFPageHeader]]}}
Line 112: Line 112:
 
A quick note on the date_posted field: the first time you save a page to the WIKI, the value should be '''<nowiki>~~~~~</nowiki>''' (5 tildes). When the page gets saved, this is automatically replaced with the date and time that the page was saved. On future edits of the page, leave this field alone; it is meant to show when the page was originally created (and thereby when the format was added), not when the last update occurred.
 
A quick note on the date_posted field: the first time you save a page to the WIKI, the value should be '''<nowiki>~~~~~</nowiki>''' (5 tildes). When the page gets saved, this is automatically replaced with the date and time that the page was saved. On future edits of the page, leave this field alone; it is meant to show when the page was originally created (and thereby when the format was added), not when the last update occurred.
  
===== Format Description =====
+
==== Format Description ====
  
 
  <nowiki>=== Format Specifications ===</nowiki>
 
  <nowiki>=== Format Specifications ===</nowiki>
Line 123: Line 123:
 
  :byte {x} &amp;nbsp;&amp;nbsp;&amp;nbsp; - File data}}
 
  :byte {x} &amp;nbsp;&amp;nbsp;&amp;nbsp; - File data}}
  
====== Template Nesting ======
+
===== Template Nesting =====
  
 
Note that when you use the '''{{[[Template:GRAFPageFormat|GRAFPageFormat]]}}''' template, if you use any other templates within it, such as '''{{[[Template:InlineComment|InlineComment]]}}''' or '''{{[[Template:Unknown|Unknown]]}}''', you need to place a '''1=''' right after the pipe character ('''|'''). For instance, '''<nowiki>{{GRAFPageFormat|{{BlockDescription|This is a block description}}}}</nowiki>''' will display as '''None written yet'''. However, '''<nowiki>{{GRAFPageFormat|1={{BlockDescription|This is a block description}}}}</nowiki>''' will display as {{Blue|'''This is a block description'''}}. If no other templates are used, the '''1=''' is completely optional, but it should still be left in.
 
Note that when you use the '''{{[[Template:GRAFPageFormat|GRAFPageFormat]]}}''' template, if you use any other templates within it, such as '''{{[[Template:InlineComment|InlineComment]]}}''' or '''{{[[Template:Unknown|Unknown]]}}''', you need to place a '''1=''' right after the pipe character ('''|'''). For instance, '''<nowiki>{{GRAFPageFormat|{{BlockDescription|This is a block description}}}}</nowiki>''' will display as '''None written yet'''. However, '''<nowiki>{{GRAFPageFormat|1={{BlockDescription|This is a block description}}}}</nowiki>''' will display as {{Blue|'''This is a block description'''}}. If no other templates are used, the '''1=''' is completely optional, but it should still be left in.
  
====== Sub-blocks ======
+
===== Sub-blocks =====
  
 
Block section descriptions should use the '''{{[[Template:BlockDescription|BlockDescription]]}}''' template, like in the example above.
 
Block section descriptions should use the '''{{[[Template:BlockDescription|BlockDescription]]}}''' template, like in the example above.
  
====== Data Types (Field Tags) ======
+
===== Data Types (Field Tags) =====
  
 
Field tags can be one of the following:
 
Field tags can be one of the following:
Line 146: Line 146:
 
'''uintx {x}''' or '''intx {x}''', note that the first number in the tag (the first x) is equal to the field's length * 8, so if a field is 4 bytes long, the first number would be 32. The second number (the second x) should be the field's actual length in bytes. Field tags themselves should be thirteen characters long from the beginning of the tag to the dash, inclusive, with multiple spaces using &amp;nbsp;, as seen in the above example.
 
'''uintx {x}''' or '''intx {x}''', note that the first number in the tag (the first x) is equal to the field's length * 8, so if a field is 4 bytes long, the first number would be 32. The second number (the second x) should be the field's actual length in bytes. Field tags themselves should be thirteen characters long from the beginning of the tag to the dash, inclusive, with multiple spaces using &amp;nbsp;, as seen in the above example.
  
====== Unknown Values ======
+
===== Unknown Values =====
  
 
Unknown values should use the '''{{[[Template:Unknown|Unknown]]}}''' template. If you have an educated guess for what an unknown value might be, you should use<br>
 
Unknown values should use the '''{{[[Template:Unknown|Unknown]]}}''' template. If you have an educated guess for what an unknown value might be, you should use<br>
 
'''<nowiki>{{Unknown| '' Educated guess '' }}</nowiki>''', where '' Educated guess '' is, of course, your educated guess.
 
'''<nowiki>{{Unknown| '' Educated guess '' }}</nowiki>''', where '' Educated guess '' is, of course, your educated guess.
  
====== Strings, Literals and Constants ======
+
===== Strings, Literals and Constants =====
  
 
Literal strings, such as "Hello world" or "Wuzup?" should use the '''{{[[Template:Constant|Constant]]}}''' template and should be enclosed within parenthesis following the field description. E.g.<br>
 
Literal strings, such as "Hello world" or "Wuzup?" should use the '''{{[[Template:Constant|Constant]]}}''' template and should be enclosed within parenthesis following the field description. E.g.<br>
Line 159: Line 159:
 
'''<nowiki>{{Constant|("Hello world" null 21)}}</nowiki>'''
 
'''<nowiki>{{Constant|("Hello world" null 21)}}</nowiki>'''
  
====== Inline Comments ======
+
===== Inline Comments =====
  
 
Any short notes should be enclosed in parenthesis and use the '''{{[[Template:InlineComment|InlineComment]]}}''' template after the field description, e.g.<br>
 
Any short notes should be enclosed in parenthesis and use the '''{{[[Template:InlineComment|InlineComment]]}}''' template after the field description, e.g.<br>
 
'''<nowiki>{{InlineComment|(This is a comment)}}</nowiki>'''. Longer notes should go in the "Notes and Comments" section.
 
'''<nowiki>{{InlineComment|(This is a comment)}}</nowiki>'''. Longer notes should go in the "Notes and Comments" section.
  
====== Inline Math ======
+
===== Inline Math =====
  
 
Any math notes pertaining to the value of a field (e.g. (FieldVal + 32) / 4 = FileSize) should use the '''{{[[Template:FieldMath|FieldMath]]}}''' template and be enclosed in square brackets, e.g. (if given field should be multiplied by 2):<br>
 
Any math notes pertaining to the value of a field (e.g. (FieldVal + 32) / 4 = FileSize) should use the '''{{[[Template:FieldMath|FieldMath]]}}''' template and be enclosed in square brackets, e.g. (if given field should be multiplied by 2):<br>
Line 180: Line 180:
 
Basically, it's just high school algebra all over again. New magic words/symbols will be christened as needed.
 
Basically, it's just high school algebra all over again. New magic words/symbols will be christened as needed.
  
===== Notes and Comments =====
+
==== Notes and Comments ====
  
 
  <nowiki>=== Notes and Comments ===</nowiki>
 
  <nowiki>=== Notes and Comments ===</nowiki>
 
  None
 
  None
  
====== Subheadings ======
+
===== Subheadings =====
  
 
You can create new section headings in this section, if necessary. If you do this, you should start with level four headings, e.g.<br>
 
You can create new section headings in this section, if necessary. If you do this, you should start with level four headings, e.g.<br>
Line 191: Line 191:
 
and working farther in (with level five, etc. headings) if necessary. You can name these section headings whatever way suits you best, so long as they are somewhat descriptive of the notes in that section.
 
and working farther in (with level five, etc. headings) if necessary. You can name these section headings whatever way suits you best, so long as they are somewhat descriptive of the notes in that section.
  
===== BMS Script =====
+
==== BMS Script ====
  
 
  <nowiki>=== MultiEx BMS Script ===</nowiki>
 
  <nowiki>=== MultiEx BMS Script ===</nowiki>
Line 213: Line 213:
 
will work perfectly fine.
 
will work perfectly fine.
  
===== Program Support =====
+
==== Program Support ====
  
 
  <nowiki>=== Supported by Programs ===</nowiki>
 
  <nowiki>=== Supported by Programs ===</nowiki>
Line 241: Line 241:
 
  <nowiki>* [[FooBar3000]]</nowiki>
 
  <nowiki>* [[FooBar3000]]</nowiki>
  
===== External Links and Documentation =====
+
==== External Links and Documentation ====
  
 
  <nowiki>=== Links ===</nowiki>
 
  <nowiki>=== Links ===</nowiki>
 
  None
 
  None
  
===== Games =====
+
==== Games ====
  
 
  <nowiki>=== Games ===
 
  <nowiki>=== Games ===
Line 253: Line 253:
 
Each game listed here should link to its own page. If a game is for a non-PC platform, it should have the platform it's for in parenthesis following the game name, e.g. '''<nowiki>[[Sample Game 1 (PS2)]]</nowiki>''' or '''<nowiki>[[Sample Game 1 (Gamecube)]]</nowiki>'''. Before you do this, be absolutely sure that the game title is spelled correctly, etc. Also, each extension used by the given game for that format should link to its own page, as seen above.
 
Each game listed here should link to its own page. If a game is for a non-PC platform, it should have the platform it's for in parenthesis following the game name, e.g. '''<nowiki>[[Sample Game 1 (PS2)]]</nowiki>''' or '''<nowiki>[[Sample Game 1 (Gamecube)]]</nowiki>'''. Before you do this, be absolutely sure that the game title is spelled correctly, etc. Also, each extension used by the given game for that format should link to its own page, as seen above.
  
===== Footer and Categories =====
+
==== Footer and Categories ====
  
 
  {{[[Template:GRAFPageFooter|GRAFPageFooter]]}}
 
  {{[[Template:GRAFPageFooter|GRAFPageFooter]]}}
Line 291: Line 291:
 
See also: [[GRAFTemplate1_Help]]
 
See also: [[GRAFTemplate1_Help]]
  
=== The Last Step ===
+
== The Last Step ==
  
 
Once you've finished your new page, [http://wiki.xentax.com/index.php?title=Template:Latest_Grafs&action=edit edit] the [[Template:Latest Grafs|Latest Grafs]] section on the front page. When doing so, add the link to your new page(s) to the top of the list, and remove an entry or entries from the bottom of the list until it has exactly ten entries again.
 
Once you've finished your new page, [http://wiki.xentax.com/index.php?title=Template:Latest_Grafs&action=edit edit] the [[Template:Latest Grafs|Latest Grafs]] section on the front page. When doing so, add the link to your new page(s) to the top of the list, and remove an entry or entries from the bottom of the list until it has exactly ten entries again.
  
 
[[Category:Tutorials]]
 
[[Category:Tutorials]]
 +
-->

Latest revision as of 10:49, 21 October 2011