Factorio:Wiki rules: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
No edit summary
(Grammar changes for consistency)
Line 1: Line 1:
This page is used for contributors into this wiki.
This page is used for contributors on this wiki.


== Get an account ==
== Get an account ==


Just follow the instructions for registering. It takes normally one or two days to be added, cause every user is added by hand to avoid spam.
Just follow the instructions for registering. It takes normally one or two days to be added, because every user is added by hand to avoid spam.


== How to contribute? ==
== How to contribute? ==
Line 21: Line 21:
== Advanced ==
== Advanced ==


* Add missing information it at the right place.
* Add missing information at the right place.
: This is in most cases easy, but sometimes could be really difficult. Ask for help, if you don't know.
: This is in most cases easy, but sometimes could be really difficult. Ask for help if you don't know.


* Split the information on big pages into subpages.
* Split the information on big pages into subpages.
Line 33: Line 33:
: Factorio has a set of words, which have a fixed meaning. For example: an entity can be mined, an item can be picked up. Removing them means something different! Ask the factorio wiki, if you are unsure.
: Factorio has a set of words, which have a fixed meaning. For example: an entity can be mined, an item can be picked up. Removing them means something different! Ask the factorio wiki, if you are unsure.


* A pic says more than 1000 words.
* A picture says more than 1000 words.
: Make pictures, if possible. In some case use GIF-animations! See down.
: Make pictures, if possible. In some case use GIFs! See down.


* You can also go to the [[Wiki To-do List]] and look, if there is a job you like.
* You can also go to the [[Wiki To-do List]] and look, if there is a job you like.
Line 40: Line 40:
== Discussions ==
== Discussions ==


I (ssilk) prefer the forum for discussions and I hope this is no problem, cause I think, discussions on wiki-pages is to high-end for most potential wiki-writers.
I (ssilk) prefer the forum for discussions and I hope this is not a problem, because I think, discussions on wiki-pages is to high-end for most potential wiki-writers.


=== Existing discussions ===
=== Existing discussions ===
Line 65: Line 65:
* The default language is English.
* The default language is English.
* Any other language has no right to obtain a pagename, which collides with English.
* Any other language has no right to obtain a pagename, which collides with English.
* Also no other language has the right to use a pagename, which means the same or something different in another language.
* No other language has the right to use a pagename, which means the same or something different in another language.


==== This is the logical consequence of the above rules ====
==== This is the logical consequence of the above rules ====
Line 99: Line 99:
Do's:
Do's:


