Template:MacroFunction: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
==Function {{{name}}}==
=={{{name}}}() Function==
{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}}<br>| }}{{#if: {{{version|}}} | * '''Introduced in version {{{version|}}}.''' <br>}}{{#if: {{{compatibility|}}} | * '''Last checked for compatibility with version {{{compatibility|}}}.''' <br>}}{{{description|}}}
{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}} |}}
{{#if: {{{version|}}} | * '''Introduced in version {{{version|}}}.''' |}}
{{#if: {{{compatibility|}}} | * '''Last checked for compatibility with version {{{compatibility|}}}.''' |}}
{{{description|}}}
===Usage===
===Usage===
{{{usage}}}{{#if: {{{example|}}} |
{{{usage}}}
 
{{#if: {{{example|}}} |
===Example===
===Example===
{{{example|}}} }}{{#if: {{{examples|}}} |
{{{example|}}} |}}
 
{{#if: {{{examples|}}} |
===Examples===
===Examples===
{{{examples|}}} }}{{#if: {{{changes|}}} |
{{{examples|}}} |}}
 
{{#if: {{{changes|}}} |
===Version Changes===
===Version Changes===
{{{changes|}}} }}
{{{changes|}}} |}}
<includeonly>[[Category:Macro Function]]</includeonly>
<includeonly>[[Category:Macro Function]]</includeonly>
<noinclude>
<noinclude>

Revision as of 04:48, 7 March 2009

{{{name}}}() Function

Usage

{{{usage}}}



Template Usage

Example

All parameters are optional, except |name= and |usage=. You can use |example= or |examples= depending on the number of examples you intend to supply.

{{MacroFunction
|name=NameOfMacro
|trusted=true
|version=X.Y
|compatibility=X.Y
|description=
NameOfMacro is an example of a macro function.  It doesn't actually exist as a function in MapTool.

|usage=
<source lang="mtmacro" line>
[h: NameOfMacro()]
</source>

|example=
This example doesn't really do anything.
<source lang="mtmacro" line>
[h: NameOfMacro()]
</source>

|changes=
In version X.N this function also didn't exist.
}}