Difference between revisions of "Help:Adding a format"

From XentaxWiki
Jump to: navigation, search
m
m
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]].''
 +
 
== Introduction ==
 
== Introduction ==
<div style="float:right;margin-left:10px;background-color:#EEEEEE;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>
 
<br>
 
<br>
 
'''What about multiple versions of the same game?'''<br>
 
'''What about multiple versions of the same game?'''<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>
 
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>
<br>
 
'''What if the format I'm adding is already in the WIKI?'''<br>
 
If the format you want to add is already in the WIKI, all you have to do is add the game's name and link to the GRAFs page, as described here, then navigate to that format's preexisting page and add your game(s) to the 'Games' section at the bottom.
 
 
</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.
 
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.
  
The first thing you will need to do is [http://wiki.xentax.com/index.php?title=GRAFs&action=edit edit] the [[GRAFs]] page and add the title of the game to the list. The current list is sorted alphabetically, so please follow that convention!
+
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 you pass the search test (i.e. the game isn't on the WIKI), you will next need to [http://wiki.xentax.com/index.php?title=GRAFs&action=edit edit] 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 your format is for a game demo, as opposed to the full version, please place the following label immediately after the name:
 
If your format is for a game demo, as opposed to the full version, please place the following label immediately after the name:
Line 50: Line 51:
  
 
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:
 
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:
  <nowiki>{{GRAFTemplate1</nowiki>|
+
  <nowiki>{{GRAFPageHeader}}</nowiki>
  file_extension='''FILE EXTENSION'''|
+
   
  format_type='''Archive'''|
+
== FILE EXTENSION ==
  endian_order='''Little Endian'''|
+
<nowiki>{{GRAFPageMisc</nowiki>|
  date_posted=<nowiki>~~~~~</nowiki>|
+
  format='''Archive'''|
  format_specifications='''None written yet.'''|
+
  endian='''Little Endian'''|
  notes='''None'''|
+
  date_posted=<nowiki>~~~~~</nowiki>}}
  bms_script='''Not written yet'''|
+
  programs='''None'''|
+
  === Format Specifications ===
  documentation='''None'''|
+
<nowiki>{{GRAFPageFormat</nowiki>|'''None written yet.'''}}
  games='''None'''
+
  }}
+
  === Notes and Documentation ===
 +
'''None'''
 +
   
 +
=== MultiEx BMS Script ===
 +
'''Not written yet'''
 +
   
 +
=== Programs ===
 +
'''None'''
 +
   
 +
=== Links ===
 +
'''None'''
 +
   
 +
=== Games ===
 +
'''None'''
 +
   
 +
=== See Also ===
 +
'''None'''
 
For now, instructions on how to fill out this template may be found [[GRAFTemplate1_Help|here]].
 
For now, instructions on how to fill out this template may be found [[GRAFTemplate1_Help|here]].
  

Revision as of 02:23, 20 November 2006

This page isn't complete and could definitely be improved. Make changes yourself, or suggest them on the talk page.

Introduction

FAQ

What about multiple versions of the same game?
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.

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.

First and foremost, make sure the format you want to add isn't already on the WIKI. You can do this by searching for the game's title or any strings in the format (for instance, header strings) and examining any results that come up.

If you pass the search test (i.e. the game isn't on the WIKI), you will next need to edit 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 your format is for a game demo, as opposed to the full version, please place the following label immediately after the name:

{{DemoTag}}

This will result in: Template:DemoTag
If you pay attention, you'll note that some names have a colored game platform name/abbreviation following them, and before the format link(s). If your format is for a console game (not for the PC), please use the correct tag after the name, as follows:

Dreamcast: {{DreamcastTag}}
Gamecube:  {{GamecubeTag}}
PS2:       {{PS2Tag}}
PSP:       {{PSPTag}}
X-Box:     {{XBoxTag}}

To request tags for additional platforms, please leave a comment on the Talk:Adding a Format page.
This will result in one of the following labels: Template:DreamcastTag Template:GamecubeTag Template:PS2Tag Template:PSPTag Template:XBoxTag

Samples:

Naming 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.

  • 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 not for the PC, you will next want to include what system it's for.
  • Lastly, include (in all caps) the extension for the format.

In the label for the link, include each extension that uses that format in lower-case letters. Examples:

  • [[Sample Game ARCHIVE001|*.archive001]]
  • [[Sample Game PS2 ARCHIVE001|*.archive001]]
  • [[Sample Game XBOX ARCHIVE001|*.archive001 *.xyz *.zzz]]
  • [[Sample Game (Demo) GAMECUBE ARCHIVE001|*.archive001 *.xyz *.zzz]]

Should you be adding multiple formats for the same game on the same system, please start a seperate page for each format. Each seperate link should be included in its own set of parenthesis after the game title/platform tag, as follows:

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:

{{GRAFPageHeader}}

== FILE EXTENSION ==
{{GRAFPageMisc|
format=Archive|
endian=Little Endian|
date_posted=~~~~~}}

=== Format Specifications ===
{{GRAFPageFormat|None written yet.}}

=== Notes and Documentation ===
None

=== MultiEx BMS Script ===
Not written yet

=== Programs ===
None

=== Links ===
None

=== Games ===
None

=== See Also ===
None

For now, instructions on how to fill out this template may be found here.

The Last Step

Once you've finished your new page, edit the 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.