Help:Editing Guidelines

> This page is work in progress (WIP) <

Before you contribute to the Multi Theft Auto Wiki make sure you know/understand the basics of MediaWiki.

Editing Pages

Layout Function Pages

MediaWiki general help page: Editing Pages

Specific information for editing the MTA Wiki.

Contents of Function/Event Pages

Function and event pages have a layout that is easy to identify and consistent. Before adding function and/or event pages make sure they do exist in the MTA Core!

Layout Function Pages

• No Table of Contents: __NOTOC__
• Define Function Server and/or client function: {{Server client function}}
  • Server only function: {{Server function}}
  • Client only function: {{Client function}}
  • Both client and server: {{Server client function}}
• Explain the function
• Syntax: Use <syntaxhighlight lang="lua"></syntaxhighlight>
  • Required Arguments
  • Optional Arguments (not always necessary)
• Returns
• Example: If the function is both client and server make sure you add at least one for the server and one for the client. Or add template {{Needs Example}} at the top of the page.
• See Also: Add the template to which function group this function belongs

Layout Event Pages

TODO

Tips

• When creating a new page, you need to edit the template for 'See Also' too. If you don't add it to a function group template this page is considered orphaned and no one will find it unless they use the search function.
• If you add examples to a page make sure to remove template {{Needs Example}} when necessary.