Contributing

From P2SR Wiki

Revision as of 23:13, 16 April 2021 by AMJ (talk | contribs) (grammar and marking changes for others)

Contributing

Overview

Since this project is meant to be community-driven, everyone is allowed and encouraged to create and edit articles. It is, however, required to create an account, so your changes can be easily tracked and verified. This page lists useful information for all community members looking to contribute to the P2SR Wiki.

General Information

Creating/Editing page

Every page that is not protected can be edited by everyone with an user account. All you have to do is to click the Edit page link in your Tools menu. In order to create new page, type the name of the page in the search bar, then on search result page click the page creation link. Please note that all your contributions may be edited, altered, or removed by other contributors or moderators. Nonetheless, it is encouraged to create new content, as long as you're knowledgeable about the topic you write about and you can provide accurate informations.

Formatting

This wiki uses MediaWiki markup. For more informations, visit official MediaWiki help page about formatting.

Marking changes for others

If you're not knowledgeable enough to write a section, mark it in red for someone else to update. This is done with

<pre style="color:red">Text</pre>

Example:

Include seamshot coordinates. How precise is it exactly?

Code/Data Formatting

Cvars, coordinates, commands etc should be code blocked to look like this. This is not done natively through mediawiki specific syntax, but rather the HTML code tag. See the following example.

<code>your text here</code>

Links

Same as above. Go here for more informations.

Media

While MediaWiki provides multiples of way to include medias, we are limiting ourselves to several methods in order to keep consistency between pages, as well as avoid unnecessary mess.

Uploading medias

To upload files to the wiki, click on the TOOLS dropdown, and select Upload File.

In an effort to reduce loading times for the pages, .jpg images are preferred over .png images, as their smaller size makes page loading quicker, and most images do not need to be too high in detail. While it is possible, it is discouraged to upload videos to the wiki and use video sharing services like YouTube instead.

Images

In order to include image on the page, use one of those methods:

{{P2_Image|image.jpg|Description}}

...or...

[[File:image.jpg|thumb|Description]]

Videos

Sidevideo template (Preferred)

{{P2_Video|url=https://www.youtube.com/watch?v=SqVYod0wIk0|desc=Video Description|time=0}}

Inline Video (Specific Use cases)

{{#ev:youtube|https://www.youtube.com/watch?v=SqVYod0wIk0}}

Gallery

<gallery>
File:image1.jpg|thumb|Description
File:image2.jpg|thumb|Description
</gallery>

Headers

On default, pages do not contain their title in it to allow customization in this regard. For that, we use one of wiki templates created specifically for that purpose.

Image + Info Bar Header (typical for a map page)

{{P2_Infobox|Page Title|image.jpg|
*''Entry Upper'' Entry Lower
}}

Title Header (typical for a glitch writeup)

{{P2_Title|Page Title}}

Map page template

These are the templates used for maps in singleplayer and coop. Map pages can be added for mods in the future with enough community interest.

Singleplayer

The #p2sr: sections use Krzyhau's plugin to fetch WR data from iVerb, or a Least Portals spreadsheet. Other games are not currently supported.

{{P2_Infobox|Map Name|Map_sp_.jpg|
*''File name'' sp_
*''Appearance'' Chapter Name
*''Native to Challenge Mode'' 
*''World record:'' {{#p2sr:wr|sp: map name}}
*''Least portals:'' {{#p2sr:lp|sp: map name}}
}}

=Overview=

=General Route=

=Challenge Mode Specific=

=Full Game Specific=

==Full Game Dialogue==

=History=

Coop

{{P2_Infobox|Map Name|Map_mp_coop.jpg|
*''File name'' mp_coop_
*''Appearance'' Chapter Name
*''World record:'' {{#p2sr:wr|coop: map name}}
*''Least portals:'' {{#p2sr:lp|coop: map name}}
}}

=Overview=

=General Route=

=Challenge Mode Specific=

=Full Game Specific=

==Full Game Dialogue==

=History=

Additional Info

In case of any doubt or question, contact bigdaniel#9055 or Krzyhau#8514 on Discord.