Template:MacroFunction: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Undo revision 1134 by Verisimilar (Talk))
m (Fixed linebreaks in template code.)
Line 1: Line 1:
==Function {{{name}}}==
==Function {{{name}}}==
{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}} | }}
{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}}  
{{#if: {{{version|}}} | * '''Introduced in version {{{version|}}}.''' }}
| }}{{#if: {{{version|}}} | * '''Introduced in version {{{version|}}}.'''  
{{#if: {{{compatibility|}}} | * '''Last checked for compatibility with version {{{compatibility|}}}.''' }}
}}{{#if: {{{compatibility|}}} | * '''Last checked for compatibility with version {{{compatibility|}}}.'''  
 
}}{{{description|}}}
{{{description|}}}
 
===Usage===
===Usage===
{{{usage}}}
{{{usage}}}{{#if: {{{example|}}} |
 
{{#if: {{{example|}}} |
===Example===
===Example===
{{{example|}}} }}
{{{example|}}} }}{{#if: {{{examples|}}} |
{{#if: {{{examples|}}} |
===Examples===
===Examples===
{{{examples|}}} }}
{{{examples|}}} }}{{#if: {{{changes|}}} |
 
{{#if: {{{changes|}}} |
===Version Changes===
===Version Changes===
{{{changes|}}} }}
{{{changes|}}} }}

Revision as of 04:41, 7 March 2009

Function {{{name}}}

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