Wiki Conventions

From RPCS3 Wiki
Jump to: navigation, search

This is a generalized outline of how things are done here on the RPCS3 wiki. These conventions are meant to guidelines, instructions, and help for those new to the wiki. These guidelines will continue to evolve as the wiki grows, and this page will be updated periodically to reflect the changes that have occurred.

Contributions are always welcome on the wiki. Our mission is to be the best resource for accurate and up-to-date RPCS3 information. Everything on the wiki is built around that goal. As such, pages, problems 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.

Also, see our to-do list for list of functionalities to be added and pages that require updation in the wiki.

Formatting

All pages and templates of this wiki are written using wiki markup. Consult the Users' Guide for information on using the wiki software and text markup. Do familiarise yourself with the various markups present in formatting and links help pages. The best way to get up to speed with the formatting is to read other pages in the wiki. When in doubt, feel free to use the talk page found in the discussion tab above the page title. Please adhere to the specific markup requirements for the talk pages mentioned below.

Creating Game Articles

Before creating a new game page, check the games category to confirm that the page for such game does not already exist. Only one game page is created for all versions of a game. This means that all region IDs, demos, DLCs and special editions of a game will be grouped together in the same game page (see Find a game that does this).

Currently we are only creating game pages for games "playable" as per the compatibility list.

To create a new game page, enter the game name as the page title. If a game has multiple titles in various languages, please use the english one in the page title. Where more than one english title exists, use the one that is more common (generally the US version). Once the page has been created, enter {{subst:newgame}} in the page and save to populate the default templates and sections for game pages. To prevent spam and incorrect page creation, all edits must be approved by a moderator prior to taking effect. Hence, when creating a new game page, users may have to wait until approval fill the populated templates and sections.

Infobox

This is the box on the right-hand side of the page which summarises the basic information of the game. The infobox is also linked to its own set of categories which allows you to find games with similar information in a convenient manner. Game infoboxes use the vginfobox template, which contains parameters requiring various details. For guidance on how to fill the template, kindly read the documentation provided in its template page along with vgregion and gameid templates.

Description

A description 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 '''''bold italics'''''. Links to relevant articles, such as prequels or sequels, 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 information already covered in the infobox.

Configuration

This section uses the configuration template to capture non-default settings for maximum emulation accuracy or explicitly broken enhancement options on game pages. The complete list of default settings can be found here. An ideal configuration setup lists all the settings needed for flawless emulation regardless of performance. Each configuration entry can also include a "notes" entry to highlight any necessary information or explain the issue(s) addressed.

Recommendatory settings, like telling users with weaker CPUs to try Lower SPU thread priority, shouldn't be included. Such guidance applies to all games and has already been covered in the default settings pages. Also, if an unusual setting improves performance and does nothing else, it still shouldn't be included here, but a note may be placed under the Special Notes section.

Other improvements not related to compatibility should also be left off the configuration list. For example, if someone turns on the Anisotropic filter, they know what they are getting into. The exception to that is if it toggling such settings causes issues, like a crash or unusual sprites.

Please do not use this area for recommended controller configurations. What buttons are assigned to which binding varies based on the game, the controller being used, and personal tastes. It is up to users to figure that out.

Known Issues

This section should contain a list of issues that affect the latest master. Do not post issues here without discussing the same on forums and discord. Also, read the issue tracker on Github to check if such issues have been reported. Most problems users face can be resolved by using the appropriate settings for that title. If you are convinced the issue is valid, only document issues on the wiki after discussing the same with developers or moderators on forums or discord.

Give the issue a title in bold. Where available, use the issues template to link the corresponding issue on Github. If an issue is fixed in the master repo, it should be moved to the bottom and the title of the issue should be crossed out with the slash <s> tags (<s>like this</s>) with a note describing how it was fixed and by which pull request if that info is known. Use the pull request template to link the corresponding PR on Github. On a periodic basis, all existing fixed issues are purged, so it is vital to fill out when and why an issue was fixed so it can be cleared later. Each issue is listed on its own without grouping, to make it easier to deal with. Issues are generally ordered with the most severe ones first, such as crashing or hanging bugs, then going to down to the least severe and fixed issues at the bottom.

Special Notes

This area is used to describe behaviors or information that aren't necessarily emulation issues (e.g. PSN version of Demon's Souls show the Blu-ray version's game ID on the game list, information on patches, etc.) but details which users may find useful. Information present in this section generally shouldn't affect the compatibility status of a given title. This section need not be shown if there's no suitable entries for that game, otherwise it's listed right after the Known Issues section.

Talk pages

Every wiki page has an associated talk page, which can be used for discussion and communicating with other users. Talk pages can be accessed by clicking the "discussion" tab at the top of the page. Having discussions on a free-form wiki page may seem strange at first but the talk pages are a great way to a pointed discussion about a particular page. Please go through the talk page guidelines for a detailed explanation on the conventions. A few broad conventions have been mentioned below.

Basic conventions

While using a talk page, users must follow certain basic conventions such as:

  • Every new discussion must have begin with a == level 2 heading == at the bottom of the page (or use the "Add topic" tab).
  • Indent replies with colons (:) at the beginning of the line.
  • Always sign your name after your comments. Use the four tildes "~~~~" wiki syntax (or the signature button in the toolbar above the editing textbox). For more information see the user guide for signatures.

Here is an example discussion, following the talk page conventions:

Wiki text Rendered talk page

== Code ==
How's the code? --~~~~
: It's great!! --~~~~
:: I made it myself! --~~~~
I think the code-discussion should be moved to Talk:Github.. --~~~~

Code


How's the code? --DH (talk) 18:37, 3 November 2012 (UTC)

It's great!! --Hykem (talk) 18:38, 3 November 2012 (UTC)
I made it myself! --DH (talk) 18:39, 3 November 2012 (UTC)

I think the code-discussion should be moved to Talk:Github.. --AlexAltea (talk) 10:32, 8 September 2013 (UTC)

Editing others' comments

It is not necessary to bring talk pages to publishing standards, so there is no need to correct typing/spelling errors, grammar, etc. It may irritate the users whose comments you are correcting. The basic rule, with some specific exceptions, is that you should NOT edit or delete the comments of other editors without their permission. Never edit or move someone's comment to change its meaning, even on your own talk page.

Generally, you should not break up another editor's text by interleaving your own replies to individual points; this confuses who said what and obscures the original editor's intent. Cautiously editing or removing another editor's comments is sometimes allowed, but normally you should stop if there is any objection. If you make anything more than minor changes it is good practice to leave a short explanatory note such as "[piracy links removed by ~~~~]".

Refer Editing others' comments section of the talk page guidelines for an exhaustive list of scenarios where it may be appropriate to edit another user's post.

Disagreements

If two editors are changing things back and forth in a disagreement, they need to STOP and head to the talk pages. The wiki is entirely open, anyone can edit it, so disagreements need to be settled with communication and compromises.

Attribution and re-use

This page has been adapted from Dolphin Emulator Wiki released under the Creative Commons Attribution-ShareAlike 3.0 License.