Редактирование: Guide to autowiki (раздел)

= Autowiki =

Autowiki is a neat way of creating automatically generated wiki templates. 

If you are tasked with updating a large amount of sprites or information about a feature or system, you may see it fit to add an Autowiki to do. 

== Why Autowiki? ==

Autowiki, while appearing complex to set up at first, will keep a page 100% up to date with the code-base for all future changes to that feature automatically. 

This means you don't have to go in edit the page for the smallest of changes or to update sprites - the script, which runs daily, will do it for you. 

== Where to begin ==

To begin, you need to create the actual Autowiki datum that collates all the data you are adding. 

You will need a decently firm understanding of the game's code to accomplish this. 

The most important thing to note in the datum is the "include_template" proc. This proc is passed a template title and a list of data which is later passed to the wiki

== Ok, I made the datum, how do I test it? ==

Easiest way to test your setup is to look for "#define AUTOWIKI" in the code and uncomment it. Then, compile and run. 

In your local data files, you will see two relevant files - "Autowiki_edits.txt", which contains all the raw text for your setup, and "Autowiki_files", which is a folder of images created by your setup. 

There, you can verify it all looks correct. 

== And how do I apply it to the wiki? ==

When all is said and done, the Autowiki datum doesn't create the templates themselves - it creates data and automatically shoves it into templates for you to use elsewhere. 

You must make your own templates for the data to fill in.

Once you have your base templates created, an easy way to test it is to manually enter some of your generated data to see how it works. 

Once you are happy, you can submit your code as a pull request. Once it's merged, all is done!