Tutorials: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 4: Line 4:
[[File:Mtalogo.png|left|100px|link=http://wiki.multitheftauto.com/]]'''Welcome to the [[Multi Theft Auto]] tutorial section.''' On this section you'll find a wealth of tutorials teaching you how to use Multi Theft Auto effectively.  
[[File:Mtalogo.png|left|100px|link=http://wiki.multitheftauto.com/]]'''Welcome to the [[Multi Theft Auto]] tutorial section.''' On this section you'll find a wealth of tutorials teaching you how to use Multi Theft Auto effectively.  


There are many [[How you can help|things you can do to help us]] improve MTA - create a map, a gamemode, help document scripting functions, write example code, write tutorials or just play MTA and report the bugs you find. You might be here for some help, but if you're here to create a tutorial - thanks. You can view a list of all the documented tutorials in this wiki page [[:Category:Tutorials|here]].
There are many [[How you can help|things you can do to help us]] improve MTA - create a map, a gamemode, help document scripting functions, write example code, write tutorials or just play MTA and report the bugs you find. You might be here for some help, but if you're here to create a tutorial - thanks. You can view a list of all the documented tutorials in this wiki page [[Category:Tutorials|here]].


If you have any questions or problems related to scripting, feel free to get in touch with us on our [[IRC Channel]].
If you have any questions or problems related to scripting, feel free to get in touch with us on our [[IRC Channel]].
Line 19: Line 19:
* Tutorials must be written in text, supported by images or videos when necessary.
* Tutorials must be written in text, supported by images or videos when necessary.
* All tutorials must follow the '''<nowiki>Tutorial/{{tutname}}</nowiki>''' syntax in the wiki name
* All tutorials must follow the '''<nowiki>Tutorial/{{tutname}}</nowiki>''' syntax in the wiki name
* Append '''<nowiki>[[Category:Modules]]</nowiki>''' to the tutorial page to make it properly appear in the tutorial list, don't edit the list directly.
* Append '''<nowiki>[[:Category:Tutorials]]</nowiki>''' to the tutorial page to make it properly appear in the tutorial list, don't edit the list directly.
* Exclude "how to" from the title name, try to stick to the naming structure of WikiHow.com
* Exclude "how to" from the title name, try to stick to the naming structure of WikiHow.com
__NOTOC__
__NOTOC__

Revision as of 23:18, 6 September 2013

Mtalogo.png
Welcome to the Multi Theft Auto tutorial section. On this section you'll find a wealth of tutorials teaching you how to use Multi Theft Auto effectively.

There are many things you can do to help us improve MTA - create a map, a gamemode, help document scripting functions, write example code, write tutorials or just play MTA and report the bugs you find. You might be here for some help, but if you're here to create a tutorial - thanks. You can view a list of all the documented tutorials in this wiki page.

If you have any questions or problems related to scripting, feel free to get in touch with us on our IRC Channel.

Tutorial criteria

  • All tutorials must be tested, if not tested they should be marked as so.
  • Use a uniform scripting style throughout your tutorial
  • Tutorials must be taught, not just shown and commented. Commenting is important, but it must be effective.
  • Commenting must be effective, don't comment every line and especially don't individually comment every addCommandHandler
  • Posting code which is commented but not going through the code is NOT what a tutorial is!
  • Tutorials must be written in text, supported by images or videos when necessary.
  • All tutorials must follow the Tutorial/{{tutname}} syntax in the wiki name
  • Append [[:Category:Tutorials]] to the tutorial page to make it properly appear in the tutorial list, don't edit the list directly.
  • Exclude "how to" from the title name, try to stick to the naming structure of WikiHow.com