Latest revision as of 07:52, 6 March 2019

Template Usage

You should always write the description as though the words "This function..." are automatically supplied by the template.

Refer to Help:Editing for more detailed documentation.

Example

{{MacroFunction
|name=exampleFunction
|proposed=true
|deprecated=
[[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.
If you put a bulleted list here, don't end the description with the list.
MediaWiki encloses this parameter inside a DIV block and it will put the close
DIV tag inside the last LI.  For this reason, you may see description
parameters whose values contain a bulleted list followed by a line
that contains only, "&nbsp;"
{{__TOC__}}
|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}}}

@@ Line 1: / Line 1: @@
-==Function {{{name}}}==
+<noinclude>
-{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}} | }}
+=Template Usage=
-{{#if: {{{version|}}} | * '''Introduced in version {{{version|}}}.''' }}
+''You should always write the description as though the words "This function..." are automatically supplied by the template.''
-{{#if: {{{compatibility|}}} | * '''Last checked for compatibility with version {{{compatibility|}}}.''' }}
-{{{description|}}}
-===Usage===
-{{{usage}}}
-{{#if: {{{example|}}} |
+Refer to [[Help:Editing]] for more detailed documentation.
-===Example===
+==Example==
-{{{example|}}} }}
-{{#if: {{{examples|}}} |
-===Examples===
-{{{examples|}}} }}
-{{#if: {{{differences|}}} |
-===Version Changes===
-{{{changes|}}} }}
-<includeonly>[[Category:Macro Function]]</includeonly>
-<noinclude>
-==Template Usage==
-===Example===
 <pre>{{MacroFunction
-|name=NameOfMacro
+|name=exampleFunction
-|version=X.Y
+|proposed=true
+|deprecated=
+[[newFunction|newFunction()]]
+|trusted=true
+|version=1.3b50
+|compatibility=1.3b52
 |description=
-NameOfMacro is an example of a macro function.  It doesn't actually exist as a function in MapTool.
+This is an example function.  It doesn't actually exist as a function in MapTool.
+If you put a bulleted list here, don't end the description with the list.
+MediaWiki encloses this parameter inside a DIV block and it will put the close
+DIV tag inside the last LI.  For this reason, you may see description
+parameters whose values contain a bulleted list followed by a line
+that contains only, "&amp;nbsp;"
+{{__TOC__}}
 |usage=
 <source lang="mtmacro" line>
-[h: NameOfMacro()]
+exampleFunction(param1, param2)
 </source>
-|examples=
+|example=
 This example doesn't really do anything.
 <source lang="mtmacro" line>
-[h: NameOfMacro()]
+[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=
-In version X.N this function also didn't exist.
+* '''1.3b52''' - Added reverse parameter.
 }}</pre>
+=Source=
+</noinclude>{{#ifeq: {{{proposed|}}} | true | {{ProposedChange}} |}}{{#if: {{{deprecated|}}} | {{Deprecated|{{{deprecated}}} |}} |}}
+=={{{name}}}() Function==
+{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}} |}}
+{{#if: {{{version|}}} | <div class="template_version">• '''Introduced in version {{{version|}}}'''</div> |}}
+{{#if: {{{compatibility|}}} | <div class="template_compatibility">• '''Last checked for compatibility with version {{{compatibility|}}}'''</div> |}}<div class="template_description">{{{description|}}}</div>
+===Usage===
+{{{usage}}}
+{{#if: {{{example|}}} |
-===Example Using Subtemplates===
+===Example===
-<pre>{{MacroFunction
+<div class="template_example">{{{example|}}}</div> |}}
-|name=exampleFunction
+{{#if: {{{examples|}}} |
-|trusted=true
-|version=1.3b52
-|compatibility=1.3b52
-|description=This is the description of this exampleFunction. This is the description of this exampleFunction. This is the description of this exampleFunction.
-|usage=
+===Examples===
-{{FunctionUsage
+<div class="template_examples">{{{examples|}}}</div> |}}
-|name=Standard Usage
+{{#if: {{{also|}}} |
-|description=This is the description for the standard usage block. This is the description for the standard usage block. This is the description for the standard usage block.
+===See Also===
-|syntax=exampleFunction(param1, param2)
+<div class="template_also">{{{also|}}}</div> |}}
-}}
+{{#if: {{{changes|}}} |
+===Version Changes===
-|example=
+<div class="template_changes">
-{{FunctionExample
+{{{changes|}}}
-|name=Standard Example
+</div> |}}
-|description=This is the description for the standard example block. This is the description for the standard example block. This is the description for the standard example block.
+<includeonly>[[Category:Macro Function]]__NOEDITSECTION__</includeonly>
-|syntax=[h: exampleVariable = 10]
+<noinclude>[[Category:Templates]]</noinclude>
-[exampleFunction(exampleVariable, "string")]
-|return=s t r i n g
-}}
-|changes=This function is new!
-}}</pre>
-</noinclude>

Template:MacroFunction: Difference between revisions

Latest revision as of 07:52, 6 March 2019

Contents

Template Usage

Example

Source

{{{name}}}() Function

Usage

Navigation menu