Difference between revisions of "Contributing"
(Created page with "=Overview= This page lists useful information for community members looking to contribute to the p2sr wiki. =Image Uploads= In an effort to reduce loading times for the pages...") |
|||
| Line 1: | Line 1: | ||
| − | =Overview= | + | {{P2_Title|Contributing}} |
| − | This page lists useful information for community members looking to contribute to the | + | ==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 informations== |
| − | 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. | + | ===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 <code>Edit page</code> link in your <code>Tools</code> 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 [https://www.mediawiki.org/wiki/Help:Links official MediaWiki help page about formatting]. | |
| + | ===Links=== | ||
| + | Same as above. Go [https://www.mediawiki.org/wiki/Help:Links 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=== | ||
| + | In an effort to reduce loading times for the pages, <code>.jpg</code> images are preferred over <code>.png</code> 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: | ||
<noinclude> | <noinclude> | ||
<pre> | <pre> | ||
| − | {{ | + | {{P2_Image|image.jpg|Descriton}} |
| − | + | ||
| − | }} | + | ...or... |
| − | |||
| − | |||
| − | + | [[File:image.jpg|thumb|Description]] | |
| − | |||
| − | |||
| − | |||
</pre> | </pre> | ||
</noinclude> | </noinclude> | ||
| − | |||
| − | |||
===Videos=== | ===Videos=== | ||
Sidevideo template (Preferred) | Sidevideo template (Preferred) | ||
| Line 38: | Line 42: | ||
</pre> | </pre> | ||
</noinclude> | </noinclude> | ||
| − | === | + | ===Gallery=== |
| + | <noinclude> | ||
| + | <pre> | ||
| + | <gallery widths=300px> | ||
| + | File:image1.jpg|thumb|Description | ||
| + | File:image2.jpg|thumb|Description | ||
| + | </gallery> | ||
| + | </pre> | ||
| + | </noinclude> | ||
| + | ==Headers== | ||
| + | On default, pages do not contain their title in it to allow customization in this regard. For that, we use one of [https://www.mediawiki.org/wiki/Help:Templates wiki templates] created specifically for that purpose. | ||
| + | ===Image + Info Bar Header (typical for a map page)=== | ||
<noinclude> | <noinclude> | ||
<pre> | <pre> | ||
| − | {{ | + | {{P2_Infobox|Page Title|image.jpg| |
| − | + | *''Entry Upper'' Entry Lower | |
| − | + | }} | |
| − | |||
| − | |||
</pre> | </pre> | ||
</noinclude> | </noinclude> | ||
| − | + | ===Title Header (typical for a glitch writeup)=== | |
| − | === | ||
<noinclude> | <noinclude> | ||
<pre> | <pre> | ||
| − | + | {{P2_Title|Page Title}} | |
| − | |||
| − | |||
| − | |||
</pre> | </pre> | ||
</noinclude> | </noinclude> | ||
| − | ==Map | + | ==Map page template== |
| − | These are the templates used for maps in | + | 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 <code>#p2sr:</code> sections use Krzyhau's plugin to fetch WR data from iVerb, or a Least Portals spreadsheet. Other games are not currently supported. | The <code>#p2sr:</code> sections use Krzyhau's plugin to fetch WR data from iVerb, or a Least Portals spreadsheet. Other games are not currently supported. | ||
| − | |||
<noinclude> | <noinclude> | ||
<pre> | <pre> | ||
| Line 88: | Line 96: | ||
</pre> | </pre> | ||
</noinclude> | </noinclude> | ||
| − | |||
===Coop=== | ===Coop=== | ||
| − | |||
<noinclude> | <noinclude> | ||
<pre> | <pre> | ||
| Line 114: | Line 120: | ||
</pre> | </pre> | ||
</noinclude> | </noinclude> | ||
| + | ==Additional Info== | ||
| + | In case of any doubt or question, contact <code>bigdaniel#9055</code> or <code>Krzyhau#8514</code> on Discord. | ||
Revision as of 04:53, 7 November 2020
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 informations
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.
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
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|Descriton}}
...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 widths=300px> 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
*''Native to Challenge Mode''
*''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.