Template:MacroFunction: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Corrected linebreak.)
m (Changed headers to make it easier to edit certain sections. Removed periods from the end of version and compatibility.)
Line 1: Line 1:
<noinclude>
<noinclude>
==Template Usage==
=Template Usage=
Refer to [[Help:Editing]] for more detailed documentation.
Refer to [[Help:Editing]] for more detailed documentation.
===Example===
==Example==
<pre>{{MacroFunction
<pre>{{MacroFunction
|name=exampleFunction
|name=exampleFunction
Line 34: Line 34:
* '''1.3b52''' - Added reverse parameter.
* '''1.3b52''' - Added reverse parameter.
}}</pre>
}}</pre>
=Source=
</noinclude>{{#ifeq: {{{proposed|}}} | true | {{ProposedChange}} |}}
</noinclude>{{#ifeq: {{{proposed|}}} | true | {{ProposedChange}} |}}
=={{{name}}}() Function==
=={{{name}}}() Function==
{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}} |}}
{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}} |}}
{{#if: {{{version|}}} | <div>* '''Introduced in version {{{version|}}}.'''</div> |}}
{{#if: {{{version|}}} | <div>* '''Introduced in version {{{version|}}}'''</div> |}}
{{#if: {{{compatibility|}}} | <div>* '''Last checked for compatibility with version {{{compatibility|}}}.'''</div> |}}{{{description|}}}
{{#if: {{{compatibility|}}} | <div>* '''Last checked for compatibility with version {{{compatibility|}}}'''</div> |}}{{{description|}}}
===Usage===
===Usage===
{{{usage}}}
{{{usage}}}

Revision as of 02:19, 9 March 2009

Template Usage

Refer to Help:Editing for more detailed documentation.

Example

{{MacroFunction
|name=exampleFunction
|proposed=true
|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}}}