Factorio:Wiki rules

From Official Factorio Wiki
Jump to navigation Jump to search

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.

If you need more rights to the wiki (deletion, moving...) you need to ask the devs directly, or ask in the forum board.

How to understand the wiki?

There is currently an forum article, which should give you a good introduction, how this wiki works: http://www.factorioforums.com/forum/viewtopic.php?f=50&t=5994&p=46947#p46749

How to contribute?

This wiki is the work of a team. The people like to add information or bring it into better context, or they are doing videos, or design web pages.

The team communicates through the talk-pages ("Discussion" folder at the top) or through the forum ( http://www.factorioforums.com/forum/viewforum.php?f=50 ). It is very important to look into the "Recent changes", so that you see, if someone modified a page (especially a talk:-page), in which you are interested.

(BTW: You can change the shown results in the preferences!)

There are different jobs you can do. We begin from simple to complex.

Corrector

Read through the pages (of your language) and correct mistakes or bad language use. If it sounds ugly then change it. If you do so, you'll see walls of text. This is how mediawiki works. Sorry, but it's the way you'll learn to do more. :)

Translator

Take an English page, copy the content into a subpage (see down, what we mean!) and translate.

Writer and Linker

If someone asks something in the forum, and there is a good answer, it's a good idea to add that information into the wiki. No special knowledge is needed for that, just search the right page, the right chapter or add a new and write and if it is ok, it isn't deleted by the next. :)

Sometimes you don't have time for that, but you read an interesting fact about Factorio, you found something interesting fact? Some quite interesting information in the forum?

  • Stage 1: Simply copy the link and put it into the right page under "See also". This is to document: look, this belongs also to this page, but I don't have time yet.
  • Stage 2: the next, who reads it, and has time, takes the condensed information from that link writes it into the page. That should normally be enough.
  • Stage 3: if that sub information is too big, or if there are some more information about that, then move it to a subpage. (There are some examples in the wiki, how to use subpages, in general it's just adding a "/subpage name" to the existing.)

News-maker

There are the News-page. Just add new links, as interesting new information comes out. The rest is explained into the page as comment, just make it equally.

Is this a news or not? Good question. See it from historical point of view: when you will go back to the older news, will your news be still relevant?

Designer

This is about the look and feel of this wiki. It is quite interesting what can be done with such relatively simple nesting. But it is also quite confusing. :)

Deep knowledge of Mediawiki's template system is not really needed, but will help. For the beginning just try to understand, how the current templates work. Make your own test-page in your user-space and try to program around. It can make really fun, cause this task is more or less like programming.

Look here for a first idea, how it works: http://www.factorioforums.com/forum/viewtopic.php?f=50&t=5994&p=46947#p46749

Tutor for beginners

This is about writing tutorials. How to make things in factorio. This is currently a problem, cause the game changes and will change. The plans are to be about "ready" in summer 2015. So if you write a tutorial now it will be outdated in a few month.

Nonetheless this job is needed, cause more and more will ask for beginner tutorials and it shows up more and more, that this is really read and used, so by writing/recording (videos are welcome) you can influence how the community will play this game.

Architect

The wiki is created in an agile process: writing, reading, playing. :) When you found out, that this process is somehow inefficient, cause the things are not, where you expect them, then you need to change the wiki in general.

This is for example currently the case for the whole "networks" they are not longer a good idea. The logistic network and robotic network are in truth a "robotic system", which contains a construction- and a logistic-area. And the logistic area can be extended over the logistic network.

So the job of an architect is to bring the existing pages into the right context by adding some new pages and/or renaming existing, then change the links to the pages. And sometimes old stuff must be deleted.

Dowhateveryouwant

These "roles" are not fixed! Of course. There is no rule saying, that a translator cannot write poems about the deep insights he has gained by playing Factorio. And there are eventually also a audience, which will like that. (I mean that seriously.)

So, if you have an idea:

  • Don't be afraid: There is nothing, which you can really break, because the wiki has a version history.
  • If you are still afraid: You can use first a test page in your home-space. That's the pages beginning with "User:<your user name>". You can add a subpage like "User:<your user name>/MyTests". Ask others, what they think about it. Communicate!
  • Begin with slight changes. The others will watch (the "Recent changes" is important). If after a week or two is no response/follow up change, your change was good. Keep going, make bigger changes.

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

For translating the game the dev-team uses https://crowdin.com/project/factorio

This is about translating the wiki.

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. Example:

http://www.mediawiki.org/wiki/Help:Navigation The english default

http://www.mediawiki.org/wiki/Help:Navigation/es Spanish translation

http://www.mediawiki.org/wiki/Help:Navigation/de German tranlation

http://www.mediawiki.org/wiki/Help:Navigation/ru Russian translation


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

Picture formats

For making it simple we should use only formats based on 100. This is to avoid different sized pics which look staggered. This is especially important for the width, for the height it is not that problem. For example: 200x200, 300x100, 400x232. For existing pics (old pics use often a width of 256 px) reduce the with in text to 200 px (and analogous).

  • (100 - 200) x (100-300) px
for flowing in the text, pictures which explain the text, the browser can embed this into it's own rendering. You can put them left or right, the text should flow around.
  • (400 - 600) x (100 - 600) px
Something like a banner. A big pic which stays alone in its line. You may put simply a ":" in front of it to intend the pic and keep it away from flowing text.
  • 300 x 300 px
This is especially for gif animations. Gif animations cannot be reduced in size, cause mediawiki re-renders the picture and the result is the first frame of the gif! See for example these pics: http://www.factorioforums.com/wiki/index.php?limit=200&ilsearch=Mpstark&user=&title=Special%3AListFiles
  • the biggest format for flowing text should be: 600x600px

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.
  • Turn off clouds! The shadows are especially in GIF-animations not useful.
  • Steam/smoke is also not so useful.
  • 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. Slowdown is also useful, if you use Gifcam, which makes screenshoot in 30 frames/sec only.
  • 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.
  • A good in-game picture should be rebuilt, so that only the relevant entities/items are shown. Every repetition, every unneeded element will complicate it.

Dont's

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

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

Taking screenshoots, animations and videos

Taking screenshoots

Optimizing the picture before upload

  • Cut as much as possible/nice.
  • Resolution should not normally be higher than 600x600 px. If that seems too small, then you should rethink what you want to do.
  • 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,if it is written into the pic.
  • Sharpen the pictures. For the wiki it looks quite better to sharpen the pictures one or 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

Making videos/streaming

Youtubin' & Streamin'

In-game API for screenshots

http://www.factorioforums.com/forum/viewtopic.php?f=25&t=4109#p30605

Looks like a plan: create a world. Walk through the world. Start a replay of this walk and then add making screenshots.

More or less like the method used in the demo-video, but take only some gif-animations or single pictures.

Retrieved from "https://testing-wiki.factorio.com/index.php?title=Factorio:Wiki_rules&oldid=113435"