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 if function is server and/or client: {{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
• See Also: Add the template to which function group this function belongs

Layout Event Pages

• No Table of Contents: __NOTOC__
• Define if event is server or client: {{server event}}
  • Server event: {{Server event}}
  • Client event: {{Client event}}
• Parameters
• Source: The source of the event.
• Example
• See Also

Events can only be server or client side not both.

Tips

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

Templates

MediaWiki general help page: Templates

Templates are a consistent set of visual styling and can be used in articles to get the reader's attention or mark a page for example as outdated. Some templates also require arguments, for more information on how to use MTA's specific wiki templates go here.

Using templates is recommended when using the same content over a large number of pages. This will save you time when you want to change something in that content and doesn't require you to edit all the pages but just the template.

• How to use MTA Wiki's Specific templates

Icons

When you want to use icons, it is recommended to use general icons this improves the consistency of the wiki.

• Tango Icon List

Helpful links

• Cheatsheet