Help:MTA Wiki Specific Templates: Difference between revisions
(→Article/Page/Category Maintenance: Added template outdatedtr) |
m (Templates are dynamic and updated now at →Funtion / Event Templates: (part I)) |
||
Line 2: | Line 2: | ||
{{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].}} | {{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 / | == Funtion / event templates == | ||
=== | === Deprecated function/event === | ||
Use this template to indicate functions or events that are being deleted from MTA because there is a more generic way to perform what they do (and they are necessary no longer). The last two arguments of this template aren't mandatory, and can be ignored if there isn't an alternative function or aditional text. | |||
'''Format:''' <nowiki>{{Deprecated}}</nowiki> | '''Format:''' <nowiki>{{Deprecated|alternativeFunction|more text}}</nowiki> | ||
{{ | <noinclude>{{Deprecated}} | ||
{{Deprecated|alternativeFunction|more text}}</noinclude> | |||
}} | |||
Wiki pages containing this template will be added to the [[:Category:Deprecated]] for reference. | |||
=== Function/event needs example === | |||
Use this template to indicate when a function or event needs a scripting example. | |||
Use this template when a function or event needs | |||
'''Format:''' <nowiki>{{Needs Example}}</nowiki> | '''Format:''' <nowiki>{{Needs Example}}</nowiki> | ||
<noinclude>{{Needs Example}}</noinclude> | |||
Wiki pages containing this template will be added to the [[:Category:Needs Example]] for reference. | |||
=== Disabled function/event === | |||
Use this template to indicate when a function or event has been disabled in the MTA: SA source code. Normally there's an important reason for this. The last two parameters aren't mandatory and can be ignored. | |||
=== Disabled | |||
Use this template when a function or event has been disabled in the code. | |||
'''Format | '''Format:''' <nowiki>{{Disabled|reason|bugTrackerIssueNumber}}</nowiki> | ||
{{ | <noinclude>{{Disabled}} | ||
{{Disabled|reason|bugTrackerIssueNumber}}</noinclude> | |||
Wiki pages containing this template will be added to the [[:Category:Needs Checking]] and [[:Category:Disabled Functions and Events]] for reference. | |||
=== Function/event requirements === | |||
Use this template to inform the reader that this function or event requires a minimum MTA build to work. | |||
{| | '''Format:''' <nowiki>{{Requirements|minServerBuild|minClientBuild}}</nowiki> | ||
| | <noinclude>{{Requirements|minServerBuild|minClientBuild}}</noinclude> | ||
|} | |||
=== Module Only Function === | === Module Only Function === |
Revision as of 13:38, 4 July 2014
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
Deprecated function/event
Use this template to indicate functions or events that are being deleted from MTA because there is a more generic way to perform what they do (and they are necessary no longer). The last two arguments of this template aren't mandatory, and can be ignored if there isn't an alternative function or aditional text.
Format: {{Deprecated|alternativeFunction|more text}}
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does. | |
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions. | |
Please use alternativeFunction instead. more text |
Wiki pages containing this template will be added to the Category:Deprecated for reference.
Function/event needs example
Use this template to indicate when a function or event needs a scripting example.
Format: {{Needs Example}}
Script Example Missing Function Help:MTA Wiki Specific Templates needs a script example, help out by writing one. | |
Before submitting check out Editing Guidelines Script Examples. |
Wiki pages containing this template will be added to the Category:Needs Example for reference.
Disabled function/event
Use this template to indicate when a function or event has been disabled in the MTA: SA source code. Normally there's an important reason for this. The last two parameters aren't mandatory and can be ignored.
Format: {{Disabled|reason|bugTrackerIssueNumber}}
Function has been disabled. | |
Function has been disabled. | |
Reason/Note: reason - Bugtracker Issue: #bugTrackerIssueNumber |
Wiki pages containing this template will be added to the Category:Needs Checking and Category:Disabled Functions and Events for reference.
Function/event requirements
Use this template to inform the reader that this function or event requires a minimum MTA build to work.
Format: {{Requirements|minServerBuild|minClientBuild}}
This template will be deleted.
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
Article translation Outdated
If the article translation is outdated use this template.
Format without subtext: {{Outdatedtr}}
This translated article is (partially) outdated and the information may no longer apply. | |
Format with subtext: {{Outdatedtr|The subtext here}}
This translated article is (partially) outdated and the information may no longer apply. | |
The subtext 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: Warning info here |
Warning template for article warnings.
Format: {{Warning|Warning info here|true}}
Warning: Warning info here | |
Note
The note box floats always right in the page/article.
Format: {{Note box|Note info here}}
Template for in-line note:
Format: {{Note|Note info here}}
Note: Note info here |
Alternative in-line note:
Format: {{Important Note|Note info here}}
Important Note: 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