6,576
edits
Project:Wiki Conventions: Difference between revisions
Jump to navigation
Jump to search
m
no edit summary
mNo edit summary |
mNo edit summary |
||
| 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 39: | 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. | ||
Anytime 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- | Anytime 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>. | ||
=== Enhancements === | === Enhancements === | ||
| Line 69: | 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. | ||
**Omit the text: ™, ®, Processor, or AMDs "Black"/"Black Edition" identifiers. | **Omit the text: ™, ®, Processor, or AMDs "Black"/"Black Edition" identifiers. | ||
| Line 87: | Line 86: | ||
**Omit the text: ™, ®. | **Omit the text: ™, ®. | ||
**Omit any overclocking on GPUs. | **Omit any overclocking on GPUs. | ||
**List specific | **List specific model of the card instead of series (i.e. "NVIDIA GeForce 560" not "NVIDIA GeForce 500 Series"). | ||
**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 93: | Line 92: | ||
=== Gameplay Videos === | === Gameplay Videos === | ||
Only include video links by using | 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]]. | ||