Help:Contributing: Difference between revisions

Updated links and images
(→‎Creating new articles: Updated article naming conventions)
(Updated links and images)
 
(11 intermediate revisions by the same user not shown)
Line 1:
Welcome to the Sly Cooper Modding Wiki{{SITENAME}}! Our focus is on technical documentation of the Sly Cooper games to aid in makingdeveloping mods and modding tools. IfCheck youout wouldthe likearticles to contribute but aren’t sure where to start, keep readingbelow for howrules toand getediting startedhelp.
 
{{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. If you have any questions or concerns feel free to contact a wiki administrator.
# 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.
 
==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 and prevent people from doing the same work over and over, thereby making it quicker and easier to make mods.
 
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.
 
===Adding images===
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]]
 
When uploading images, please follow these guidelines:
* For in-game screenshots, use native resolution PNG images if possible
* Use descriptive files names, eg. {{color|limegreen|Sly 1 May Proto Debug Menu.png}} instead of {{color|red|SCREENSHOT_202207050937.PNG}}.
 
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===
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.
 
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!
 
===Citing Sources===
You can cite sources using ref tags. 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
 
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.
 
==Editing guidelines==
===Creating new articles===
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 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}}.