Dolphin Emulator Wiki

Project:Wiki Conventions: Difference between revisions

Project page Discussion

Project:Wiki Conventions (view source)

Revision as of 16:27, 21 January 2013

903 bytes added ,  21 January 2013
Some minor tweaks, elaborated Gameplay Screenshot section a bit more... Update to Gameplay Videos section coming soon
(Some minor tweaks, elaborated Gameplay Screenshot section a bit more... Update to Gameplay Videos section coming soon)
Line 17: Line 17:


=== Infobox ===
=== Infobox ===
Infoboxes use the {{tl|Infobox VG}} template, have a bunch of options. Most of the general information bits can be taken straight off wikipedia with minimal fuss, except for images: wikipedia's are too small for us. Ideally all of these bits of information will be filled but it's not necessary.
Infoboxes use the {{tl|Infobox VG}} template, have a bunch of options. Most of the general information bits can be taken straight off wikipedia with minimal fuss, except for images: Wikipedia's are too small for us. Ideally all of these bits of information will be filled but it's not necessary.


*<tt>|image =</tt> must have the thumbnail size tag based on software type. We use 300px size for GameCube and Wii games, 350px size for Wii Channels screenshots and 160px size for WiiWare titles. If you image doesn't resize, only add some garbage in the end of tag such as the image name (for example <nowiki>[[File:FlingSmash.jpg‎|300px|FlingSmash]]</nowiki>). Cover preference order would be: US NTSC, UK PAL, Other PAL, JP, Other.
*<tt>|image =</tt> must have the thumbnail size tag based on software type. We use 300px size for GameCube, Wii and Virtual Console games, 350px size for Wii Channels screenshots and 160px size for WiiWare titles. If you image doesn't resize, only add some garbage in the end of tag such as the image name (i.e. <tt><nowiki>[[File:FlingSmash.jpg‎|300px|FlingSmash]]</nowiki></tt>). Cover preference order would be: US NTSC, UK PAL, Other PAL, JP, Other.


*<tt>|developer =</tt> and <tt>|publisher = </tt> Only use developers and publishers for the Dolphin released versions. You can either just list the information, or use <nowiki><br /></nowiki> for multiple, or use the {{tl|vgrelease}} template to divide out regions.
*<tt>|developer =</tt> and <tt>|publisher = </tt> Only use developers and publishers for the Dolphin released versions. You can either just list the information, or use <nowiki><br /></nowiki> for multiple, or use the {{tl|vgrelease}} template to divide out regions.
**Example of the vgrelease template use for developers or publishers -  
**Example of the {{tl|vgrelease}} template use for developers or publishers -  


*<tt>|series = </tt> Series are <nowiki>''italized''</nowiki>.
*<tt>|series = </tt> Series are <nowiki>''italized''</nowiki>.


*<tt>|release =</tt> Release dates use the {{tl|vgrelease}} template, and should be in chronological order. We cut out any outside systems from our release date entries, as it doesn't matter to us when a game came out on the PS2, for example. Usually we can copy paste these straight off wikipedia, but if the page uses the "vgrelease new" template, it'll have to be adapted.
*<tt>|release =</tt> Release dates use the {{tl|vgrelease}} template, and should be in chronological order. We cut out any outside systems from our release date entries, as it doesn't matter to us when a game came out on the PS2, for example. Usually we can copy paste these straight off Wikipedia, but if the page uses the <nowiki>{{vgrelease new}}</nowiki> template, it'll have to be adapted.


:The final code for a release date will look something like the below. Note that the last call is disconnected from the others; sometimes it has to be done to keep the list in chronological order.
:The final code for a release date will look something like the below. Note that the last call is disconnected from the others; sometimes it has to be done to keep the list in chronological order.
::<pre>{{vgrelease|JP=December 5, 2009|EU=July 9, 2010|AUS=September 23, 2010}}{{vgrelease|NA=November 1, 2010}}</pre>
::<pre>{{vgrelease|JP=December 5, 2009|EU=July 9, 2010|AUS=September 23, 2010}}{{vgrelease|NA=November 1, 2010}}</pre>


*<tt>|genre =</tt> Just get it off wikipedia. Should list just the "genre", not "genre game" (i.e. "Action" instead of "Action game"). Should be plain text, and not contain wiki/html markup.
*<tt>|genre =</tt> Just get it off Wikipedia. Should list just the "genre", not "genre game" (i.e. "Action" instead of "Action game"). Should be plain text, and not contain wiki/html markup.


