Project:Wiki Conventions: Difference between revisions

m
More minor adjustments
(Various minor adjustments and updates)
m (More minor adjustments)
Line 1: Line 1:
--THIS IS A WORK IN PROGRESS--
--THIS IS A WORK IN PROGRESS--


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. So 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 Git 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.
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 Git 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.
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. Wikipedia, GameTDB.com, and Nintendo.com's gameguide are our primary sources for information.
Infoboxes use the {{tl|Infobox VG}} template, and 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 required. Wikipedia, GameTDB.com, and Nintendo.com's gameguide are our primary sources for information.


*<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 your 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>|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 your 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.
Line 39: Line 39:


=== 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 (<nowiki>=== <s>like this</s> ===</nowiki>) crossed out, with a note in the problem 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 has a 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.
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 (<nowiki>=== <s>like this</s> ===</nowiki>), with a note in the problem 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 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.


=== Configuration ===
=== Configuration ===
Line 46: Line 46:
Each configuration entry should include a "notes" entry with a short explanation of the addressed issue(s).
Each configuration entry should include a "notes" entry with a short explanation of the addressed issue(s).


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 is assumed to work fine. 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 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.
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.