Help:MTA Wiki Specific Templates - Revision history

Fernando187: Remove Requirements that are actually barely used, it's useless due to New feature/item

2024-11-07T15:38:03Z

Remove Requirements that are actually barely used, it's useless due to New feature/item

← Older revision		Revision as of 15:38, 7 November 2024
Line 27:		Line 27:

	Wiki pages containing this template will be added to the [[:Category:Needs Checking]] and [[:Category:Disabled Functions and Events]] for reference.		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/event ===		=== Module only function/event ===

Arran Fortuna: Fixed it.

2018-11-05T22:10:43Z

Fixed it.

← Older revision		Revision as of 22:10, 5 November 2018
Line 45:		Line 45:
	Notes: ''targetVersion'' parameter must be a number in the format 3.0XXX, where XXX is the version when the function/event/change will be applied. For example, if a function will be added in MTA version ''2.0.1'', put 3.0''201'' in ''targetVersion''. ''showVersion'' parameter is only visual and specifies the text contained in "From version ... onwards".		Notes: ''targetVersion'' parameter must be a number in the format 3.0XXX, where XXX is the version when the function/event/change will be applied. For example, if a function will be added in MTA version ''2.0.1'', put 3.0''201'' in ''targetVersion''. ''showVersion'' parameter is only visual and specifies the text contained in "From version ... onwards".

	'''Format:''' <nowiki>{{New ~~items~~\|targetVersion\|showVersion}}</nowiki>		'''Format:''' <nowiki>{{New feature/item\|targetVersion\|showVersion\|Revision}}</nowiki>
	<noinclude>{{New ~~items~~\|3.~~0300~~\|3.0\|		<noinclude>{{New feature/item\|3.0312\|2.9\|19999\|
	This template has ''3.~~0300~~'' and ''3.0'' ~~versions~~ as parameters, so it'll be removed and only this text will be shown when MTA version is 3.0 or higher.		This template has ''3.0157'' and ''2.9'' and ''19999'' as parameters, so it'll be removed and only this text will be shown when MTA version is 3.1.2 or higher.
	}}</noinclude>		}}</noinclude>

Winky-: Fix _NOTOC_

2017-01-26T21:00:32Z

Fix _NOTOC_

