Help:Contributing/Creating new articles: Difference between revisions

From SlyMods
Jump to navigation Jump to search
Content added Content deleted
m (Fixed typo)
(Tweak wording)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
This page will tell you how to create a new article.
This page will tell you how to create a new article, put it in the correct namespace, and use infoboxes/navboxes for organization.


== How to create articles ==
== How to create articles ==
There are two ways to create new articles on {{SITENAME}}
There are two ways to create new articles on {{SITENAME}}.


=== Automatic creation (recommended) ===
=== Automatic creation (recommended) ===
Creating an article is easy if the article you want to create goes in one of the categories on the [[Main Page]]. Just click the correct link on the main page (eg. [[:Category:Mods for Sly 2]]) and use the form at the top of the category page.
Creating an article is simple if the article goes in any of the categories on the [[Main Page]]. Just click the appropriate category on the main page (eg. [[:Category:Mods for Sly 2]]) and use the form at the top of the category page.


Type in the title of the article you want to create and click '''Create'''. This will bring you to a page where you can start typing the article content. It will automatically insert an [[:Category:Infobox templates|infobox template]] at the top of the article where you can type in the main details.
Enter the desired article title click '''Create'''. This will bring you to a page where you can start typing the article content. It will automatically insert an [[:Category:Infobox templates|infobox template]] at the top where you can fill in the main details.


If you use this method, the page will automatically be placed in the correct namespace and categories. All you have to do is actually write the article content. You should also put a navbox at the bottom of the page and add a link to the page to the appropriate navbox (see below for more details).
If you use this method, the page will automatically be placed in the correct namespace and categories. All you have to do is actually write the article content. You should usually also put a navbox template at the bottom of the page, and then edit the navbox itself to add a link to the new page you just created (see below for more details).


=== Manual creation ===
=== Manual creation ===
Start by searching for the name of the article you want to create. If there is no article with that title already, it will show a red link at the top of the search results asking if you want to create that article. Just click that red link and it will bring you to an editor where you can start typing the article.
First, search the wiki for the name of the article you want to create. If there is no article with that title, it will show a red link at the top of the search results asking if you want to create that article. Just click that red link and it will bring you to an editor where you can start typing the article.


If you use this method you will have to type the namespace before the article title. For instance, if you want to create a Sly 2 article, put <code>Sly 2:</code> before the title (see below for more details).
If you use this method you will have to manually do the following:


You will also have to include the correct infobox and navboxes yourself (see below for more details).
* Include the namespace in the article title. The format is <code>Namespace:Article Title</code> (see below for more details).
** Example: If you want to create a Sly 2 article, put <code>Sly 2:</code> before the title.
* Insert the relevant infobox at the top of the article, if applicable. See below for a list of infoboxes.
* Insert any relevant navboxes at the bottom of the article. Then edit the navbox itself to add a link to the new article. See below for a list of navboxes.


== Infoboxes and navboxes ==
== Namespaces ==
When you manually create an article for something specific to a certain game, you should put it in the correct namespace, either <code>Sly 1</code>, <code>Sly 2</code>, <code>Sly 3</code>, or <code>Sly 4</code>. For instance, if you are making an article for a topic in Sly 1, put the article in the <code>Sly 1</code> namespace (i.e. put <code>Sly 1:</code> before the article title.
=== Infoboxes ===

Infoboxes are a type of template that is used to present the most important information at the top of an article. They are also used to automatically place articles in the correct categories.
* 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)}}.
* Likewise, if you create an article for the [[Sly 2:Difficulty|Difficulty mechanic in Sly 2]], name the article {{Color|limegreen|Sly 2:Difficulty}}.

There is also the <code>Guide</code> namespace for any modding guies.

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'''.

== Infoboxes ==
Infoboxes are a type of template that is used to present the most important information in a box at the top of an article. Using one automatically places the article in the correct categories.


If you are creating an article for any of the following topics, you should include one of these infoboxes at the top of the article.
If you are creating an article for any of the following topics, you should include one or more of these infoboxes at the top of the article:
{| class="wikitable"
{| class="wikitable"
|+ Infoboxes
|+ Infoboxes
Line 33: Line 45:
|-
|-
| Subsystems || {{tl|Infobox subsystem}}
| Subsystems || {{tl|Infobox subsystem}}
|-
|Maps || {{tl|Infobox map}}
|-
|Files || {{tl|Infobox file}}
|-
|-
| Game builds || {{tl|Infobox build}}
| Game builds || {{tl|Infobox build}}
|-
|-
| Mods || {{tl|Infobox mod}}
| Mods || {{tl|Infobox mod}}
|-
|Modding guides || {{tl|Infobox guide}}
|-
|-
| Modding tools || {{tl|Infobox tool}}
| Modding tools || {{tl|Infobox tool}}
Line 55: Line 73:
Each infobox has different parameters, so you will have to look at the template page using the links above to see what parameters it uses. Most of them have examples you can copy/paste into your article, but you can also copy one from a different article of the same type and just change the parameters.
Each infobox has different parameters, so you will have to look at the template page using the links above to see what parameters it uses. Most of them have examples you can copy/paste into your article, but you can also copy one from a different article of the same type and just change the parameters.


=== Navboxes ===
== Navboxes ==
Navboxes are a type of template that makes it easy to navigate the wiki. These always go at the very bottom of the article.
Navboxes are a type of template that makes it easy to navigate the wiki. These always go at the very bottom of the article.


If you are creating an article in one of these categories, you should include one of these navboxes at the bottom of the article.
If you are creating an article in any of these categories, you should include one of these navboxes at the bottom of the article:
{| class="wikitable"
{| class="wikitable"
|+ Navboxes
|+ Navboxes
Line 81: Line 99:
|-
|-
| File Formats || {{tl|Navbox file formats}}
| File Formats || {{tl|Navbox file formats}}
|-
|Modding tools
|{{tl|Navbox tools}}
|}
|}


If you add a navbox to an article and that article is not linked from the navbox, you should edit the navbox itself to add a link to the new article.
If you add a navbox to an article and that article is not already linked from the navbox, you should edit the navbox itself to add a link to the new article. To edit the navbox, just click the '''E''' in the top-left corner.

== Namespaces ==
When you manually create an article for something specific to a certain game, you will have to put it in the correct namespace (either <code>Sly 1</code>, <code>Sly 2</code>, <code>Sly 3</code>, or <code>Sly 4</code>). For instance, if you are making an article for a topic in Sly 1, put the article in the <code>Sly 1</code> namespace; That just means putting <code>Sly 1:</code> at the front 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)}}.
: Likewise, if you create an article for 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'''.

