420
edits
Project:Wiki Conventions: Difference between revisions
Jump to navigation
Jump to search
→Problems: Show what {{revision}} renders as
(→Infobox: release dates must use vgrelease, so it's worth capturing that information here, even if it's a little redundant) |
(→Problems: Show what {{revision}} renders as) |
||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
This is a generalized outline of how things are done here on the Dolphin Emulator Wiki. These are all "common law" concepts; no one has ever set in stone how these things work, they are simply what has grown out of the wiki over its many years of existence. And they will continue to evolve as the wiki grows, and this page will be updated periodically to reflect the changes that have occurred. These conventions are not "rules" in any sense of the word, but guidelines, instructions, and help for those new to the wiki. | This is a generalized outline of how things are done here on the Dolphin Emulator Wiki. These are all "common law" concepts; no one has ever set in stone how these things work, they are simply what has grown out of the wiki over its many years of existence. And they will continue to evolve as the wiki grows, and this page will be updated periodically to reflect the changes that have occurred. These conventions are not "rules" in any sense of the word, but guidelines, instructions, and help for those new to the wiki. | ||
Our mission is to be the best resource for accurate and up-to-date Dolphin information. Everything on the wiki is built around that goal. As such, pages, problems, ratings, and everything else on the wiki is aimed at the very latest | Our mission is to be the best resource for accurate and up-to-date Dolphin information. Everything on the wiki is built around that goal. As such, pages, problems, ratings, and everything else on the wiki is aimed at the very latest development release, updating and changing based on what goes on with development. Furthermore, accuracy matters, and anything that can be reproduced is favored, and subjective information is avoided. | ||
== Ratings == | == Ratings == | ||
| Line 13: | Line 13: | ||
=== Infobox === | === Infobox === | ||
Infoboxes use the {{tl|Infobox VG}} template, and have | 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. | ||
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]]. | |||
*<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. | ||
| Line 24: | Line 25: | ||
*<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 wiki/html markup. Please use spelling and capitalization from [[:Category:Genres]]. | ||
*<var>|modes =</var> Information of possible modes of play of the title. [[: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 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. | ||
| Line 38: | Line 39: | ||
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 (mandatory) 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}}. | |||
=== Enhancements === | === Enhancements === | ||
| Line 68: | Line 69: | ||
Test entries using the {{tl|Testing/entry}} template with a full set of required parameters, should be inserted after the blank entry comment. Options should include: | Test entries using the {{tl|Testing/entry}} template with a full set of required parameters, should be inserted after the blank entry comment. Options should include: | ||
*<var>|revision=</var> The Dolphin revision used for testing (i.e. | *<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. | *<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.6.8) used for testing (i.e. Windows 7, Ubuntu 10.10, Mac OS X 10.11 | |||
**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, | *<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 | **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 the text: ™, ®, 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.4GHz, Intel Core 2 Duo E8600 @ 3.3GHz). | |||
**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 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, omitting the text: ™, ®. | ||
**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. | **Omit any speed/overclocking information on GPUs. | ||
** | **Use chipset vendor names (Intel, NVIDIA, AMD, ATI) rather than the board vendor names (i.e. Asus, VisionTek). | ||
**Use chipset vendor names (Intel, NVIDIA, AMD, ATI) rather than the board vendor names (i.e. Asus, VisionTek | |||
**Categories will automatically be generated to indicate testing on the related GPU vendor. | **Categories will automatically be generated to indicate testing on the related GPU vendor. | ||
*<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. | ||
| Line 92: | Line 87: | ||
=== Gameplay Videos === | === Gameplay Videos === | ||
Only include video links by using the {{tl|VideoGallery}} template. Please note that only 3 thumbnails will be shown here, '''even if the page has more than 3 videos''', and additional videos will show up as links below the thumbnails. The template pseudo-randomly chooses which 3 videos will appear as thumbnails, so the order of the videos in the gallery does not effect which will appear. | |||
For more details, read the [[Template:VideoGallery|template documentation]]. | For more details, read the [[Template:VideoGallery|template documentation]]. | ||
| Line 114: | Line 109: | ||
== Formatting == | == Formatting == | ||
=== Disagreements === | === Disagreements === | ||
If two editors are changing things back and forth in a disagreement, they need to STOP and head to the talk pages. | If two editors are changing things back and forth in a disagreement, they need to STOP and head to the talk pages. Disagreements need to be settled with communication and compromises. | ||