← Older revision		Revision as of 21:00, 26 January 2017
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].}}		{{Tip\|If you want to avoid spacing between the page title and the template itself, you should include the template before <nowiki>__NOTOC__</nowiki> other templates and/or [http://www.mediawiki.org/wiki/Help:Magic_words magic words].}}

	== Funtion / event templates ==		== Funtion / event templates ==

AlexTMjugador: /* Localized article */

2016-07-23T14:58:48Z

Localized article

← Older revision		Revision as of 14:58, 23 July 2016
Line 184:		Line 184:

	{{Localized article\|Main Page\|Wiki's main page\|us\|en}}		{{Localized article\|Main Page\|Wiki's main page\|us\|en}}
			For more information about the use of the template, please refer to [[Template:Localized article\|its page]].

	== Special ==		== Special ==

AlexTMjugador: /* Localized article */

2016-07-23T14:57:44Z

Localized article

← Older revision		Revision as of 14:57, 23 July 2016
Line 181:		Line 181:
	Adds a link to a localized article in this wiki, with a flag which represents the language the article is written in.		Adds a link to a localized article in this wiki, with a flag which represents the language the article is written in.

	'''Format:''' <nowiki>{{Localized article\|~~Article title~~\|~~Link text~~\|~~Language the article is written in~~\|~~Language the flag caption is written in~~}}</nowiki>		'''Format:''' <nowiki>{{Localized article\|Main Page\|Wiki's main page\|us\|en}}</nowiki>

	{{Localized article\|Main Page\|Wiki's main page\|us\|en}}		{{Localized article\|Main Page\|Wiki's main page\|us\|en}}

AlexTMjugador: Added Localized article template

2016-07-23T14:51:39Z

Added Localized article template

← Older revision		Revision as of 14:51, 23 July 2016
Line 176:		Line 176:
	message = '''Tip:''' Text here \|		message = '''Tip:''' Text here \|
	}}		}}

			== Localization ==
			=== Localized article ===
			Adds a link to a localized article in this wiki, with a flag which represents the language the article is written in.

			'''Format:''' <nowiki>{{Localized article\|Article title\|Link text\|Language the article is written in\|Language the flag caption is written in}}</nowiki>

			{{Localized article\|Main Page\|Wiki's main page\|us\|en}}

	== Special ==		== Special ==

Talidan at 12:15, 3 July 2016

2016-07-03T12:15:26Z

← Older revision		Revision as of 12:15, 3 July 2016
Line 48:		Line 48:
	<noinclude>{{New items\|3.0300\|3.0\|		<noinclude>{{New items\|3.0300\|3.0\|
	This template has ''3.0300'' and ''3.0'' versions as parameters, so it'll be removed and only this text will be shown when MTA version is 3.0 or higher.		This template has ''3.0300'' and ''3.0'' versions as parameters, so it'll be removed and only this text will be shown when MTA version is 3.0 or higher.
			}}</noinclude>


			If you want to display a change from a previous version in the format of "Before version x.x", use the following code:

			'''Format:''' <nowiki>{{Deprecated feature\|untilVersion\|showVersion}}</nowiki>
			<noinclude>{{Deprecated feature\|3.0300\|3.0\|
			This template has ''3.0300'' and ''3.0'' versions as parameters, so this box will only be displayed until MTA's version is 3.0 or higher. After that, it'll disappear completely.
	}}</noinclude>		}}</noinclude>

AlexTMjugador: /* New function/event/change */

2014-07-04T18:30:59Z

New function/event/change

← Older revision		Revision as of 18:30, 4 July 2014
Line 46:		Line 46:

	'''Format:''' <nowiki>{{New items\|targetVersion\|showVersion}}</nowiki>		'''Format:''' <nowiki>{{New items\|targetVersion\|showVersion}}</nowiki>
	<noinclude>{{New items\|3.~~300~~\|3.0\|		<noinclude>{{New items\|3.0300\|3.0\|
	This template has ''3.~~000~~'' and ''3.0'' versions as parameters, so it'll be removed and only this text will be shown when MTA version is 3.0 or higher.		This template has ''3.0300'' and ''3.0'' versions as parameters, so it'll be removed and only this text will be shown when MTA version is 3.0 or higher.
	}}</noinclude>		}}</noinclude>

AlexTMjugador: Templates are dynamic and updated now; added New items template at →‎Funtion / Event Templates: (part II)

2014-07-04T15:03:49Z

Templates are dynamic and updated now; added New items template at →‎Funtion / Event Templates: (part II)

← Older revision		Revision as of 15:03, 4 July 2014
Line 34:		Line 34:
	<noinclude>{{Requirements\|minServerBuild\|minClientBuild}}</noinclude>		<noinclude>{{Requirements\|minServerBuild\|minClientBuild}}</noinclude>

	=== Module ~~Only Function~~ ===		=== Module only function/event ===
	~~Module~~ only function template, inform readers that this function is module specific and not build-in to MTA itself.		Use this template to indicate a module only function/event template. That will 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.		Note: You only have to add the module name not the 'Modules/' prefix.

	'''Format:''' <nowiki>{{ModuleFunction\|Module Name}}</nowiki>		'''Format:''' <nowiki>{{ModuleFunction\|Module Name}}</nowiki>
	{{~~MessageBox~~\|		<noinclude>{{ModuleFunction\|ModuleName}}</noinclude>
	~~bordercolorhex~~ = ~~FF0000 \|~~
	~~image = File:Package-x-generic~~.~~png \|~~		=== New function/event/change ===
	~~message =~~ This function is ~~provided by~~ the ~~external module~~ '''~~[[Modules~~/{{{1}}}\|{{~~{1}}}]]~~'''. ~~You must install~~ this ~~module to use this function~~.		Use this template to indicate a function, event or change that will be applied in a future version of MTA. This template is best used when it contains the function/event/change description, because it removes itself when MTA gets updated (MTA version is greater than the ''targetVersion'' specified in this template parameters). All arguments of this template are mandatory.
	}}		Notes: ''targetVersion'' parameter must be a number in the format 3.0XXX, where XXX is the version when the function/event/change will be applied. For example, if a function will be added in MTA version ''2.0.1'', put 3.0''201'' in ''targetVersion''. ''showVersion'' parameter is only visual and specifies the text contained in "From version ... onwards".

			'''Format:''' <nowiki>{{New items\|targetVersion\|showVersion}}</nowiki>
			<noinclude>{{New items\|3.300\|3.0\|
			This template has ''3.000'' and ''3.0'' versions as parameters, so it'll be removed and only this text will be shown when MTA version is 3.0 or higher.
			}}</noinclude>

	== Article/Page/Category Maintenance ==		== Article/Page/Category Maintenance ==
Line 181:		Line 186:

	[[Category:MTA Wiki:Editing]]		[[Category:MTA Wiki:Editing]]
			__HIDDENCAT__

AlexTMjugador: Templates are dynamic and updated now at /* Funtion / Event Templates */ (part I)

2014-07-04T13:38:45Z

Templates are dynamic and updated now at Funtion / Event Templates: (part I)

← Older revision		Revision as of 13:38, 4 July 2014
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 / ~~Event Templates~~ ==		== Funtion / event templates ==
	=== ~~Function~~ Deprecated ===		=== Deprecated function/event ===
	~~Functions~~ that are being deleted from MTA because there is a more generic way.		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>
	{{~~MessageBox\|~~		<noinclude>{{Deprecated}}
	~~bordercolorhex = FF0000 \|~~		{{Deprecated\|alternativeFunction\|more text}}</noinclude>
	~~bgcolorhex = FFBFBF \|~~
	~~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]]~~

	~~=== Function~~ Deprecated ~~With Alternative ===~~		Wiki pages containing this template will be added to the [[:Category:Deprecated]] for reference.
	~~Same as above but now with a linked alternative function~~.

	~~'''Format:''' <nowiki>{{DeprecatedWithAlt\|functionAlternative\|More Text}}</nowiki>~~		=== Function/event needs example ===
			Use this template to indicate when a function or event needs a scripting example.
	~~{{MessageBox\|~~
	~~bordercolorhex~~ = ~~FF0000 \|~~
	~~bgcolorhex~~ = ~~FFBFBF \|~~
	~~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]]~~

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

	'''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.

	~~{{MessageBox\|~~		=== Disabled function/event ===
	~~bordercolorhex = 000000 \|~~		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.
	~~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 [[Help:Editing_Guidelines#Script_Examples\|Editing Guidelines Script Examples]].''</span> \|~~
	}}
	~~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~~:''' <nowiki>{{Disabled}}</nowiki>		'''Format:''' <nowiki>{{Disabled\|reason\|bugTrackerIssueNumber}}</nowiki>
	{{~~MessageBox\|~~		<noinclude>{{Disabled}}
	~~bordercolorhex = FF0000 \|~~		{{Disabled\|reason\|bugTrackerIssueNumber}}</noinclude>
	~~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~~>
	~~{{MessageBox\|~~
	~~bordercolorhex = FF0000 \|~~
	~~bgcolorhex = E5E5E5 \|~~
	~~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]].~~

	~~=== Function/Event Requirements ===~~		Wiki pages containing this template will be added to the [[:Category:Needs Checking]] and [[:Category:Disabled Functions and Events]] for reference.
	~~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>~~		=== Function/event requirements ===
			Use this template to inform the reader that this function or event requires a minimum MTA build to work.

	{\| ~~cellpadding="4" style="border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #FFF"~~		'''Format:''' <nowiki>{{Requirements\|minServerBuild\|minClientBuild}}</nowiki>
	\|-		<noinclude>{{Requirements\|minServerBuild\|minClientBuild}}</noinclude>
	~~!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.~~

	=== Module Only Function ===		=== Module Only Function ===