Help:MTA Wiki Specific Templates: Difference between revisions
mNo edit summary |
(Updated to match with the latest template changes) |
||
Line 1: | Line 1: | ||
Information about the specific MTA wiki page templates for this wiki. (They do probably not exists on other Mediawiki wiki's) | Information about the specific MTA wiki page templates for this wiki. (They do probably not exists on other Mediawiki wiki's) | ||
{{Tip|If you want to avoid spacing between the page title and the template itself, you should include the template before __NOTOC__ other templates and/or [http://www.mediawiki.org/wiki/Help:Magic_words magic words].}} | |||
{{ | |||
}} | |||
== Funtion / Event Templates == | == Funtion / Event Templates == | ||
Line 89: | Line 84: | ||
'''Format:''' <nowiki>{{ModuleFunction|Module Name}}</nowiki> | '''Format:''' <nowiki>{{ModuleFunction|Module Name}}</nowiki> | ||
{{MessageBox| | |||
bordercolorhex = FF0000 | | |||
image = File:Package-x-generic.png | | |||
message = This function is provided by the external module '''[[Modules/{{{1}}}|{{{1}}}]]'''. You must install this module to use this function. | |||
}} | |||
== Article/Page/Category Maintenance == | == Article/Page/Category Maintenance == | ||
Line 134: | Line 131: | ||
== General Templates == | == General Templates == | ||
=== Warning === | === Warning === | ||
Warning template for in-line warnings. | |||
'''Format:''' <nowiki>{{Warning|Warning info here}}</nowiki> | '''Format:''' <nowiki>{{Warning|Warning info here}}</nowiki> | ||
{{MessageBox| | {{MessageBox| | ||
bordercolorhex = | bordercolorhex = FFB2B2 | | ||
bgcolorhex = | bgcolorhex = FFE5E5 | | ||
title = Warning: | | |||
message = {{{1}}} | |||
}} | |||
Warning template for article warnings. | |||
'''Format:''' <nowiki>{{Warning|Warning info here|true}}</nowiki> | |||
{{MessageBox| | |||
bordercolorhex = FFB2B2 | | |||
bgcolorhex = FFE5E5 | | |||
image = File:Dialog-warning.png | | image = File:Dialog-warning.png | | ||
title = Warning: | | title = Warning: | | ||
message = | message = {{{1}}} | ||
}} | }} | ||
=== Note === | === Note === | ||
<div style="border: 1px solid black; background: #FFFF99; float: right; width: 200px; padding: 5px; margin: 5px; margin-right: 0px;">'''Note:''' Note info here</div> | <div style="border: 1px solid black; background: #FFFF99; float: right; width: 200px; padding: 5px; margin: 5px; margin-right: 0px;">'''Note:''' Note info here</div> | ||
Line 148: | Line 156: | ||
'''Format:''' <nowiki>{{Note box|Note info here}}</nowiki> | '''Format:''' <nowiki>{{Note box|Note info here}}</nowiki> | ||
=== Tip === | |||
'''Format:''' <nowiki>{{Tip|Text here}}</nowiki> | |||
{{MessageBox| | |||
bordercolorhex = 81C687 | | |||
bgcolorhex = E2FFE5 | | |||
message = '''Tip:''' Text here | | |||
}} | |||
== Special == | == Special == |
Revision as of 10:40, 22 January 2012
Information about the specific MTA wiki page templates for this wiki. (They do probably not exists on other Mediawiki wiki's)
Tip: If you want to avoid spacing between the page title and the template itself, you should include the template before other templates and/or magic words. |
Funtion / Event Templates
Function Deprecated
Functions that are being deleted from MTA because there is a more generic way.
Format: {{Deprecated}}
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. | |
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: {{DeprecatedWithAlt|functionAlternative|More Text}}
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions. | |
Please use functionAlternative instead. More text |
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: {{Needs Example}}
Script Example Missing Function {{FULLPAGENAME}} needs a script example, help out by writing one. | |
Before submitting check out Editing Guidelines Script Examples. |
Wiki pages attached to this template will also be added to the Category:Needs Example
Disabled Function/Event
Use this template when a function or event has been disabled in the code.
Format without parameters: {{Disabled}}
Function has been disabled. | |
Format with parameters: {{Disabled|Function disabled because it crashes|1337}}
Function has been disabled. | |
Reason/Note: Function disabled because it crashes - Bugtracker Issue: #1337 |
Wiki pages attached to this template will be added to the Category:Needs Checking and Category:Disabled Functions and Events.
Function/Event Requirements
Inform the reader that this function or event requires a specific MTA build.
Format: {{Requirements|1.1.1-9.serverbuild|1.1.1-9.clientbuild}}
Minimum supported server | 1.1.1-9.serverbuild |
---|---|
Minimum supported client | 1.1.1-9.clientbuild |
Note: Using this function requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section.
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: {{ModuleFunction|Module Name}}
This function is provided by the external module [[Modules/{{{1}}}|{{{1}}}]]. You must install this module to use this function. | |
Article/Page/Category Maintenance
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: {{Needs Checking|STATE_PROBLEM_HERE}}
This article needs checking. | |
Reason: STATE_PROBLEM_HERE |
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: {{Outdated}}
This article is (partially) outdated and the information may no longer apply. | |
Format with reason: {{Outdated|The Reason HERE}}
This article is (partially) outdated and the information may no longer apply. | |
Reason: The Reason HERE |
Wiki pages attached to this template will be added to the Category:Outdated Pages
General Templates
Warning
Warning template for in-line warnings.
Format: {{Warning|Warning info here}}
Warning: {{{1}}} |
Warning template for article warnings.
Format: {{Warning|Warning info here|true}}
Warning: {{{1}}} | |
Note
Note box is used for notes. The note box floats always right in the page/article.
Format: {{Note box|Note info here}}
Tip
Format: {{Tip|Text here}}
Tip: Text here |
Special
Delete
Mark a page for deletion, so administrators can decide if they remove the page.
Format: {{Delete||Reason here}}
This page is marked for deletion. | |
Reason: Reason Here Actions: Delete (Administrators) - Discuss - What links here - Category
|
Wiki pages attached to this template will be added to the Category:MTA Wiki:Delete