Difference between revisions of "How to contribute"

From Mashinky
Jump to: navigation, search
(Translation of Creating and Editing sections to English)
(added register link, added note about confirming your email, added note about all pages being protected until you complete registration)
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
'''Help page for contribution to Mashinky wiki.'''
 
'''Help page for contribution to Mashinky wiki.'''
 
 
'''THIS PAGE IS UNDER DEVELOPMENT'''
 
 
  
 
Before editing, it's good to read the following text. We want the Mashinky Wiki to be an up-to-date and clear source of information about the game and everything around it. Therefore, the following rules must be respected.
 
Before editing, it's good to read the following text. We want the Mashinky Wiki to be an up-to-date and clear source of information about the game and everything around it. Therefore, the following rules must be respected.
  
The Mashinky Wiki is governed by wiki rules, which means that anyone can edit any unprotected page and instantly improve articles for all readers. Just register.  
+
The Mashinky Wiki is governed by wiki rules, which means that anyone can edit any unprotected page and instantly improve articles for all readers. Just [[Special:CreateAccount|Register]] and confirm your registration via email afterwards.  
However, there are pages like the [[Main Page]] that are protected from editing. Protected pages have a tab <code>View&nbsp;source</code> instead of <code>Edit</code>. If you need to edit a protected page, please contact one of the [[Special:ListUsers/sysop|Administrators]]. If you need any other help, contact one of the [[Special:ListUsers/editors|Editors]] on their <code>Talk</code> page.
+
However, there are pages like the [[Main Page]] that are protected from editing. Protected pages have a tab <code>View&nbsp;source</code> instead of <code>Edit</code>. All pages will have the Edit button hidden until you finish the registration process. If you need to edit a protected page or if you need any other help, please contact the Wiki Editors via [https://discordapp.com/invite/yEaqkrn Discord] or on their [[User_talk:Psojed|Talk]] page.
  
  
Line 21: Line 17:
 
It is strongly recommended that you copy the original page code into an external text editor, preferably without formatting - such as Notepad. In case something goes wrong, you can immediately return the original page layout. It is also a good idea to keep your edits up to date. For example, when a browser crashes, it can save you a lot of work when you have secured it.  
 
It is strongly recommended that you copy the original page code into an external text editor, preferably without formatting - such as Notepad. In case something goes wrong, you can immediately return the original page layout. It is also a good idea to keep your edits up to date. For example, when a browser crashes, it can save you a lot of work when you have secured it.  
 
   
 
   
====Minor edit====
+
====Minor edits====
Označením Minor edit se rozumí, že jste na stránce provedli jen minimální úpravy. Oprava gramatiky, změny ve formátování textu, atd. Změny, které ale nemění obsah článku. Editorům dáváte na vědomí, že tuto změnu není třeba důkladně kontrolovat. Nicméně i tyto změny jsou důležité a ceněné. Dovádějí články k lepší podobě.
+
Marking edits as Minor means that you've only made minor edits on the page. These are changes that do not change the content of the article. It can be grammar repair, changes to text formatting, etc. The editors are aware that this change does not need to be thoroughly checked. However, these changes are important and valued. They make articles better.
  
====Major edit====
+
====Major edits====
Všechny ostatní úpravy, i kdyby se jednalo o jedno slovo, které mění význam článku, jsou považovány za zásadní úpravy.  
+
All other adjustments, even if it were a single word that changes the meaning of an article, are considered as fundamental modifications.
Nebojte se úprav, ale dobře si rozmyslete, než takovou úpravu provedete. Pakliže existuje k danému článku diskuze, je dobré zohlednit i názory ostatních uživatelů a jimi navrhované úpravy. Pamatujte na to, že větší úpravy budou zkontrolovány a reflektuje současné potřeby jak komunity, tak samotné hry. Pakliže nebudete respektovat výše zmíněná pravidla, zvýšíte tím šanci, že vaše editace bude odmítnuta, případně přepracována, aby odpovídala potřebám této wiki.  
+
Do not worry about editing, but think well before you make alterations. If there is a discussion about the article, it is good to take into account the opinions of other users and their proposed modifications. Remember that larger adjustments will be reviewed and reflect the current needs of both community and game itself. If you do not respect the above rules, you will increase the chance that your edits will be rejected or redesigned to match the needs of this wiki.
  
Před uložením stránky si zobrazte <code>Show&nbsp;preview</code> a zkontrolujte, že stránka vypadá přesně tak jak chcete. Dále vyplňte krátké shrnutí vaší editace v malém poli pod editorem. Pokud toto vše již máte hotové, klikněte na tlačítko <code>Save&nbsp;page</code>. Veškeré úpravy budou v tu chvíli viditelné pro ostatní uživatele.  
+
Before you save the page, use <code>Show&nbsp;preview</code> to make sure the page looks exactly the way you want. Fill in a short summary of your editing in the Summary field below the editor. If you have done this, click the <code>Save&nbsp;page</code> button to store the page. Your edits to the page will now be visible for other users.
  
===Přidávání odkazů===
+
===Adding links===
Pakliže se zmiňujete o obsahu v jiné části wiki, je dobré na tuto stránku odkázat. Více viz [https://en.wikipedia.org/wiki/Help:Wikitext#Links_and_URLs Links and URLs]  
+
If you are referring to content in another part of the wiki, it is good to refer to that page by creating a link. For more information see [https://en.wikipedia.org/wiki/Help:Wikitext#Links_and_URLs Links and URLs].
  
===Přidávání obrázků, videí a zvuků===
+
===Adding pictures, videos, and sounds===
Pokud již byl soubor na wiki vložen, můžete ho použít pomocí syntaxe: <code><nowiki>[[File:FILENAME.EXT|thumb|DESCRIPTION]]</nowiki></code>". ("<code>File:</code>" může být nahrazeno "<code>Image:</code>". Na funkčnost to nemá žádný vliv, jde jen o to, co používáte raději. Nicméně pro obrázky je vhodnější používat <code>Image:</code>).
+
Before adding multimedia files, make sure it is not already in the wiki. To add media to the wiki use [[Special:Upload|Upload file]].
Přidat obrázek lze na stránce [[Special:Upload|Upload file]]. Opět, před přidáváním obrázku si ověřte, že obrázek na wiki nevložil již někdo před vámi.
+
You can use media in pages with the syntax: <code><nowiki>[[File:FILENAME.EXT|thumb|DESCRIPTION]]</nowiki></code>".
Více viz: [https://en.wikipedia.org/wiki/Help:Wikitext#Images Images]
 
  
===Diskusní stránky===
+
For displaying images it is preferable to replace "<code>File:</code>" with "<code>Image:</code>", but both work. More information: [https://en.wikipedia.org/wiki/Help:Wikitext#Images Images]
  
Každý článek na Wiki má stránku pro diskuzi, k níž se dostanete kliknutím na kartu <code>Talk</code> nacházející se nad nadpisem. Tam mohou uživatelé diskutovat o vylepšení článku. Pokud provedete změnu, která je vrácena, či změněna někým jiným, diskutujte o změně na stránce pro diskusi! Vždy se dá dojít ke kompromisu. Respektujte názory ostatních, buďte slušní. I ostatní mohou mít pravdu a ne vždy je vaše pravda ta nejlepší. Agresivní chování a přepisování článků proti vůli ostatních nebude tolerováno.
+
===Discussion pages===
  
Většina ostatních typů stránek na Wiki má také přidružené diskusní stránky, včetně stránky uživatele. Pokud vás ostatní redaktoři potřebují kontaktovat, obvykle to udělají tím, že zanechají vzkaz na vaší diskusní stránce. Když vám někdo ponechal zprávu, uvidíte upozornění při dalším načtení stránky jakékoliv stránky.
+
Each article on the Wiki has a discussion page that can be accessed by clicking on the <code>Talk</code> tab located above the title. Here users can discuss about improving the article. If you make a change that is returned or changed by someone else, discuss the change on the discussion page! There can always be a compromise. Respect the opinions of others, be polite. Others may be right, and your truth is not always the best. Aggressive behavior and transcription of articles against the will of others will not be tolerated.
  
Podepisujte své příspěvky v diskuzích pomocí čtyř tildes (<nowiki>~~~~</nowiki>). Toto vytvoří váš podpis složený z uživatelského jména a časového a datového razítka.  
+
Most other types of Wiki pages also have associated forums, including a user page. If other editors need to contact you, they usually do this by leaving a message on your discussion page. When someone leaves you a message, you will see a notification to inform you about this.
 +
 
 +
Sign your posts in discussions using four tildes (<nowiki>~~~~</nowiki>). This will create your signature, consisting of a username and a Time and Date stamp.
  
 
=== Resource Icon list===
 
=== Resource Icon list===
Line 50: Line 47:
 
Wherever you mention raw materials, products, or tokens please use relevant icons. The recommended icon size in the text is 16px.
 
Wherever you mention raw materials, products, or tokens please use relevant icons. The recommended icon size in the text is 16px.
  
'''Example''': 1 Coal Token ([[File:token coal.png|16px]]), 1 Timber Token ([[File:token timber.png|16px]]), 1 Iron Token ([[File:token iron.png|16px]])
+
'''Example''': 1 Coal Token [[File:token coal.png|16px]], 1 Timber Token [[File:token timber.png|16px]], 1 Iron Token [[File:token iron.png|16px]]
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
Line 79: Line 76:
 
|-
 
|-
 
| [[File:icon oil.png]] || icon oil.png || Cargo types
 
| [[File:icon oil.png]] || icon oil.png || Cargo types
 +
|-
 +
| [[File:icon goods.png]] || icon goods.png || Cargo types
 
|-
 
|-
 
| [[File:icon uranium.png]] || icon uranium.png || Cargo types
 
| [[File:icon uranium.png]] || icon uranium.png || Cargo types

Revision as of 09:08, 24 February 2021

Help page for contribution to Mashinky wiki.

Before editing, it's good to read the following text. We want the Mashinky Wiki to be an up-to-date and clear source of information about the game and everything around it. Therefore, the following rules must be respected.

The Mashinky Wiki is governed by wiki rules, which means that anyone can edit any unprotected page and instantly improve articles for all readers. Just Register and confirm your registration via email afterwards. However, there are pages like the Main Page that are protected from editing. Protected pages have a tab View source instead of Edit. All pages will have the Edit button hidden until you finish the registration process. If you need to edit a protected page or if you need any other help, please contact the Wiki Editors via Discord or on their Talk page.


Creating a page

Before creating a page, make sure that the topic is not already in the wiki. The topic can exist under a different name. In addition, the page should be categorized correctly. See also page editing.

Editing a page

Editing most pages is easy. We use the wiki markup (wikitext) to format the text. This is used to tag links, insert images, tables, quotes, etc. The easiest way to use it is to look at an existing page where there is similar content to what you want to create. The pages should look as uniform as possible. In any case, it is necessary to edit the pages so that the encyclopedic style is preserved. The content should give readers insight, be on topic and be without personal opinions. If you use a source of information from a source other than the game itself, it is ideally necessary to list the source of this information so that it is easily traceable and verifiable. It is strongly recommended that you copy the original page code into an external text editor, preferably without formatting - such as Notepad. In case something goes wrong, you can immediately return the original page layout. It is also a good idea to keep your edits up to date. For example, when a browser crashes, it can save you a lot of work when you have secured it.

Minor edits

Marking edits as Minor means that you've only made minor edits on the page. These are changes that do not change the content of the article. It can be grammar repair, changes to text formatting, etc. The editors are aware that this change does not need to be thoroughly checked. However, these changes are important and valued. They make articles better.

Major edits

All other adjustments, even if it were a single word that changes the meaning of an article, are considered as fundamental modifications. Do not worry about editing, but think well before you make alterations. If there is a discussion about the article, it is good to take into account the opinions of other users and their proposed modifications. Remember that larger adjustments will be reviewed and reflect the current needs of both community and game itself. If you do not respect the above rules, you will increase the chance that your edits will be rejected or redesigned to match the needs of this wiki.

Before you save the page, use Show preview to make sure the page looks exactly the way you want. Fill in a short summary of your editing in the Summary field below the editor. If you have done this, click the Save page button to store the page. Your edits to the page will now be visible for other users.

Adding links

If you are referring to content in another part of the wiki, it is good to refer to that page by creating a link. For more information see Links and URLs.

Adding pictures, videos, and sounds

Before adding multimedia files, make sure it is not already in the wiki. To add media to the wiki use Upload file. You can use media in pages with the syntax: [[File:FILENAME.EXT|thumb|DESCRIPTION]]".

For displaying images it is preferable to replace "File:" with "Image:", but both work. More information: Images

Discussion pages

Each article on the Wiki has a discussion page that can be accessed by clicking on the Talk tab located above the title. Here users can discuss about improving the article. If you make a change that is returned or changed by someone else, discuss the change on the discussion page! There can always be a compromise. Respect the opinions of others, be polite. Others may be right, and your truth is not always the best. Aggressive behavior and transcription of articles against the will of others will not be tolerated.

Most other types of Wiki pages also have associated forums, including a user page. If other editors need to contact you, they usually do this by leaving a message on your discussion page. When someone leaves you a message, you will see a notification to inform you about this.

Sign your posts in discussions using four tildes (~~~~). This will create your signature, consisting of a username and a Time and Date stamp.

Resource Icon list

Wherever you mention raw materials, products, or tokens please use relevant icons. The recommended icon size in the text is 16px.

Example: 1 Coal Token Token coal.png, 1 Timber Token Token timber.png, 1 Iron Token Token iron.png

Image Image name Category
Token money.png token money.png Tokens
Token timber.png token timber.png Tokens
Token coal.png token coal.png Tokens
Token iron.png token iron.png Tokens
Token diesel.png token diesel.png Tokens
Token steel.png token steel.png Tokens
Token energy.png token energy.png Tokens
Token cement.png token cement.png Tokens
Token superconductors.png token superconductors.png Tokens
Icon passengers.png icon passengers.png Cargo types
Icon mail.png icon mail.png Cargo types
Icon oil.png icon oil.png Cargo types
Icon goods.png icon goods.png Cargo types
Icon uranium.png icon uranium.png Cargo types
Icon logs.png icon logs.png Cargo types
Icon timber.png icon timber.png Cargo types
Icon diesel.png icon diesel.png Cargo types
Icon iron ore.png icon iron ore.png Cargo types
Icon coal.png icon coal.png Cargo types
Icon cobblestone.png icon cobblestone.png Cargo types
Icon iron.png icon iron.png Cargo types
Icon steel.png icon steel.png Cargo types
Icon superconductors.png icon superconductors.png Cargo types
Icon energy.png icon energy.png Cargo types
Icon cement.png icon cement.png Cargo types
Icon cobalt.png icon cobalt.png Cargo types
Icon gold.png icon gold.png Cargo types