Help:Contributing: Difference between revisions

Refactored and expanded article
(→‎Creating new articles: Updated article naming conventions)
(Refactored and expanded article)
Line 1:
Welcome to the Sly Cooper Modding Wiki{{SITENAME}}! Our focus is on technical documentation of the Sly Cooper games to aid in making modsmodding and developing modding tools. If you would like to contribute but aren’t sure where to start, keep reading for how to get started.
 
== Content Policy ==
When adding new content to the wiki, please abide by the following rules:
# No copyrighted content – Do not post any copyrighted game code, assets, or content from other websites without the proper license/attribution.
# Keep it relevant – Please only add content that is relevant to modding and reverse-engineering the Sly Cooper games.
# Be respectful – Please be respectful of other users and their contributions. IfEdit youwarring, havepersonal anyattacks, questionsand orother concernsdisrespectful feelbehavior freeare tonot contact a wiki administratoracceptable.
# 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==
==How to Contribute==
===DocumentingCreating gamenew contentarticles===
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 and prevent people from doing the same work over and over, thereby making it quicker and easier to make mods.
 
==== Article naming ====
If you have something to add something but there is no page for it, 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.
When creating new articles, use sentence case for the title unless it is a proper noun.
: E.g. {{Color|limegreen|Entity swap tutorial}}, not {{Color|red|Entity Swap Tutorial}}).
 
===Adding= imagesNamespaces ====
Articles are grouped by namespace depending on which game they are related to (that's how we get those nifty badges next to the page title). These namespaces are <code>Sly 1</code>, <code>Sly 2</code>, <code>Sly 3</code>, and <code>Sly 4</code>. They are sometimes collectively referred to as ''gamespace''.
If an article has no images it is usually a good idea to add some. This might be as simple as taking a screenshot in PCSX2 and uploading it. A list of articles that need images can be found at [[:Category:Articles with missing images]]
 
If theyou topicare iscreating somethingan thatarticle isfor something relevantrelated to one game in particular, put the article in the namespace for that game. 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 frontbeginning of the article title.
When uploading images, please follow these guidelines:
* e.g. If you atcreate ean writingarticle aboutfor the CM[[Sly struct1:Difficulty|Difficulty]] mechanic in Sly 1, name the article {{Color|limegreen|Sly 1:CMDifficulty}}, not just {{Color|red|CMDifficulty}} or {{Color|red|CMDifficulty (Sly 1)}}. If you are writing about the CMDifficulty struct in Sly 2, name the article {{Color|limegreen|Sly 2:CMDifficulty}}.
* For in-game screenshots, use native resolution PNG images if possible
If you come across an article in the wrong namespace, you can rename it by going to the '''More''' menu at the top-right of the page and clicking '''Move'''.
* Use descriptive files names, eg. {{color|limegreen|Sly 1 May Proto Debug Menu.png}} instead of {{color|red|SCREENSHOT_202207050937.PNG}}.
 
=== 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 at all if it will improve the article.
 
===Fact-checking= Image guidelines ====
When uploading images, please follow these guidelines:
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 and it will automatically add the article to that category.
* 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. Screenshots taken with PCSX2 should always be native resolution.
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 it!
** If you only have a screenshot that is non-native resolution and you are unable to take a new one, you can add 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 fix it.
* Use descriptive files names, eg. {{color|limegreen|Sly 1 May Protodemo Debugdebug Menumenu.png}} instead of {{color|red|SCREENSHOT_202207050937.PNG}}.
 
===Citing Sources===
You can cite sources using ref tags. If you’reyou income across a hurry,statement youthat canshould justhave includea thecitation URLbut doesn't, ofadd the source{{Tl}} tag for future editors. If you havecome time,across pleasea include{{Citation theneeded|nocat=y}} articleand title,you publicationare name,able andto dateadd publisheda source, please asdo follows: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>
 
Line 36 ⟶ 43:
:[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><ref>{{Sly 1}} - Developer commentary for ''Into The Machine''</ref></pre>This will be displayed as:
 
==How to Contributecontribute==
==Editing guidelines==
===CreatingDocumenting newgame articlescontent===
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 andso preventit people from doing the same work over and over, thereby making itis quicker and easier to make mods.
When creating new articles, use sentence case for the title unless it is a proper noun.
 
: E.g. {{Color|limegreen|Entity swap tutorial}}, not {{Color|red|Entity Swap Tutorial}}).
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 andso iteveryone willknows automatically add the article toit thatis categoryunconfirmed.
 
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 mightis be astypically simplejust asmeans taking a screenshot in [[Wikipedia:PCSX2|PCSX2]] and uploading it. A list of articles that need images can be found at [[:Category:Articles withneeding missingimages|Category:Articles needing images]].
 
See the section above for guidelines and help for uploading images.
If the topic is something that is relevant to one game in particular, put the article in the namespace for that game. 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 front of the article title.
* e.g. If you at e writing about the CM struct in Sly 1, name the article {{Color|limegreen|Sly 1:CM}}, not just {{Color|red|CM}} or {{Color|red|CM (Sly 1)}}. If you are writing about the CM struct in Sly 2, name the article {{Color|limegreen|Sly 2:CM}}.