View source for Help:MTA Wiki Specific Templates

Information about the specific MTA wiki page templates for this wiki. (They do probably not exists on other Mediawiki wiki's)
__TOC__

== Article Needs Checking ==
These are functions that need to be checked to ensure they do work as specified. If there are any problems with a function, example or the wiki page itself, attach a note to the top of the page and describe the problems.

'''Format:''' <nowiki>{{Needs Checking|STATE_PROBLEM_HERE}}</nowiki>
<div style="border: 1px dotted blue; background: #AAAAFF;padding:4px;margin-bottom:2px;">[[file:Dialog-information.png]]'''This article needs checking for the following reason:''' STATE_PROBLEM_HERE</div>

Wiki pages attached to this template will be added to the [[:Category:Needs_Checking]]

== Article Outdated ==
If the information in the article no longer applies and/or an alternative article exists you can use this template and link to the alternative article. If it is still useful and/or (partially) valid and needs to be updated or no alternative article exists use the 'Article Needs Checking' template.

'''Format without reason:''' <nowiki>{{Outdated|}}</nowiki>
<div style="border: 1px dotted #C0C0C0; background: #C9F9FF;padding:4px;margin-bottom:2px;">[[file:Dialog-information.png]]'''This article is (partially) outdated and the information may no longer apply.'''</div>

'''Format with reason:''' <nowiki>{{Outdated|The Reason HERE}}</nowiki>
<div style="border: 1px dotted #C0C0C0; background: #C9F9FF;padding:4px;margin-bottom:2px;">[[file:Dialog-information.png]]'''This article is (partially) outdated and the information may no longer apply.''' 
<br>Reason: The Reason HERE</div>

Wiki pages attached to this template will be added to the [[:Category:Outdated Articles]]

== Function Deprecated ==
Functions that are being deleted from MTA because there is a more generic way.

'''Format:''' <nowiki>{{Deprecated}}</nowiki>
<div style="border:3px solid red;background:#FF7777;padding:5px;">[[File:Emblem-important.png]] This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be an alternative (usually more generic) way of performing what it once did.</div>

Wiki pages attached to this template will be added to the [[:Category:Deprecated]]

== Function Deprecated With Alternative ==
Same as above but now with a linked alternative function.

'''Format:''' <nowiki>{{DeprecatedWithAlt|functionAlternative|More Text}}</nowiki>

<div style="border:3px solid red;background:#FF7777;padding:5px;">[[file:Emblem-important.png‎]] This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.<br><br>
Please use [[functionAlternative]] instead. More Text</div>
Wiki pages attached to this template will be added to the [[:Category:Deprecated]]

== Function Needs Example ==
Use this template when a function or event needs an example.

'''Format:''' <nowiki>{{Needs Example}}</nowiki>

<div style="border: 1px dotted black; background: #EFEFEF;padding:4px;margin-bottom:2px;">[[File:Accessories-text-editor.png]] '''Script Example Missing''' - Function <nowiki>{{FULLPAGENAME}}</nowiki> needs a script example, help out by writing one.</div>
Wiki pages attached to this template will also be added to the [[:Category:Needs Example]]

== Warning ==

'''Format:''' <nowiki>{{Warning|Warning info here}}</nowiki>

<div style="border:1px solid red;background:#FFADAD;padding:5px;">[[File:Dialog-warning.png]] '''Warning:''' Warning info here</div>

== Note ==
<div style="border: 1px solid black; background: #FFFF7F; float: right; width: 200px; padding: 5px; margin: 5px; margin-right: 0px;">'''Note:''' Note info here</div>
Note box is used for notes. The note box floats always right in the page/article.

'''Format:''' <nowiki>{{Note box|Note info here}}</nowiki>

== Module Only Function ==
Module only function template, inform readers that this function is module specific and not build-in to MTA itself.
Note: You only have to add the module name not the 'Modules/' prefix.

'''Format:''' <nowiki>{{ModuleFunction|Module Name}}</nowiki>

<div style="border:2px solid red;padding:3px;">This function is provided by the external module '''[[Modules/Module Name|Module Name]]'''. You must install this module to use this function.</div>

== Function/Event Requirements ==
Inform the reader that this function or event requires a specific MTA build.

'''Format:''' <nowiki>{{Requirements|1.1.1-9.serverbuild|1.1.1-9.clientbuild}}</nowiki>

{| cellpadding="4" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #FFF"
|-
!style="background-color: #FFAA44; border-style: solid; border-width: 1px; border-color: #FFF; color:#7A4A20"| Minimum supported server
!width=60 style="background-color: #FFCC66; border-style: solid; border-width: 1px; border-color: #FFF"| 1.1.1-9.serverbuild
|-
!style="background-color: #FF6666; border-style: solid; border-width: 1px; border-color: #FFF; color:#AA0028"| Minimum supported client
!style="background-color: #FFBBBB; border-style: solid; border-width: 1px; border-color: #FFF"| 1.1.1-9.clientbuild
|}Note: Using this function requires the resource to have the above minimum version declared in the [[Meta.xml|meta.xml]] '''<min_mta_version>''' section.

== Disabled Function/Event ==
Use this template when a function or event has been disabled in the code.

'''Format without parameters:''' <nowiki>{{Disabled||}}</nowiki>
<div style="border:1px solid red;background:#E5E5E5;padding:5px;">[[File:Dialog-warning.png]] '''Function has been disabled.'''</div>

'''Format with parameters:''' <nowiki>{{Disabled|Function disabled because it crashes|1337}}</nowiki>
<div style="border:1px solid red;background:#E5E5E5;padding:5px;">[[File:Dialog-warning.png]] '''{{#ifeq: {{padleft:|2|{{lc:{{PAGENAME}}}}}}|on|Event|Function}} has been disabled.'''
* Reason/Note: Function disabled because it crashes
* Bugtracker Issue: [http://bugs.mtasa.com/view.php?id=1337 #1337]
</div>

Wiki pages attached to this template will be added to the [[:Category:Needs Checking]] and [[:Category:Disabled Functions and Events]].

[[Category:MTA Wiki:Editing]]