* make pictures at day! [[Lua/Game#alwaysday|Turn on daylight]]! Use night or dawn only, if needed to explain something.
* Take pictures at day! [[Lua/Game#alwaysday|Turn on daylight]]! Use night or dawn only, if needed to explain something.
* use god mode! [[Lua/Player#controllertype]]. You can go to every place and don't stand in the way.
* Use god mode! [[Lua/Player#controllertype]]. You can go to every place and don't stand in the way of the picture.
* you can [[Lua/Game#speed|slowdown the game]] to find the right moment for the picture.
* You can [[Lua/Game#speed|slowdown the game]] to find the right moment for the picture.
* you can use also the [[Lua/Game#peacefulmode]], to be not disturbed by the natives.
* You can use also the [[Lua/Game#peacefulmode]], to be not disturbed by the natives.
* you can stop the game in the right moment using SHIFT-SPACE key. That blends also the grid in.
* You can stop the game in the right moment using SHIFT-SPACE key. That also blends the grid in.
* learn how to use the [[Debug mode]] to add relevant information into this pic.
* Learn how to use the [[Debug mode]] to add relevant information into this picture.
* go into the highest zoom level you possibly can.
* Go into the highest zoom level you possibly can, without missing any vital information.


Dont's
Dont's


* don't make pics of ultra-complicated stuff! Add only as much elements, which are needed to understand, how that might work.
* Don't make pictures of ultra-complicated stuff! Add only as much elements, which are needed to understand, how that might work.
* don't make just a screenshot. Try to remove all unneeded informations from the pic.
* Don't just take a screenshot. Try to remove all unneeded informations from the picture.
* try not to make a photo with the character, except it should show something, facing to it.
* Try not to make a photo with the character, except if to should show something; then face the character to it.




Line 118: Line 118:
=== Optimizing the picture before upload ===
=== Optimizing the picture before upload ===


* cut as much as possible/nice.
* Cut as much as possible/nice.
* resolution should be normally not higher than 800x800 px.
* Resolution should not normally be higher than 800x800 px.
* ''Do not add textual information into the pics! ''Instead add numbers or letters in it and add the text on the wiki-page. Otherwise it isn't searchable information.
* ''Do not add textual information into the pictures! ''Instead add numbers or letters in it and add the text on the wiki-page; otherwise, it isn't searchable information.
* sharpen the pics. For the wiki it looks quite better to sharpen the pics one ore two times.
* Sharpen the pictures. For the wiki it looks quite better to sharpen the pictures one ore two times.


=== Making animations ===
=== Making animations ===
Line 129: Line 129:
: [http://blog.bahraniapps.com/?page_id=21 Gifcam] (PC only)
: [http://blog.bahraniapps.com/?page_id=21 Gifcam] (PC only)
: [http://www.cockos.com/licecap/ Licecap] (also for Mac)
: [http://www.cockos.com/licecap/ Licecap] (also for Mac)
:: Good example pics: http://www.factorioforums.com/forum/viewtopic.php?f=5&t=3920
:: Good example pictures: http://www.factorioforums.com/forum/viewtopic.php?f=5&t=3920

Revision as of 11:10, 5 June 2014

This page is used for contributors on this wiki.

Get an account

Just follow the instructions for registering. It takes normally one or two days to be added, because every user is added by hand to avoid spam.

How to contribute?

This wiki is the work of a team. The wiki is created in an agile process: If someone asks something in the forum, it's a good idea to add it into the forum. No special knowledge is needed for that, just write and if it is ok, it isn't deleted :)

But eventually it will be changed or removed by others.

Don't be afraid: There is nothing, which you can really break, because the wiki has a version history.

Basic

  • Read the wiki pages.
    • If you don't like something, change it.
    • If you find typos, change it.
    • If you find something is wrong described, make a prove, that it is wrong and change it.

Advanced

  • Add missing information at the right place.
This is in most cases easy, but sometimes could be really difficult. Ask for help if you don't know.
  • Split the information on big pages into subpages.
See for example the Railway network.
  • If you find that a topic belongs to two pages, then don't copy the information into the two pages, but create a new page and link.
Best example for this is the Power Production page.
  • Take the right words.
Factorio has a set of words, which have a fixed meaning. For example: an entity can be mined, an item can be picked up. Removing them means something different! Ask the factorio wiki, if you are unsure.
  • A picture says more than 1000 words.
Make pictures, if possible. In some case use GIFs! See down.
  • You can also go to the Wiki To-do List and look, if there is a job you like.

Discussions

I (ssilk) prefer the forum for discussions and I hope this is not a problem, because I think, discussions on wiki-pages is to high-end for most potential wiki-writers.

Existing discussions

In the descending order of date:

http://www.factorioforums.com/forum/viewtopic.php?f=5&t=2047

http://www.factorioforums.com/forum/viewtopic.php?f=5&t=3205

http://www.factorioforums.com/forum/viewtopic.php?f=5&t=2429

http://www.factorioforums.com/forum/viewtopic.php?f=5&t=2255

Translations

This is currently a mess!

This is how it should work

This method is used by the Mediawiki-Team and we want to adapt it:

First some rules

  • The default language is English.
  • Any other language has no right to obtain a pagename, which collides with English.
  • No other language has the right to use a pagename, which means the same or something different in another language.

This is the logical consequence of the above rules

  • Let's say we have a page named Transport network.
  • Now someone translate that page to German: Because he doesn't know better, he names the page "Transport netzwerk".
  • This is a mess! Because for example in Swedish (it's just an example) this is also the translated pagename.
  • What's now right? Is Transport netzwerk now a German or a Swedish page?

Solution to this

The right pagename is Transport network/de for the German and Transport network/sv for the Swedish page.

Whuuaaaa... "Transport network" - that's not German!

Yes, but it is the only way to keep the namespace clean.

And there is nothing about making a redirect page Transport netzwerk which redirects to Transport network/de. Or make a page where the user can choose if he wants the German or Swedish page.

So what do I need to do now?

"Inserters" becomes "Inserters/fr" for France, "Inserters/ru" for Russian etc.
  • If you are working on a page, which has a translated pagename then rename (Move) it! Search the orginal pagename, add the language-code (see above) and move it to the new pagename. A redirect is automatically left for the old pagename!

(More to explain, language macro, see main-page at top right)

Pictures

Making pictures out of the game

Do's:

  • Take pictures at day! Turn on daylight! Use night or dawn only, if needed to explain something.
  • Use god mode! Lua/Player#controllertype. You can go to every place and don't stand in the way of the picture.
  • You can slowdown the game to find the right moment for the picture.
  • You can use also the Lua/Game#peacefulmode, to be not disturbed by the natives.
  • You can stop the game in the right moment using SHIFT-SPACE key. That also blends the grid in.
  • Learn how to use the Debug mode to add relevant information into this picture.
  • Go into the highest zoom level you possibly can, without missing any vital information.

Dont's

  • Don't make pictures of ultra-complicated stuff! Add only as much elements, which are needed to understand, how that might work.
  • Don't just take a screenshot. Try to remove all unneeded informations from the picture.
  • Try not to make a photo with the character, except if to should show something; then face the character to it.


See http://www.factorioforums.com/forum/viewtopic.php?f=6&t=2472 for more.

Optimizing the picture before upload

  • Cut as much as possible/nice.
  • Resolution should not normally be higher than 800x800 px.
  • Do not add textual information into the pictures! Instead add numbers or letters in it and add the text on the wiki-page; otherwise, it isn't searchable information.
  • Sharpen the pictures. For the wiki it looks quite better to sharpen the pictures one ore two times.

Making animations

This has to be tested a bit:

Gifcam (PC only)
Licecap (also for Mac)
Good example pictures: http://www.factorioforums.com/forum/viewtopic.php?f=5&t=3920