Help:Wiki Conventions: Difference between revisions

Help page
(→‎Creating Game Articles: Provided link to new page with instructions)
(Improved documentation and added link to 'Using Talk Pages' article as well)
Line 3: Line 3:
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.
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|to-do list]] for list of functionalities to be added and pages that require updation in the wiki.
To get started, please visit the [[Help:Contents|Help section]] that contains a list of articles aimed to address most problems that users may face and provide valuable information regarding RPCS3 and this wiki.


== Formatting ==
== Formatting ==
Line 10: Line 10:
== Creating Game Articles ==
== Creating Game Articles ==
Instructions on how to create new pages for games that are not present in this wiki can be found [[Help:Creating New Game Pages|here]].
Instructions on how to create new pages for games that are not present in this wiki can be found [[Help:Creating New Game Pages|here]].
<!--  
 
== Images ==
== Using Talk Pages ==
Instructions on properly use talk pages in this wiki can be found [[Help:Using Talk Pages|here]].
 
<!-- == Images ==
The sidebar has an '''''Upload file''''' link, use that to upload images. So we can actually find the images, they should be appropriately named, and they should have categories for whatever they are mentioned in the summary. Below are the most commonly used image categories.
The sidebar has an '''''Upload file''''' link, use that to upload images. So we can actually find the images, they should be appropriately named, and they should have categories for whatever they are mentioned in the summary. Below are the most commonly used image categories.


Line 17: Line 20:
* Screenshots showcasing emulation problems: <code><nowiki>[[Category:Bug images]]</nowiki></code>
* Screenshots showcasing emulation problems: <code><nowiki>[[Category:Bug images]]</nowiki></code>
-->
-->
== 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 [https://en.wikipedia.org/wiki/Wikipedia:Talk_page_guidelines 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 <code><nowiki>== level 2 heading ==</nowiki></code> at the bottom of the page (or use the "Add topic" tab).
* Indent replies with colons (<code>:</code>) at the beginning of the line.
* Always sign your name after your comments. Use the four tildes "<code><nowiki>~~~~</nowiki></code>" wiki syntax (or the signature button in the toolbar above the editing textbox). For more information see the user guide for [https://www.mediawiki.org/wiki/Help:Signatures signatures].
Here is an example discussion, following the talk page conventions:
{| class="wikitable"
!style="width:50%" |Wiki text
!style="width:50%" |Rendered talk page
|-
|
<code><nowiki>== Code == </nowiki></code><br>
<code><nowiki>How's the code? --~~~~</nowiki></code><br>
<code><nowiki>: It's great!! --~~~~</nowiki></code><br>
<code><nowiki>:: I made it myself! --~~~~</nowiki></code><br>
<code><nowiki>I think the code-discussion should be moved to Talk:Github.. --~~~~</nowiki></code><br>
|
<span style= font:"Linux Libertine, Georgia, Times, serif"; font-size:120%;>'''Code'''</span>
----
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 <nowiki>"[piracy links removed by ~~~~]"</nowiki>.
Refer [https://en.wikipedia.org/wiki/Wikipedia:Talk_page_guidelines#Editing_others'_comments 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 ==
== 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.
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 [https://wiki.dolphin-emu.org/index.php?title=Project:Wiki_Conventions Dolphin Emulator Wiki] released under the [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-ShareAlike 3.0 License].

Revision as of 19:29, 22 May 2019

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.

To get started, please visit the Help section that contains a list of articles aimed to address most problems that users may face and provide valuable information regarding RPCS3 and this 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

Instructions on how to create new pages for games that are not present in this wiki can be found here.

Using Talk Pages

Instructions on properly use talk pages in this wiki can be found here.

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.