*<tt>|modes =</tt> Simple-player, Multiplayer, Co-op, Online. That's all the modes we use here. Modes are presented one after another, with a comma between, going through in that order.
*<tt>|modes =</tt> Simple-player, Multiplayer, Co-op, Online. That's all the modes we use here. Modes are presented one after another, with a comma between, going through in that order.


*<tt>|input =</tt> Displays all input combinations, shown with commas inbetween. For example: '''Wii Remote, Wii Remote + Nunchuk, GameCube Controller, Classic Controller'''. Wikipedia doesn't have this information, but a quick google or looking up a review will usually find it very easily. The Wii Zapper, Wii Wheel, and the like are accessories for controllers and not controllers themselves, so they should not be included.
*<tt>|input =</tt> Displays all input combinations, shown with commas inbetween. For example: '''Wii Remote, Wii Remote + Nunchuk, GameCube Controller, Classic Controller'''. Wikipedia doesn't have this information, but a quick Google or looking up a review will usually find it very easily. The Wii Zapper, Wii Wheel, and the like are accessories for controllers and not controllers themselves, so they should not be included.


*<tt>|forumlink =</tt> The forum link directs the user to the forum thread that has the same wiki page embedded within it.
*<tt>|forumlink =</tt> The forum link directs the user to the forum thread that has the same wiki page embedded within it.


=== Problems ===
=== Problems ===
The problems area is a list of problems that affect the current Git version. If a problem is fixed in the current Git version but is still in the current Release version, it should be moved to the bottom and crossed out, with a note on when and how it was fixed if that info is known. Each problem is listed on its own without grouping, to make it easier to deal with. Problems are generally ordered with the most severe ones first, such as crashing or hanging bugs, then going to down to the least severe. Fixed problems are at the bottom. If the problem have screenshot showing the issue, the screenshot should be included using [[Template:Image]] and must have a caption (the caption is mandatory and should be a small description of the problem -- captions bigger than one line will be automatically truncated).  
The problems area is a list of problems that affect the current Git version. If a problem is fixed in the current Git version but is still in the current Release version, it should be moved to the bottom and crossed out, with a note on when and how it was fixed if that info is known. Each problem is listed on its own without grouping, to make it easier to deal with. Problems are generally ordered with the most severe ones first, such as crashing or hanging bugs, then going to down to the least severe. Fixed problems are at the bottom. If the problem have screenshot showing the issue, the screenshot should be included using {{tl|Image}} template and must have a caption (mandatory) with a small description of the problem. Captions bigger than one line will be automatically truncated.  


=== Configuration ===
=== Configuration ===
Line 49: Line 49:
Performance information, like telling users to go with EFB to Texture because it works fine, shouldn't be included. The principle is that if a more compatible isn't mentioned, then the high performance setting should work ok. If an unusual setting improves performance and does nothing else, it still shouldn't be included here, but a note may be placed elsewhere in the article (such as in a problem related to it) or in testing.
Performance information, like telling users to go with EFB to Texture because it works fine, shouldn't be included. The principle is that if a more compatible isn't mentioned, then the high performance setting should work ok. If an unusual setting improves performance and does nothing else, it still shouldn't be included here, but a note may be placed elsewhere in the article (such as in a problem related to it) or in testing.


Hacks not related to compatibility should also be left off the configuration list. For example, if someone turns on the widescreen hack or 3D  
Hacks not related to compatibility should also be left off the configuration list. For example, if someone turns on the widescreen hack or 3D Vision, they know what they are getting, and we don't need to tell them not to turn it on cause it might glitch out. The exception to that is if it causes something usual, like a crash.
Vision, they know what they are getting, and we don't need to tell them not to turn it on cause it might glitch out. The exception to that is if it causes something usual, like a crash.


