Project:Wiki Conventions: Difference between revisions

Update documentation based on recent discussions. Removed To Dos from Testing entry because those already are on the template documentation. About Emu Info, please improve, its description is not that good currently...
m (Text replacement - "game covers" to "covers")
(Update documentation based on recent discussions. Removed To Dos from Testing entry because those already are on the template documentation. About Emu Info, please improve, its description is not that good currently...)
Line 35: Line 35:
*<var>|forumlink =</var> The forum link directs the user to the forum thread that has the same wiki page embedded within it. It is just a straight up URL to the wiki page.
*<var>|forumlink =</var> The forum link directs the user to the forum thread that has the same wiki page embedded within it. It is just a straight up URL to the wiki page.


=== Patches ===
=== Emulation Information ===
The patches area is generally absent of most game pages, but if you have links to HD texture packs or Gecko/AR codes that overcome emulation issues, make titles run at higher frame rates or allow using wider Aspect Ratios, you can add them in that section. If the game article doesn't have that section yet, feel free to create it, right before Problems section. Please note that any AR/Gecko code that doesn't fit in any of these categories are '''not allowed''' and should not be included in this wiki.
This area is generally composed of {{tl|Problems}} templates regarding behaviors or information that aren't necessarily emulation issues (e.g. GameCube titles that have native widescreen support, details of Wii titles that accept different input methods, titles with shader compilation stuttering, etc). Information present on this area shouldn't be taken in consideration when assigning a compatibility rating of a given title and this section is absent from the page if there's no suitable entries for that game.
 
=== 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 the title of the problem crossed out with the {{tl|s}} template (<nowiki>=== {{s}}like this{{/s}} ===</nowiki>), 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 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 the title of the problem crossed out with the {{tl|s}} template (<nowiki>=== {{s}}like this{{/s}} ===</nowiki>), 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.
Line 44: Line 44:


Anytime a revision is mentioned, it should use the {{tl|revision}} template. It would appear like this in the editor: <nowiki>{{revision|3.5-500}}</nowiki>.
Anytime a revision is mentioned, it should use the {{tl|revision}} template. It would appear like this in the editor: <nowiki>{{revision|3.5-500}}</nowiki>.
=== Enhancements ===
The enhancements area is generally absent of most game pages, but if you have links to HD texture packs or Gecko/AR codes that overcome emulation issues, make titles run at higher frame rates or allow using wider Aspect Ratios, you can add them in that section. 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.


=== Configuration ===
=== Configuration ===
Line 68: Line 71:
**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.
*<var>|OS=</var> 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).
*<var>|OS=</var> The OS (Windows, Mac OS X, 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.10).
**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 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, Mac, 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.
**The Dolphin executable is presumed to align with the OS (i.e. an x86 executable isn't being used under a x64 platform).
**Omit OS package modifiers (i.e.  Home Premium, Professional, etc.). These typically have no impact on Dolphin behavior.
*<var>|CPU=</var> The title of the CPU vendor (AMD, Intel, ?) 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, ?) 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.
**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.
Line 89: Line 90:
*<var>|result=</var> An English description of the test results. Linking to video of results is appropriate.
*<var>|result=</var> An English description of the test results. Linking to video of results is appropriate.
*<var>|tester=</var> A wiki user name or other identifier used to identify multiple tests performed.
*<var>|tester=</var> A wiki user name or other identifier used to identify multiple tests performed.
==== To Do ====
*Need to access and list alternate architectures (i.e. ARM?, etc.)
*Include some of this as documentation on {{tl|Test Entry}}


=== Gameplay Screenshots ===
=== Gameplay Screenshots ===
Line 119: Line 116:


=== Description and Infobox===
=== Description and Infobox===
To do.


=== List ===
=== List ===
To do.


== Images ==
== Images ==