Difference between revisions of "Contributing"

From P2SR Wiki

m (infobox format)
m (no discrims)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{P2_Title|Contributing}}
 
{{P2_Title|Contributing}}
−
==Overview==
+
=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.
 
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.
 
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 a user account. All you have to do is to click the <code>Edit page</code> link in your <code>TOOLS</code> menu. Certain preferences can be modified [[Special:Preferences#mw-prefsection-editing|here]].
 +
 +
In order to create new page, type the name of the page in the search bar, then on the search results page click the page creation link.
  
−
==General Information==
+
Please note that all your contributions may be edited, altered, or removed by other contributors or moderators. Nevertheless, it is encouraged to create new content, as long as you're knowledgeable about the topic you write about and can provide accurate 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 <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===
 
===Formatting===
−
This wiki uses MediaWiki markup. For more informations, visit [https://www.mediawiki.org/wiki/Help:Links official MediaWiki help page about formatting].
+
This wiki uses MediaWiki markup. For more information, visit [https://www.mediawiki.org/wiki/Help:Links the MediaWiki help page about formatting].
−
 
 
 
=== Marking changes for others ===
 
=== 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
+
If you're not knowledgeable enough to write a section, mark it in red for someone else to update. This is done like so:
  
 
<code><nowiki><pre style="color:red">Text</pre></nowiki></code>
 
<code><nowiki><pre style="color:red">Text</pre></nowiki></code>
  
 
Example:
 
Example:
−
 
 
<pre style="color:red">Include seamshot coordinates. How precise is it exactly?</pre>
 
<pre style="color:red">Include seamshot coordinates. How precise is it exactly?</pre>
−
 
 
===Code/Data Formatting===
 
===Code/Data Formatting===
−
Cvars, coordinates, commands etc should be code blocked to look like <code>this</code>. This is not done natively through mediawiki specific syntax, but rather the HTML code tag. See the following example.
+
Cvars, coordinates, commands etc. should be code blocked to look like <code>this</code>. This is not done natively through MediaWiki specific syntax, but rather the HTML code tag. See the following example.
−
<pre>
+
<pre><code>your text here</code></pre>
−
<code>your text here</code>
 
−
</pre>
 
−
 
 
 
===Links===
 
===Links===
−
Same as above. Go [https://www.mediawiki.org/wiki/Help:Links here] for more informations.
+
Same as above. Go [https://www.mediawiki.org/wiki/Help:Links here] for more information.
−
==Media==
+
=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.
+
While MediaWiki provides multiple ways to include media, we are limiting ourselves to several methods in order to keep consistency between pages, as well as to avoid unnecessary mess.
−
===Uploading medias===
+
===Uploading media===
−
To upload files to the wiki, click on the ''TOOLS'' dropdown, and select ''Upload File''.
+
To upload files to the wiki, click on the <code>TOOLS</code> dropdown, and select ''Upload File''.
  
−
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.
+
In an effort to reduce loading times for the pages, <code>.jpg</code> images are generally preferred over <code>.png</code> images, as 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.
+
While it is possible, it is discouraged to upload videos to the wiki. Use video sharing services like YouTube instead.
 
===Images===
 
===Images===
−
In order to include image on the page, use one of those methods:
+
In order to include images on a page, use one of those methods:
 
<pre>
 
<pre>
 
{{P2_Image|image.jpg|Description}}
 
{{P2_Image|image.jpg|Description}}
−
 
+
                OR
−
...or...
 
−
 
 
 
[[File:image.jpg|thumb|Description]]
 
[[File:image.jpg|thumb|Description]]
 
</pre>
 
</pre>
−
 
 
===Videos===
 
===Videos===
−
Sidevideo template (Preferred)
+
Side Video (Preferred)
−
<pre>
+
<pre>{{P2_Video|url=https://www.youtube.com/watch?v=aaaaaaaaaaa|time=0|desc=Video Description}}</pre>
−
{{P2_Video|url=https://www.youtube.com/watch?v=SqVYod0wIk0|desc=Video Description|time=0}}
+
Inline Video (Specific use-cases)
−
</pre>
+
<pre>{{#ev:youtube|youtu.be/aaaaaaaaaaa}}</pre>
−
Inline Video (Specific Use cases)
 
−
<pre>
 
−
{{#ev:youtube|https://www.youtube.com/watch?v=SqVYod0wIk0}}
 
−
</pre>
 
 
===Gallery===
 
===Gallery===
 
<pre>
 
<pre>
Line 62: Line 50:
 
</gallery>
 
</gallery>
 
</pre>
 
</pre>
 +
=Page Formatting=
 
==Headers==
 
==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.
+
By default, pages do not contain their title to allow customization in this regard. For that, we use a couple of [https://www.mediawiki.org/wiki/Help:Templates wiki templates] created specifically for that purpose.
 
===Image + Info Bar Header (typical for a map page)===
 
===Image + Info Bar Header (typical for a map page)===
 
<pre>
 
<pre>
−
{{P2_Infobox|Page Title|image.jpg|
+
{{P2_Infobox|Page Title|Image.jpg|
 
*''Entry Upper'' Entry Lower
 
*''Entry Upper'' Entry Lower
 
}}
 
}}
 
</pre>
 
</pre>
−
 
 
===Title Header (typical for a glitch writeup)===
 
===Title Header (typical for a glitch writeup)===
−
<pre>
+
<pre>{{P2_Title|Page Title}}</pre>
−
{{P2_Title|Page Title}}
+
==Map Page Template==
−
</pre>
+
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.
  
−
==Map page template==
+
The <code>#p2sr:</code> templates use [[Krzyhau]]'s plugin to fetch WR data from [https://board.portal2.sr the leaderboards], or a Least Portals spreadsheet. Other games are not currently supported.
−
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===
 
===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.
 
 
<pre>
 
<pre>
 
{{P2_Infobox|Map Name|Map_sp_.jpg|
 
{{P2_Infobox|Map Name|Map_sp_.jpg|
−
*''File name'' sp_
+
*''Previous Map'' [[Previous Map]]
 +
*''File Name'' sp_
 
*''Appearance'' [[Chapter Name]]
 
*''Appearance'' [[Chapter Name]]
 
*''Native to Challenge Mode'' Yes | Not by default
 
*''Native to Challenge Mode'' Yes | Not by default
 
*''World Record'' {{#p2sr:wr|sp:map name}}
 
*''World Record'' {{#p2sr:wr|sp:map name}}
 
*''Least Portals'' {{#p2sr:lp|sp:map name}}
 
*''Least Portals'' {{#p2sr:lp|sp:map name}}
 +
*''Next Map'' [[Next Map]]
 
}}
 
}}
−
 
 
=Overview=
 
=Overview=
  
Line 105: Line 92:
 
[[Category:Chapter Name]]
 
[[Category:Chapter Name]]
 
</pre>
 
</pre>
−
 
 
===Coop===
 
===Coop===
 
<pre>
 
<pre>
−
{{P2_Infobox|Map Name|Map_mp_coop.jpg|
+
{{P2_Infobox|Map Name|Map_mp_coop_.jpg|
−
*''File name'' mp_coop_
+
*''Previous Map'' [[Previous Map. How to handle the hub?]]
 +
*''File Name'' mp_coop_
 
*''Appearance'' [[Course Name]]
 
*''Appearance'' [[Course Name]]
 
*''World Record'' {{#p2sr:wr|coop:map name}}
 
*''World Record'' {{#p2sr:wr|coop:map name}}
 
*''Least Portals'' {{#p2sr:lp|coop:map name}}
 
*''Least Portals'' {{#p2sr:lp|coop:map name}}
 +
*''Next Map'' [[Next Map. How to handle the hub?]]
 
}}
 
}}
−
 
 
=Overview=
 
=Overview=
  
Line 131: Line 118:
 
[[Category:Course Name]]
 
[[Category:Course Name]]
 
</pre>
 
</pre>
−
==Additional Info==
+
=Additional Info=
−
In case of any doubt or question, contact <code>bigdaniel#9055</code> or <code>Krzyhau#8514</code> on Discord.
+
In case of any doubt or question, contact <code>bigdaniel</code>, <code>krzyhau</code> or <code>amj</code> on Discord.

Latest revision as of 17:53, 26 June 2023

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 a user account. All you have to do is to click the Edit page link in your TOOLS menu. Certain preferences can be modified here.

In order to create new page, type the name of the page in the search bar, then on the search results page click the page creation link.

Please note that all your contributions may be edited, altered, or removed by other contributors or moderators. Nevertheless, it is encouraged to create new content, as long as you're knowledgeable about the topic you write about and can provide accurate information.

Formatting

This wiki uses MediaWiki markup. For more information, visit the 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 like so:

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

Media

While MediaWiki provides multiple ways to include media, we are limiting ourselves to several methods in order to keep consistency between pages, as well as to avoid unnecessary mess.

Uploading media

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 generally preferred over .png images, as most images do not need to be too high in detail. While it is possible, it is discouraged to upload videos to the wiki. Use video sharing services like YouTube instead.

Images

In order to include images on a page, use one of those methods: 

{{P2_Image|image.jpg|Description}}
                OR
[[File:image.jpg|thumb|Description]]

Videos

Side Video (Preferred) 

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

Inline Video (Specific use-cases) 

{{#ev:youtube|youtu.be/aaaaaaaaaaa}}

Gallery

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

Page Formatting

Headers

By default, pages do not contain their title to allow customization in this regard. For that, we use a couple 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.

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

Singleplayer

{{P2_Infobox|Map Name|Map_sp_.jpg|
*''Previous Map'' [[Previous Map]]
*''File Name'' sp_
*''Appearance'' [[Chapter Name]]
*''Native to Challenge Mode'' Yes | Not by default
*''World Record'' {{#p2sr:wr|sp:map name}}
*''Least Portals'' {{#p2sr:lp|sp:map name}}
*''Next Map'' [[Next Map]]
}}
=Overview=

=General Route=

=Challenge Mode Specific=

=Full Game Specific=

==Full Game Dialogue==

=History=

[[Category:Maps]]
[[Category:Singleplayer Maps]]
[[Category:Chapter Name]]

Coop

{{P2_Infobox|Map Name|Map_mp_coop_.jpg|
*''Previous Map'' [[Previous Map. How to handle the hub?]]
*''File Name'' mp_coop_
*''Appearance'' [[Course Name]]
*''World Record'' {{#p2sr:wr|coop:map name}}
*''Least Portals'' {{#p2sr:lp|coop:map name}}
*''Next Map'' [[Next Map. How to handle the hub?]]
}}
=Overview=

=General Route=

=Challenge Mode Specific=

=Full Game Specific=

==Full Game Dialogue==

=History=

[[Category:Maps]]
[[Category:Cooperative Maps]]
[[Category:Course Name]]

Additional Info

In case of any doubt or question, contact bigdaniel, krzyhau or amj on Discord.

Retrieved from "https://wiki.portal2.sr/index.php?title=Contributing&oldid=2034"