Help:MTA Wiki Specific Templates: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Rearranged and added template delete)
m (Updated template examples)
Line 6: Line 6:


'''Format:''' <nowiki>{{Deprecated}}</nowiki>
'''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>
{{MessageBox|
 
  bordercolorhex = FF0000 |
  bgcolorhex = FF7777 |
  image = File:Emblem-important.png |
  message = This {{#ifeq: {{padleft:|2|{{lc:{{PAGENAME}}}}}}|on|event|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]]
Wiki pages attached to this template will be added to the [[:Category:Deprecated]]


Line 15: Line 19:
'''Format:''' <nowiki>{{DeprecatedWithAlt|functionAlternative|More Text}}</nowiki>
'''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>
{{MessageBox|
Please use [[functionAlternative]] instead. More Text</div>
  bordercolorhex = FF0000 |
  bgcolorhex = FF7777 |
  image = File:Emblem-important.png |
  message = This {{#ifeq: {{padleft:|2|{{lc:{{PAGENAME}}}}}}|on|event|function}} is deprecated. This means that its use is discouraged and that it might not exist in future versions. |
  subtext = Please use [[functionAlternative]] instead. More text |
}}
Wiki pages attached to this template will be added to the [[:Category:Deprecated]]
Wiki pages attached to this template will be added to the [[:Category:Deprecated]]


Line 24: Line 33:
'''Format:''' <nowiki>{{Needs Example}}</nowiki>
'''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>
{{MessageBox|
  bordercolorhex = 000000 |
  bordertype = dotted |
  bgcolorhex = EFEFEF |
  image = File:Accessories-text-editor.png |
  title = Script Example Missing |
  message = {{#ifeq: {{padleft:|2|{{lc:{{PAGENAME}}}}}}|on|Event|Function}} <includeonly>{{FULLPAGENAME}}</includeonly> <noinclude><nowiki>{{FULLPAGENAME}}</nowiki></noinclude> needs a script example, help out by writing one. |
  subtext = <span style="font-size: 85%;">''Before submitting check out [[MTA_Wiki:Editing_Guidelines#Script_Examples|Editing Guidelines Script Examples]].''</span> |
}}
Wiki pages attached to this template will also be added to the [[:Category:Needs Example]]
Wiki pages attached to this template will also be added to the [[:Category:Needs Example]]


Line 30: Line 47:
Use this template when a function or event has been disabled in the code.
Use this template when a function or event has been disabled in the code.


'''Format without parameters:''' <nowiki>{{Disabled||}}</nowiki>
'''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>
{{MessageBox|
 
  bordercolorhex = FF0000 |
  bgcolorhex = E5E5E5 |
  image = File:Dialog-warning.png |
  title = {{#ifeq: {{padleft:|2|{{lc:{{PAGENAME}}}}}}|on|Event|Function}} has been disabled. |
}}
'''Format with parameters:''' <nowiki>{{Disabled|Function disabled because it crashes|1337}}</nowiki>
'''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.'''
{{MessageBox|
* Reason/Note: Function disabled because it crashes
  bordercolorhex = FF0000 |
* Bugtracker Issue: [http://bugs.mtasa.com/view.php?id=1337 #1337]
  bgcolorhex = E5E5E5 |
</div>
  image = File:Dialog-warning.png |
 
  title = {{#ifeq: {{padleft:|2|{{lc:{{PAGENAME}}}}}}|on|Event|Function}} has been disabled. |
  subtext = '''Reason/Note:''' Function disabled because it crashes | - '''Bugtracker Issue:''' [http://bugs.mtasa.com/view.php?id=1337 #1337] |
}}
Wiki pages attached to this template will be added to the [[:Category:Needs Checking]] and [[:Category:Disabled Functions and Events]].
Wiki pages attached to this template will be added to the [[:Category:Needs Checking]] and [[:Category:Disabled Functions and Events]].


Line 69: Line 92:


'''Format:''' <nowiki>{{Needs Checking|STATE_PROBLEM_HERE}}</nowiki>
'''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>
{{MessageBox|
 
  bordercolorhex = 0026FF |
  bordertype = dotted |
  bgcolorhex = AAAAFF |
  image = File:Dialog-information.png |
  title = This article needs checking. |
  subtext = '''Reason:''' STATE_PROBLEM_HERE |
}}
Wiki pages attached to this template will be added to the [[:Category:Needs_Checking]]
Wiki pages attached to this template will be added to the [[:Category:Needs_Checking]]


Line 76: Line 106:
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.
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>
'''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>
{{MessageBox|
  bordercolorhex = C0C0C0 |
  bgcolorhex = C9F9FF |
  bordertype = dotted |
  image = File:Dialog-information.png |
  title = This article is (partially) outdated and the information may no longer apply. |
}}


'''Format with reason:''' <nowiki>{{Outdated|The Reason HERE}}</nowiki>
'''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.'''  
{{MessageBox|
<br>Reason: The Reason HERE</div>
  bordercolorhex = C0C0C0 |
 
  bgcolorhex = C9F9FF |
  bordertype = dotted |
  image = File:Dialog-information.png |
  title = This article is (partially) outdated and the information may no longer apply. |
  subtext = '''Reason:''' The Reason HERE |
}}
Wiki pages attached to this template will be added to the [[:Category:Outdated Pages]]
Wiki pages attached to this template will be added to the [[:Category:Outdated Pages]]


Line 89: Line 130:


'''Format:''' <nowiki>{{Warning|Warning info here}}</nowiki>
'''Format:''' <nowiki>{{Warning|Warning info here}}</nowiki>
 
{{MessageBox|
<div style="border:1px solid red;background:#FFADAD;padding:5px;">[[File:Dialog-warning.png]] '''Warning:''' Warning info here</div>
  bordercolorhex = FF0000 |
 
  bgcolorhex = FFADAD |
  image = File:Dialog-warning.png |
  title = Warning: |
  message = Warning info here
}}
=== Note ===
=== 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>
<div style="border: 1px solid black; background: #FFFF7F; float: right; width: 200px; padding: 5px; margin: 5px; margin-right: 0px;">'''Note:''' Note info here</div>

Revision as of 20:19, 30 November 2011

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

Funtion / Event Templates

Function Deprecated

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

Format: {{Deprecated}}

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.

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}}


Emblem-important.png 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}}


Accessories-text-editor.png 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}}

Dialog-warning.png Function has been disabled.

Format with parameters: {{Disabled|Function disabled because it crashes|1337}}

Dialog-warning.png Function has been disabled.
Reason/Note: Function disabled because it crashes

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 Module Name. 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}}

Dialog-information.png 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}}

Dialog-information.png This article is (partially) outdated and the information may no longer apply.

Format with reason: {{Outdated|The Reason HERE}}

Dialog-information.png 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

Format: {{Warning|Warning info here}}

Dialog-warning.png Warning: Warning info here

Note

Note: Note info here

Note box is used for notes. The note box floats always right in the page/article.

Format: {{Note box|Note info here}}

Special

Delete

Mark a page for deletion, so administrators can decide if they remove the page.

Format: {{Delete||Reason here}}

Edit-delete.png 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

Retrieved from "https://wiki.multitheftauto.com/wiki/Help:MTA_Wiki_Specific_Templates?oldid=28521"