How to contribute/en: Difference between revisions
Updating to match new version of source page |
Updating to match new version of source page |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<languages/> | <languages /> | ||
We welcome you to contribute to this wiki. Feel free to edit any pages to improve this wiki. All changes made in good faith are welcome. [[wikipedia:Wikipedia:Be_bold|Be bold!]] When you are unsure about something, you can always ask in the #wiki channel on [https://ddnet.org/discord Discord] or [https://matrix.to/#/#ddnet-wiki:matrix.org Matrix]. This page should help getting started to contribute. You need to register in order to contribute. | We welcome you to contribute to this wiki. Feel free to edit any pages to improve this wiki. All changes made in good faith are welcome. [[wikipedia:Wikipedia:Be_bold|Be bold!]] When you are unsure about something, you can always ask in the #wiki channel on [https://ddnet.org/discord Discord] or [https://matrix.to/#/#ddnet-wiki:matrix.org Matrix]. This page should help getting started to contribute. You need to register in order to contribute. | ||
== What to contribute? == | ==What to contribute?== | ||
We encourage every kind of contribution. Here are a few examples what you could do: | We encourage every kind of contribution. Here are a few examples what you could do: | ||
* You can always fix problems you see, correct grammar, make sure wording is accurate, etc. | *You can always fix problems you see, correct grammar, make sure wording is accurate, etc. | ||
* Expand an article by covering another topic | *Expand an article by covering another topic | ||
* Create videos for articles ([[Special:MyLanguage/#how_to_create_a_video|How to create videos]]) | *Create videos for articles ([[Special:MyLanguage/How to contribute#how_to_create_a_video|How to create videos]]) | ||
* Write a new article. A variety of topics are yet to be covered | *Write a new article. A variety of topics are yet to be covered | ||
* Here you can find articles that need content: [[:Category:Needs Content|:Category:Needs Content]] | *Here you can find articles that need content: [[:Category:Needs Content|:Category:Needs Content]] | ||
== What content is accepted? == | ==What content is accepted?== | ||
Articles should be related to the DDNet and Teeworlds community/projects/ecosystem. | Articles should be related to the DDNet and Teeworlds community/projects/ecosystem. | ||
Line 18: | Line 19: | ||
Please do not put "Made by X" or "Wiki Article by X" when writing an article, authorship is seen by contributions that can be looked up on "View History", not at the article directly. | Please do not put "Made by X" or "Wiki Article by X" when writing an article, authorship is seen by contributions that can be looked up on "View History", not at the article directly. | ||
== Moderation == | Please do not edit other User personal pages, those look like <code>User:Username</code>. | ||
==Moderation== | |||
Changes made to the wiki go to a moderation queue, where moderators will check if the change you made is vandalism. | Changes made to the wiki go to a moderation queue, where moderators will check if the change you made is vandalism. | ||
Line 24: | Line 27: | ||
Here are our practices we follow when moderating content, which the extension itself recommends: | Here are our practices we follow when moderating content, which the extension itself recommends: | ||
=== Recommended use / good practices for moderators === | ===Recommended use / good practices for moderators=== | ||
The following good-practices are advised: | The following good-practices are advised: | ||
# Only vandalism should be Rejected. Not-so-good edits with good intentions (e.g. adding excessive plot details into the Wikipedia article about film) are better made Approved and then reverted as usual. This way the author is not offended and the text is saved in page history, viewable by anyone. | #Only vandalism should be Rejected. Not-so-good edits with good intentions (e.g. adding excessive plot details into the Wikipedia article about film) are better made Approved and then reverted as usual. This way the author is not offended and the text is saved in page history, viewable by anyone. | ||
# Any user that is deemed legitimate (does N good edits) should be added into <code>automoderated</code> group. | #Any user that is deemed legitimate (does N good edits) should be added into <code>automoderated</code> group. | ||
# Adding users to <code>automoderated</code> group via <code>$wgAutopromote</code> is NOT recommended, as it motivates the vandals to do many very-minor edits (e.g. adding interwiki). Better promote them to <code>automoderated</code> manually for one good edit and not promote for 30 useless-edits-made-for-count. | #Adding users to <code>automoderated</code> group via <code>$wgAutopromote</code> is NOT recommended, as it motivates the vandals to do many very-minor edits (e.g. adding interwiki). Better promote them to <code>automoderated</code> manually for one good edit and not promote for 30 useless-edits-made-for-count. | ||
# Abstain from using blocks. Don't protect pages "just in case", except maybe for important templates. | #Abstain from using blocks. Don't protect pages "just in case", except maybe for important templates. | ||
# Allow the full rehabilitation of users with a bad history of editing. Their useful edits to the articles should be allowed, no matter how many times they were blocked. At the same time, trolling on talk pages should be rejected, so are the purposely-low-quality edits. | #Allow the full rehabilitation of users with a bad history of editing. Their useful edits to the articles should be allowed, no matter how many times they were blocked. At the same time, trolling on talk pages should be rejected, so are the purposely-low-quality edits. | ||
== How to create a video == | ==How to create a video== | ||
=== Step 1: Getting a Map === | ===Step 1: Getting a Map=== | ||
==== Variant 1: Using an existing map ==== | ====Variant 1: Using an existing map==== | ||
To use maps from videos in the wiki: | To use maps from videos in the wiki: | ||
# Right-click the video and click ‘Open Video in New Tab’. Now you can find the name of the video in the URL | #Right-click the video and click ‘Open Video in New Tab’. Now you can find the name of the video in the URL | ||
# Go [https://gitlab.com/ddnet-wiki/ddnet-wiki.gitlab.io/-/tree/master/static/ | #Go [https://gitlab.com/ddnet-wiki/ddnet-wiki.gitlab.io/-/tree/master/static/videos here] and download the correct demo | ||
# Open the demo in your client (you need to move the demo into your <code>data/demos</code> folder) | #Open the demo in your client (you need to move the demo into your <code>data/demos</code> folder) | ||
# While you have the demo open, go into the editor, click <code>File</code>, and select <code>Load Current Map</code> | #While you have the demo open, go into the editor, click <code>File</code>, and select <code>Load Current Map</code> | ||
Now you can edit and use the map for the demo. | Now you can edit and use the map for the demo. | ||
==== Variant 2: Creating a new map ==== | ====Variant 2: Creating a new map==== | ||
# Create a new map in the editor | #Create a new map in the editor | ||
# Set the background color to <code># | #Set the background color to <code>#5E84AEFF</code> | ||
## Click on the <code>quads</code> layer | ##Click on the <code>quads</code> layer | ||
## Right-click the corners of the rectangle | ##Right-click the corners of the rectangle | ||
## Insert the color value <code># | ##Insert the color value <code>#5E84AEFF</code> into the third to last field each each | ||
# The main focus should be that it is comprehensible | #The main focus should be that it is comprehensible | ||
# Keep the style simple and similar to the other videos | #Keep the style simple and similar to the other videos | ||
#* Use simple textures (preferably <code>grass_main</code>, combined with <code>generic_unhookable</code> and <code>font_teeworlds</code>) | #*Use simple textures (preferably <code>grass_main</code>, combined with <code>generic_unhookable</code> and <code>font_teeworlds</code>) | ||
#* Make it loopable, you can get creative with that :) | #*Make it loopable, you can get creative with that :) | ||
#* Insert a scale if suited | #*Insert a scale if suited | ||
==== Step 2.1: Recording the demo ==== | ====Step 2.1: Recording the demo==== | ||
# Turn demo recording on | #Turn demo recording on | ||
#* I suggest <code>Settings -> General -> Automatically record demos</code> | #*I suggest <code>Settings -> General -> Automatically record demos</code> | ||
# Load the map on a server | #Load the map on a server | ||
#* Start your own DDNet server or use the [https://trashmap. | #*Start your own DDNet server or use the [https://trashmap.ddnet.org/ Trashmap] hosting service | ||
# Join it with your client, try the trick until you are satisfied with the result and keep loopability in mind | #Join it with your client, try the trick until you are satisfied with the result and keep loopability in mind | ||
==== Recording Settings ==== | ====Recording Settings==== | ||
Set consistent skin: | Set consistent skin: | ||
* Hammer: brownbear | *Hammer: brownbear | ||
* Pistol: coala | *Pistol: coala | ||
* Shotgun: cammo | *Shotgun: cammo | ||
* Grenade: redstripe | *Grenade: redstripe | ||
* Laser: bluestripe | *Laser: bluestripe | ||
* Hook: default | *Hook: default | ||
* Jump: bluekitty | *Jump: bluekitty | ||
==== Step 2.2: Cutting the demo ==== | ====Step 2.2: Cutting the demo==== | ||
# In your client, go to <code>Demos -> auto/</code> | #In your client, go to <code>Demos -> auto/</code> | ||
# Open the demo you recorded | #Open the demo you recorded | ||
#* Tip: Click on <code>Date</code> to sort by date | #*Tip: Click on <code>Date</code> to sort by date | ||
# Press <code>Escape</code> for demo functions | #Press <code>Escape</code> for demo functions | ||
# Use the 2 buttons on the left of the camera icons to select a starting and end point | #Use the 2 buttons on the left of the camera icons to select a starting and end point | ||
# Use the camera icon to save the shortened demo | #Use the camera icon to save the shortened demo | ||
Tip: you can repeat these steps multiple times to be able to cut the demo more precisely | Tip: you can repeat these steps multiple times to be able to cut the demo more precisely | ||
==== Step 2.3: Converting the demo to a video ==== | ====Step 2.3: Converting the demo to a video==== | ||
Once you have the client, converting a demo is as simple as: | Once you have the client, converting a demo is as simple as: | ||
* Open the client (with the converting functionality) | *Open the client (with the converting functionality) | ||
* Set zoom to 10: <code>cl_default_zoom 10</code> | *Set zoom to 10: <code>cl_default_zoom 10</code> | ||
* Go to the <code>Demos</code> tab | *Go to the <code>Demos</code> tab | ||
* Select the correct demo | *Select the correct demo | ||
* Click <code>Render</code> at the bottom | *Click <code>Render</code> at the bottom | ||
=== Step 3: Getting the video into the wiki === | ===Step 3: Getting the video into the wiki=== | ||
Some of the following steps might be a little overwhelming. You can simply ask one of the wiki admins to do the remaining steps. | Some of the following steps might be a little overwhelming. You can simply ask one of the wiki admins to do the remaining steps. | ||
==== Step 3.1: Cropping the video ==== | ====Step 3.1: Cropping the video==== | ||
Using your preferred video editor, crop the video, so that only the relevant cutout of the video remains. You can look at other videos from the wiki to get a feel for how much you should crop. | Using your preferred video editor, crop the video, so that only the relevant cutout of the video remains. You can look at other videos from the wiki to get a feel for how much you should crop. | ||
==== Step 3.2: Uploading the video to the wiki ==== | ====Step 3.2: Uploading the video to the wiki==== | ||
To upload a video to the wiki first you need permissions, if you are considered a trustworthy contributor you will get them, if you consider yourself trustworthy you can ask an administrator to consider giving you the permission to upload files. | To upload a video to the wiki first you need permissions, if you are considered a trustworthy contributor you will get them, if you consider yourself trustworthy you can ask an administrator to consider giving you the permission to upload files. | ||
To upload a file you can go to [[ | To upload a file you can go to [[Special:Upload|Upload file]] link on the sidebar. | ||
==== Step 3.3: Inserting the video into an article ==== | ====Step 3.3: Inserting the video into an article==== | ||
To insert a video into an article, first you have to choose whether it fits in the text or on a side. | To insert a video into an article, first you have to choose whether it fits in the text or on a side. | ||
Line 139: | Line 142: | ||
You can learn more in detail about media placement here: https://www.mediawiki.org/wiki/Help:Images | You can learn more in detail about media placement here: https://www.mediawiki.org/wiki/Help:Images | ||
== Templates == | ==Templates== | ||
If you identify a common occurrence, such as weapon info boxes, you can automate it creating templates, more info [[mediawikiwiki:Help:Templates|here]]. | If you identify a common occurrence, such as weapon info boxes, you can automate it creating templates, more info [[mediawikiwiki:Help:Templates|here]]. | ||
Line 147: | Line 150: | ||
[[:Category:Templates|Category:Templates]] | [[:Category:Templates|Category:Templates]] | ||
== Translation == | ==Translation== | ||
=== Title === | ===Title=== | ||
To translate the title you can go to "Edit source" and add <code><nowiki>{{DISPLAYTITLE:Translated title}}</nowiki></code> to the top of the page replacing "Translated title" with the title you want displayed. | To translate the title you can go to "Edit source" and add <code><nowiki>{{DISPLAYTITLE:Translated title}}</nowiki></code> to the top of the page replacing "Translated title" with the title you want displayed. | ||
=== Linking === | ===Linking=== | ||
You can | You can achieve the same in the visual editor, by first linking the translated page: e.g. by typing <code><nowiki>[[</nowiki></code> to open the linking page. Enter <code>Jump/de</code> (replacing <code>de</code> with the target language code) to link to the correct page and then modify the display text to the translated version. |
Latest revision as of 16:23, 2 December 2023
We welcome you to contribute to this wiki. Feel free to edit any pages to improve this wiki. All changes made in good faith are welcome. Be bold! When you are unsure about something, you can always ask in the #wiki channel on Discord or Matrix. This page should help getting started to contribute. You need to register in order to contribute.
What to contribute?
We encourage every kind of contribution. Here are a few examples what you could do:
- You can always fix problems you see, correct grammar, make sure wording is accurate, etc.
- Expand an article by covering another topic
- Create videos for articles (How to create videos)
- Write a new article. A variety of topics are yet to be covered
- Here you can find articles that need content: :Category:Needs Content
What content is accepted?
Articles should be related to the DDNet and Teeworlds community/projects/ecosystem.
Please do not put "Made by X" or "Wiki Article by X" when writing an article, authorship is seen by contributions that can be looked up on "View History", not at the article directly.
Please do not edit other User personal pages, those look like User:Username
.
Moderation
Changes made to the wiki go to a moderation queue, where moderators will check if the change you made is vandalism.
Here are our practices we follow when moderating content, which the extension itself recommends:
Recommended use / good practices for moderators
The following good-practices are advised:
- Only vandalism should be Rejected. Not-so-good edits with good intentions (e.g. adding excessive plot details into the Wikipedia article about film) are better made Approved and then reverted as usual. This way the author is not offended and the text is saved in page history, viewable by anyone.
- Any user that is deemed legitimate (does N good edits) should be added into
automoderated
group. - Adding users to
automoderated
group via$wgAutopromote
is NOT recommended, as it motivates the vandals to do many very-minor edits (e.g. adding interwiki). Better promote them toautomoderated
manually for one good edit and not promote for 30 useless-edits-made-for-count. - Abstain from using blocks. Don't protect pages "just in case", except maybe for important templates.
- Allow the full rehabilitation of users with a bad history of editing. Their useful edits to the articles should be allowed, no matter how many times they were blocked. At the same time, trolling on talk pages should be rejected, so are the purposely-low-quality edits.
How to create a video
Step 1: Getting a Map
Variant 1: Using an existing map
To use maps from videos in the wiki:
- Right-click the video and click ‘Open Video in New Tab’. Now you can find the name of the video in the URL
- Go here and download the correct demo
- Open the demo in your client (you need to move the demo into your
data/demos
folder) - While you have the demo open, go into the editor, click
File
, and selectLoad Current Map
Now you can edit and use the map for the demo.
Variant 2: Creating a new map
- Create a new map in the editor
- Set the background color to
#5E84AEFF
- Click on the
quads
layer - Right-click the corners of the rectangle
- Insert the color value
#5E84AEFF
into the third to last field each each
- Click on the
- The main focus should be that it is comprehensible
- Keep the style simple and similar to the other videos
- Use simple textures (preferably
grass_main
, combined withgeneric_unhookable
andfont_teeworlds
) - Make it loopable, you can get creative with that :)
- Insert a scale if suited
- Use simple textures (preferably
Step 2.1: Recording the demo
- Turn demo recording on
- I suggest
Settings -> General -> Automatically record demos
- I suggest
- Load the map on a server
- Start your own DDNet server or use the Trashmap hosting service
- Join it with your client, try the trick until you are satisfied with the result and keep loopability in mind
Recording Settings
Set consistent skin:
- Hammer: brownbear
- Pistol: coala
- Shotgun: cammo
- Grenade: redstripe
- Laser: bluestripe
- Hook: default
- Jump: bluekitty
Step 2.2: Cutting the demo
- In your client, go to
Demos -> auto/
- Open the demo you recorded
- Tip: Click on
Date
to sort by date
- Tip: Click on
- Press
Escape
for demo functions - Use the 2 buttons on the left of the camera icons to select a starting and end point
- Use the camera icon to save the shortened demo
Tip: you can repeat these steps multiple times to be able to cut the demo more precisely
Step 2.3: Converting the demo to a video
Once you have the client, converting a demo is as simple as:
- Open the client (with the converting functionality)
- Set zoom to 10:
cl_default_zoom 10
- Go to the
Demos
tab - Select the correct demo
- Click
Render
at the bottom
Step 3: Getting the video into the wiki
Some of the following steps might be a little overwhelming. You can simply ask one of the wiki admins to do the remaining steps.
Step 3.1: Cropping the video
Using your preferred video editor, crop the video, so that only the relevant cutout of the video remains. You can look at other videos from the wiki to get a feel for how much you should crop.
Step 3.2: Uploading the video to the wiki
To upload a video to the wiki first you need permissions, if you are considered a trustworthy contributor you will get them, if you consider yourself trustworthy you can ask an administrator to consider giving you the permission to upload files.
To upload a file you can go to Upload file link on the sidebar.
Step 3.3: Inserting the video into an article
To insert a video into an article, first you have to choose whether it fits in the text or on a side.
Usually, if the text mentions some steps to take or the video is directly related to a text, it's better to put it there like this:
[[File:myvideo.mp4|gif]]
If you consider it better to be floating on the right side, you can do this
[[File:myvideo.mp4|right|gif]]
Or with a thumb and a label:
[[File:myvideo.mp4|thumb|This video shows this!|gif]]
If you think the video is too small, you can specify a size:
[[File:myvideo.mp4|gif|400px]]
You can learn more in detail about media placement here: https://www.mediawiki.org/wiki/Help:Images
Templates
If you identify a common occurrence, such as weapon info boxes, you can automate it creating templates, more info here.
List of created templates:
Translation
Title
To translate the title you can go to "Edit source" and add {{DISPLAYTITLE:Translated title}}
to the top of the page replacing "Translated title" with the title you want displayed.
Linking
You can achieve the same in the visual editor, by first linking the translated page: e.g. by typing [[
to open the linking page. Enter Jump/de
(replacing de
with the target language code) to link to the correct page and then modify the display text to the translated version.