Latest revision as of 19:17, 6 June 2024

This page will tell you how to create a new article, put it in the correct namespace, and use infoboxes/navboxes for organization.

How to create articles

There are two ways to create new articles on SlyMods.

Automatic creation (recommended)

Creating an article is simple if the article goes in any of the categories on the Main Page. Just click the appropriate category on the main page (eg. Category:Mods for Sly 2) and use the form at the top of the category page.

Enter the desired article title click Create. This will bring you to a page where you can start typing the article content. It will automatically insert an infobox template at the top where you can fill in the main details.

If you use this method, the page will automatically be placed in the correct namespace and categories. All you have to do is actually write the article content. You should usually also put a navbox template at the bottom of the page, and then edit the navbox itself to add a link to the new page you just created (see below for more details).

Manual creation

First, search the wiki for the name of the article you want to create. If there is no article with that title, it will show a red link at the top of the search results asking if you want to create that article. Just click that red link and it will bring you to an editor where you can start typing the article.

If you use this method you will have to manually do the following:

  • Include the namespace in the article title. The format is Namespace:Article Title (see below for more details).
    • Example: If you want to create a Sly 2 article, put Sly 2: before the title.
  • Insert the relevant infobox at the top of the article, if applicable. See below for a list of infoboxes.
  • Insert any relevant navboxes at the bottom of the article. Then edit the navbox itself to add a link to the new article. See below for a list of navboxes.

Namespaces

When you manually create an article for something specific to a certain game, you should put it in the correct namespace, either Sly 1, Sly 2, Sly 3, or Sly 4. For instance, if you are making an article for a topic in Sly 1, put the article in the Sly 1 namespace (i.e. put Sly 1: before the article title.

There is also the Guide namespace for any modding guies.

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.

Infoboxes

Infoboxes are a type of template that is used to present the most important information in a box at the top of an article. Using one automatically places the article in the correct categories.

If you are creating an article for any of the following topics, you should include one or more of these infoboxes at the top of the article:

Infoboxes
Category Infobox template
Game mechanics {{Infobox game mechanic}}
Data structures {{Infobox data structure}}
Subsystems {{Infobox subsystem}}
Maps {{Infobox map}}
Files {{Infobox file}}
Game builds {{Infobox build}}
Mods {{Infobox mod}}
Modding guides {{Infobox guide}}
Modding tools {{Infobox tool}}

Here is an example of how to include an infobox in an article if you are using the source editor:

{{Infobox mod
| name= Freecam Mod
| image= File:Sly 1 Burning Rubber zoomout.png
| creator= TheOnlyZac
| version= NTSC-U
| releasedate= December 29, 2020
| download= https://example.com/download
}}

Each infobox has different parameters, so you will have to look at the template page using the links above to see what parameters it uses. Most of them have examples you can copy/paste into your article, but you can also copy one from a different article of the same type and just change the parameters.

Navboxes

Navboxes are a type of template that makes it easy to navigate the wiki. These always go at the very bottom of the article.

If you are creating an article in any of these categories, you should include one of these navboxes at the bottom of the article:

Navboxes
Category Navbox template
Sly 1 Articles {{Navbox Sly 1}}
Sly 1 Maps {{Navbox Sly 1 maps}}
Sly 2 Articles {{Navbox Sly 2}}
Sly 2 Maps {{Navbox Sly 2 maps}}
Sly 3 Articles {{Navbox Sly 3}}
Sly 3 Maps {{Navbox Sly 3 maps}}
Sly 4 Articles {{Navbox Sly 4}}
Sly 4 Maps {{Navbox Sly 4 maps}}
File Formats {{Navbox file formats}}
Modding tools {{Navbox tools}}

If you add a navbox to an article and that article is not already linked from the navbox, you should edit the navbox itself to add a link to the new article. To edit the navbox, just click the E in the top-left corner.