Project:Wiki Conventions: Difference between revisions

Jump to navigation Jump to search
Updates for the new release numbering and minor cleanups
m (#GHz -> # GHz)
(Updates for the new release numbering and minor cleanups)
 
Line 10: Line 10:
== Game Articles ==
== Game Articles ==
=== Description ===
=== Description ===
A description can be anything the editor wants. But generally, they should be brief but include some basic information about what the game is and what its gameplay is like. Usually we put the name of the game fairly early in the description, and put it in '''''<nowiki>'''''bold italics'''''</nowiki>'''''. Links to relevant articles, such as prequels or the system the game is on, are always good. Most of the time we just pull descriptions from wikipedia and tweak them a bit, removing things like references to other systems and release dates or other info covered in the infobox.
A description can be anything the editor wants. But generally, they should be brief but include some basic information about what the game is and what its gameplay is like. Usually we put the name of the game fairly early in the description, and put it in '''''<nowiki>'''''bold italics'''''</nowiki>'''''. Links to relevant articles, such as prequels or the system the game is on, are always good. Most of the time we just pull descriptions from Wikipedia and tweak them a bit, removing things like references to other systems and release dates or other info covered in the infobox.


=== Infobox ===
=== Infobox ===
Infoboxes use the {{tl|Infobox VG}} template, and have various 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 required. [https://en.wikipedia.org/ Wikipedia], [https://www.gametdb.com/ GameTDB], [https://gamefaqs.gamespot.com/ GameFAQs], and [https://www.nintendo.com/games/ Nintendo.com's gameguide] are our primary sources for information.
Infoboxes use the {{tl|Infobox VG}} template, and have various 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 required. [https://en.wikipedia.org/ Wikipedia], [https://www.gametdb.com/ GameTDB], [https://gamefaqs.gamespot.com/ GameFAQs], and [https://www.nintendo.com/games/ Nintendo] are our primary sources for information.


These are the rules for Infoboxes used on game pages. For complete details of how to use the Infobox template, read its [[Template:Infobox VG|template documentation]].
These are the rules for Infoboxes used on game pages. For complete details of how to use the Infobox template, read its [[Template:Infobox VG|template documentation]].
Line 19: Line 19:
*<var>|image =</var> Provide thumbnail size tag based on software type. The standard is: <code>300px</code> for GameCube, Wii and Virtual Console games, <code>350px</code> for Wii Channels screenshots, and <code>160px</code> for WiiWare titles. Cover preference order would be: US NTSC, UK PAL, Other PAL, JP, Other.
*<var>|image =</var> Provide thumbnail size tag based on software type. The standard is: <code>300px</code> for GameCube, Wii and Virtual Console games, <code>350px</code> for Wii Channels screenshots, and <code>160px</code> for WiiWare titles. Cover preference order would be: US NTSC, UK PAL, Other PAL, JP, Other.


*<var>|developer =</var> and <var>|publisher = </var> Only use developers and publishers of Dolphin emulated platforms. For instance, the PlayStation 2 and XBOX version of [[Mortal Kombat: Armageddon]] was developed by ''Midway'', but the Wii version was developed by ''Just Games Interactive'', so in this case only ''Just Games Interactive'' should be included.
*<var>|developer =</var> and <var>|publisher = </var> Only use developers and publishers of Dolphin emulated platforms. For instance, the PlayStation 2 and Xbox version of [[Mortal Kombat: Armageddon]] was developed by ''Midway'', but the Wii version was developed by ''Just Games Interactive'', so in this case only ''Just Games Interactive'' should be included.


*<var>|released =</var> 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 PlayStation 2, for example. Usually we can copy paste these straight off Wikipedia.
*<var>|released =</var> 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 PlayStation 2, for example. Usually we can copy paste these straight off Wikipedia.


*<var>|genre =</var> 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. Please use spelling and capitalization from [[:Category:Genres]].
*<var>|genre =</var> 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 MediaWiki/HTML markup. Please use spelling and capitalization from [[:Category:Genres]].


*<var>|modes =</var> Information of possible modes of play of the title; see template documentation for valid parameters. [[:Category:Utility (Genre)|Utility]] titles don't need this information.
*<var>|modes =</var> Information of possible modes of play of the title; see template documentation for valid parameters. [[:Category:Utility (Genre)|Utility]] titles don't need this information.


*<var>|input =</var> Displays all input combinations of the title. Wikipedia doesn't have this information, but gametdb.com and game reviews will have it. The Wii Zapper, Wii Wheel, and the like are accessories for controllers and not controllers themselves, so they should not be included.
*<var>|input =</var> Displays all input combinations of the title. Wikipedia doesn't have this information, but [https://www.gametdb.com/ GameTDB] and game reviews will have it. The Wii Zapper, Wii Wheel, and the like are accessories for controllers and not controllers themselves, so they should not be included.


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


=== Problems ===
=== Problems ===
The problems area is a list of problems that affect the current development version. If a problem is fixed in the current development version but is still in the latest stable version, it should be moved to the bottom and the title of the problem crossed out with the slash <code><nowiki><s></nowiki></code> tags, <code><nowiki>=== <s>like this</s> ===</nowiki></code>, with a note in the problem on when and how it was fixed if that info is known. Once a Release occurs all existing fixed problems are purged, so it is vital to fill out when and why a problem was fixed so it can be cleared later. 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.
The problems area is a list of problems that affect the current development version. If a problem is fixed in the current development version but is still present in the latest release version, it should be moved to the bottom of this area and the title of the problem crossed out with the slash <code><nowiki><s></nowiki></code> tags, <code><nowiki>=== <s>like this</s> ===</nowiki></code>, with a note in the problem on when and how it was fixed if that info is known. Once a new release is published, all existing fixed problems are purged, so it is vital to fill out when and why a problem was fixed so it can be cleared later. 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 has a screenshot showing the issue, the screenshot should be included using {{tl|Image}} template and must have a caption (mandatory) with a brief description of the image. Captions bigger than one line will be automatically truncated.
If the problem has a screenshot showing the issue, the screenshot should be included using {{tl|Image}} template and must have a caption with a brief description of the image. Captions bigger than one line will be automatically truncated.


Any time a revision is mentioned, it should use the {{tl|revision}} template. It would appear like this in the page source: <code><nowiki>{{revision|5.0-6000}}</nowiki></code>, which renders as {{revision|5.0-6000}}.
Any time a revision is mentioned, it should use the {{tl|revision}} template. It would appear like this in the page source: <code><nowiki>{{revision|5.0-6000}}</nowiki></code>, which renders as {{revision|5.0-6000}}.
Line 47: Line 47:
*Gecko/AR codes that overcome emulation issues, make titles run at higher frame rates or allow using wider Aspect Ratios
*Gecko/AR codes that overcome emulation issues, make titles run at higher frame rates or allow using wider Aspect Ratios


If the game article doesn't have that section yet, feel free to create it, right after Problems section. Please note that any AR/Gecko code that doesn't fit in any of those categories are '''not allowed''' and '''should not''' be included in this wiki.
If the game article doesn't have that section yet, feel free to create it, right after Problems section. When including an AR/Gecko code, make sure to explicitly mention what type of code is it (e.g. "This AR Code disables culling when using the Widescreen Hack", or "this Gecko Code removes the 30 FPS lock"). Please note that any AR/Gecko code that doesn't fit in any of the previously mentioned categories are '''not allowed''' and '''should not''' be included in this wiki.


=== Configuration ===
=== Configuration ===
Line 71: Line 71:
*<var>|revision=</var> The Dolphin revision used for testing (i.e. 5.0-6000).
*<var>|revision=</var> The Dolphin revision used for testing (i.e. 5.0-6000).
**Categories will automatically be generated to indicate testing on major revisions: 2.0, 3.0, 3.5, 4.0, and 5.0.
**Categories will automatically be generated to indicate testing on major revisions: 2.0, 3.0, 3.5, 4.0, and 5.0.
*<var>|OS=</var> The OS (Windows, Mac OS X, macOS, Linux, Android) and OS version (i.e. Vista, 7, 10.6.8) used for testing (i.e. Windows 7, Ubuntu 10.10, Mac OS X 10.11, macOS 10.12).
*<var>|OS=</var> The OS (Windows, Mac OS X, macOS, Linux, Android) and OS version (i.e. Vista, 7, 10.11, 13.04) used for testing (i.e. Windows 7, Ubuntu 13.04, Mac OS X 10.11, macOS 10.12).
**Categories will automatically be generated to indicate testing on the related OS, if it includes Windows, macOS or Android. Anything else is assumed to be a Linux distro and thus is tagged as tested on Linux.
**Categories will automatically be generated to indicate testing on the related OS, if it includes Windows, macOS or Android. Anything else is assumed to be a Linux distro and thus is tagged as tested on Linux.
**Omit OS package modifiers (i.e. Home Premium, Professional, etc.) and edition names (i.e. Yosemite, Trusty Tahr, etc.). These have no impact on Dolphin behavior.
**Omit OS package modifiers (i.e. Home Premium, Professional, etc.) and edition names (i.e. Yosemite, Trusty Tahr, etc.). These have no impact on Dolphin behavior.
*<var>|CPU=</var> The title of the CPU vendor (AMD, Intel, etc.) and CPU (i.e. Core i7-960) used for testing (i.e. Intel Core i7-960).
*<var>|CPU=</var> The title of the CPU vendor (AMD, Intel, etc.) and CPU (i.e. Core i7-960) used for testing (i.e. Intel Core i7-960).
**Align with names used in: [http://ark.intel.com/ Intel Product Listing], [http://www.amd.com/us/products/ AMD Product Listing], or other official vendor product listings, omitting non-ASCII and other texts including: ™, ®, Processor, or AMD's "Black"/"Black Edition" identifiers.
**Align with names used in: [http://ark.intel.com/ Intel Product Listing], [http://www.amd.com/us/products/ AMD Product Listing], or other official vendor product listings, omitting non-ASCII and other texts including: ™, ®, Processor, or AMD's "Black"/"Black Edition" identifiers.
**Include CPU speed with a "@ # GHz" postfix listing the stock or overclocked frequency (i.e. Intel Core i7-960 @ 3.4 GHz, Intel Core 2 Duo E8600 @ 3.3 GHz).
**Include CPU speed with a "@ # GHz" postfix listing the base or overclocked frequency (i.e. Intel Core i7-960 @ 3.4 GHz, Intel Core 2 Duo E8600 @ 3.3 GHz).
**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.
*<var>|GPU=</var> The title of the GPU vendor (AMD, ATI, Intel, NVIDIA) and GPU (i.e. GeForce GTX 580) used for testing (i.e. NVIDIA GeForce GTX 580).
*<var>|GPU=</var> The title of the GPU vendor (AMD, ATI, Intel, NVIDIA) and GPU (i.e. GeForce GTX 580) used for testing (i.e. NVIDIA GeForce GTX 580).

Navigation menu