Template:MacroFunction: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Changed headers to make it easier to edit certain sections. Removed periods from the end of version and compatibility.)
(Added depreciated parameter.)
Line 6: Line 6:
|name=exampleFunction
|name=exampleFunction
|proposed=true
|proposed=true
|depreciated=[[newFunction|newFunction()]]
|trusted=true
|trusted=true
|version=1.3b50
|version=1.3b50
Line 35: Line 36:
}}</pre>
}}</pre>
=Source=
=Source=
</noinclude>{{#ifeq: {{{proposed|}}} | true | {{ProposedChange}} |}}
</noinclude>{{#ifeq: {{{proposed|}}} | true | {{ProposedChange}} |}}{{#if: {{{depreciated|}}} | {{Depreciated|{{{depreciated}}} |}} |}}
=={{{name}}}() Function==
=={{{name}}}() Function==
{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}} |}}
{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}} |}}

Revision as of 09:19, 10 March 2009

Template Usage

Refer to Help:Editing for more detailed documentation.

Example

{{MacroFunction
|name=exampleFunction
|proposed=true
|depreciated=[[newFunction|newFunction()]]
|trusted=true
|version=1.3b50
|compatibility=1.3b52
|description=
This is an example function.  It doesn't actually exist as a function in MapTool.

|usage=
<source lang="mtmacro" line>
exampleFunction(param1, param2)
</source>

|example=
This example doesn't really do anything.
<source lang="mtmacro" line>
[h: exampleVariable = "a,b,c"]
[r: exampleFunction(exampleVariable, reverse)]
</source>
Returns:
<source lang="mtmacro" line>
c,b,a
</source>

|also=
[[linkToRelatedArticle|Display Name of Related Article]]

|changes=
* '''1.3b52''' - Added reverse parameter.
}}

Source

{{{name}}}() Function

Usage

{{{usage}}}