Please do not use this area for recommended control configurations. What buttons are assigned to what role varies based on the game, the console, the controller the player is using, and personal tastes. It is up to the user to figure that out.
Please do not use this area for recommended control configurations. What buttons are assigned to what role varies based on the game, the console, the controller the player is using, and personal tastes. It is up to the user to figure that out.
Line 64: Line 63:
Test entries using the {{tl|Test Entry}} template with a full set of options, should be inserted after the blank entry comment. Options should include:
Test entries using the {{tl|Test Entry}} template with a full set of options, should be inserted after the blank entry comment. Options should include:
*<tt>|revision=</tt> The Dolphin revision used for testing (i.e. 3.0-543, 3.0, 7342).
*<tt>|revision=</tt> The Dolphin revision used for testing (i.e. 3.0-543, 3.0, 7342).
**Fed through the {{tl|revision}} template.
**Fed through the {{tl|Revision}} template.
**Categories will automatically be generated to indicate testing on major revisions: 2.0, 3.0.
**Categories will automatically be generated to indicate testing on major revisions: 2.0, 3.0.
*<tt>|OS=</tt> The OS (Windows, Mac OS X, Linux <build/vendor>), OS version (i.e. XP, 7, 10.6.8) and related CPU architecture (x86, x64/x86_64, ?) used for testing (i.e. Windows 7 x64, Linux Ubuntu 10.10 x86_64).
*<tt>|OS=</tt> The OS (Windows, Mac OS X, Linux <build/vendor>), OS version (i.e. XP, 7, 10.6.8) and related CPU architecture (x86, x64, x86_64, ?) used for testing (i.e. Windows 7 x64, Linux Ubuntu 10.10 x86_64).
**Linux users use x86_64, rather than x64, to distinguish alternate 64bit architectures.
**Linux users use x86_64, rather than x64, to distinguish alternate 64 bit architectures.
**Categories will automatically be generated to indicate testing on the related OS, if it includes: Windows, Mac, Linux.
**Categories will automatically be generated to indicate testing on the related OS, if it includes: Windows, Mac, Linux.
**The Dolphin executable is presumed to align with the OS (i.e. an x86 executable isn't being used under a x64 platform).
**The Dolphin executable is presumed to align with the OS (i.e. an x86 executable isn't being used under a x64 platform).
Line 75: Line 74:
**Omit the text: ™, ®, Processor.
**Omit the text: ™, ®, Processor.
**Categories will automatically be generated to indicate testing on the related CPU  vendor.
**Categories will automatically be generated to indicate testing on the related CPU  vendor.
**Indicate overclocked CPUs with a "@ #GHz" postfix listing the overclocked frequency (i.e. Intel Core i7-960 @ 3.4GHz).
**Indicate CPU speed with a "@ #GHz" postfix listing the stock or overclocked frequency (i.e. Intel Core i7-960 @ 3.4GHz, Intel Core 2 Duo E8600 @ 3.3GHz).
*<tt>|GPU=</tt> The title of the GPU vendor (AMD, ATI, Intel, nVidia) and GPU (i.e. GeForce 580) used for testing (i.e. nVidia GeForce 580).
*<tt>|GPU=</tt> The title of the GPU vendor (AMD, ATI, Intel, nVidia) and GPU (i.e. GeForce 580) used for testing (i.e. nVidia GeForce 580).
**Align with names used in: [http://ark.intel.com/ Intel Product Listing], [http://www.amd.com/us/products/ AMD Product Listing], [http://www.nvidia.com/page/products.html#PROCESSOR-FAMILIES nVidia Product Listing], or other official vendor product listings.
**Align with names used in: [http://ark.intel.com/ Intel Product Listing], [http://www.amd.com/us/products/ AMD Product Listing], [http://www.nvidia.com/page/products.html#PROCESSOR-FAMILIES nVidia Product Listing], or other official vendor product listings.
Line 92: Line 91:


=== Gameplay Screenshots ===
=== Gameplay Screenshots ===
The screenshots area uses [[Template:Image]], see it for usage details. Please note that captions mustn't be included, doing this will make the template produce thumbnails using the standard reserved for bug images.
The screenshots area uses the {{tl|Image}} template. This section can have countless screenshots, and every screenshot is added by including the code <tt><nowiki>{{Image|<Filename.png>}}</nowiki></tt>.
* In the last screenshot, you must add an <tt>||br}}</tt> to prevent floating elements issues (i.e. <tt><nowiki>{{Image|<Filename.png>||br}}</nowiki></tt>)
* Screenshots taken with Dolphin (pressing F9 while playing the game) are preferred.
* Screenshots with different Aspect Ratio may cause floating elements issues. To avoid this, any game doesn't support widescreen [16:9] '''natively''' (without Widescreen hack) should have only fullscreen [4:3] thumbnails. If the game support both modes, all screenshots should be in widescreen format.
* If for some reason, a screenshot with different aspect ratio must be included, the override parameter <tt>|width=</tt> must be included and adjusted in this specific screenshot until it get the same height size of the other thumbnails (refer to [[Template:Image#Notes|template documentation]] for more details).


=== Gameplay Videos ===
=== Gameplay Videos ===
Retrieved from "https://wiki.dolphin-emu.org/index.php?title=Special:MobileDiff/53361"