Help:Contributing: Difference between revisions

Updated links and images
(Changed wording)
(Updated links and images)
 
(6 intermediate revisions by the same user not shown)
Line 1:
Welcome to {{SITENAME}}! Our focus is on technical documentation of the Sly Cooper games to aid in developing mods and modding tools. IfCheck you'dout likethe toarticles contributebelow butfor aren’trules sureand whereediting to start, keep reading belowhelp.
 
{{Subpage|Rules and content policy|Please read these before editing!|image=[[File:Bentley icon.png|50px]]}}
== Content Policy ==
{{Subpage|Creating new articles|Detailed instructions for how to create new articles on the wiki. |image=[[File:Bentley icon.png|50px]]}}
When adding new content to the wiki, please abide by the following rules:
{{Subpage|Editing help|Helpful information for editing, adding images, citing sources, and more. |image=[[File:Clue icon.png|50px]]}}
# No copyrighted content – Do not post any copyrighted game code, assets, or content from other websites without the proper license/attribution.
{{Subpage|Image guidelines|Instructions for how to upload and properly use images on the wiki. |image=[[File:Photographer disguise icon.svg|50px]]}}
# Keep it relevant – Please only add content that is relevant to modding and reverse-engineering the Sly Cooper games.
{{Subpage|How to contribute|If you'd like to contribute to the wiki but aren't sure how, start here. |image=[[File:Insanity strike icon.svg|50px]]}}
# Be respectful – Please be respectful of other users and their contributions. Edit warring, personal attacks, and other disrespectful behavior are not acceptable.
# When in doubt, ask for help - If you aren't sure how to do something, or whether something is allowed, you can always ask for help on Discord or ask an administrator on their talk page.
 
== Editing guidelines ==
=== Creating new articles ===
 
==== Article naming ====
When creating new articles, use sentence case for the title unless it is a proper noun.
: E.g. {{Color|limegreen|Sly 2:Entity swap tutorial}}, not {{Color|red|Sly 2:Entity Swap Tutorial}}.
 
==== Namespaces ====
Articles should go in the namespace for the game in the series they relate to. Those namespaces are <code>Sly 1</code>, <code>Sly 2</code>, <code>Sly 3</code>, and <code>Sly 4</code>. For instance, if you are making an article for a game mechanic in Sly 1, put the article in the Sly 1 namespace. That just means putting <code>Sly 1:</code> at the beginning of the article title.
* e.g. If you create an article for the [[Sly 1:Difficulty|Difficulty mechanic in Sly 1]], name the article {{Color|limegreen|Sly 1:Difficulty}}, not {{Color|red|Difficulty}} or {{Color|red|Difficulty (Sly 1)}}. If you are writing about the [[Sly 2:Difficulty|Difficulty mechanic in Sly 2]], name the article {{Color|limegreen|Sly 2:Difficulty}}.
If you come across an article in the wrong namespace, you can rename it by mousing over the the '''More''' menu at the top-right of the page and clicking '''Move'''.
 
=== Uploading images ===
If you can improve the wiki by adding an image, please do so! When in doubt, adding an image that may need to be replaced later is better than having no image if it will improve the article.
 
==== Image guidelines ====
When uploading images, please follow these guidelines:
* The preferred file type is PNG. Please do not upload JPEG images unless the only available file is a JPEG and there is no alternative.
* For in-game screenshots, capture the screenshot at the native resolution. This can be done by setting your PCSX2 resolution to PS2 (Native) and capturing the screenshot through PCSX2 directly.
** If you only have a screenshot that is non-native resolution and you are unable to take a new one, you can upload it as long as it is a PNG. Just put {{Tlc|Replace image|Not native resolution}} in the image description and someone will eventually come along to replace it it.
* Use descriptive files names, eg. {{color|limegreen|Sly 1 May demo debug menu.png}} instead of {{color|red|SCREENSHOT_202207050937.PNG}}.
 
=== Citing Sources ===
You can cite sources using ref tags. If you come across a statement that should have a citation but doesn't, add the {{tl|Citation needed}} tag for future editors. If you come across a {{Citation needed|nocat=y}} tag and you are able to add a source, please do so!
 
==== Citing websites ====
If you’re in a hurry, you can just include the URL of the source. If you have time, please include the article title, publication name, and date published as follows:
<pre><ref name=“sly 4 review”>[https://www.ign.com/articles/2010/11/17/the-sly-collection-review?amp=1 The Sly Collection Review] - IGN, 4 May 2012</ref></pre>
 
The above code will add a reference to the bottom of the page that looks like this:
 
:[https://www.ign.com/articles/2010/11/17/the-sly-collection-review?amp=1 The Sly Collection Review] - IGN, 4 May 2012
 
==== Citing the games ====
If the information you are citing is coming directly from one of the games, you can use the template {{tl|Sly 1}}, {{tl|Sly 2}}, {{tl|Sly 3}}, or {{tl|Sly 4}} in the reference. For instance:
 
<pre><nowiki><ref>{{Sly 1}} - Developer commentary for ''Into The Machine''</ref></nowiki></pre>
 
This will be displayed as:
:{{Sly 1}} - Developer commentary for ''Into The Machine''
 
==== References section ====
If you includes references on an article, put a References section at the bottom of the page, like this:
<pre><nowiki>
== References ==
<references/>
</nowiki></pre>
 
Put it after all the other sections but before any maintenance or navigation templates. If you do not include the <nowiki><references/></nowiki> tag somewhere in the article, the references will show up at the very bottom of the page, meaning they'll be below any templates like {{tl|stub}} or {{tl|Navbox Sly 1}}.
 
== How to contribute ==
=== Documenting game content ===
Documentation is the core focus of this wiki. If, through modding or reverse-engineering, you learn some new technical information about a file format, game mechanic, or something along those lines, please add it! The goal is to make information readily accessible so it is quicker and easier to make mods.
 
If you have something to add something but there is no page for it, feel free to create one! Even if it’s very short, just add the {{tl|stub}} tag to the bottom of the page, and eventually someone will come along and expand it. If you'd like to research something but don't know where to start, check out [[:Category:Stubs|Category:Stubs]] for short articles that need to be expanded.
 
=== Fact-checking ===
One way to improve the wiki is by fact-checking statements to confirm their accuracy. The category [[:Category:Articles needing fact-checking]] contains a list of pages with statements that need to be checked. If you are adding something to an article and you aren't 100% sure it's correct, add the {{tl|check}} tag so everyone knows it is unconfirmed.
 
If you are able to confirm something is true, simply remove the {{check|nocat=y}} tag or replace it with a [[#Citing sources|citation]]. If you check a statement and find out that it’s incorrect, feel free to correct or remove it!
 
=== Adding images ===
If an article has no images it is usually a good idea to add some. This is typically just means taking a screenshot in [[Wikipedia:PCSX2|PCSX2]] and uploading it. A list of articles that need images can be found at [[:Category:Articles needing images|Category:Articles needing images]].
 
See the section above for guidelines and help for uploading images.