Template:MacroFunction: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Moved note about optional parameters out of the "Example" section.)
(Added related parameter and moved the usage notes to the top.)
Line 1: Line 1:
=={{{name}}}() Function==
{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}} |}}
{{#if: {{{version|}}} | <div>* '''Introduced in version {{{version|}}}.'''</div> |}}
{{#if: {{{compatibility|}}} | <div>* '''Last checked for compatibility with version {{{compatibility|}}}.'''</div> |}}{{{description|}}}
===Usage===
{{{usage}}}
{{#if: {{{example|}}} |
===Example===
{{{example|}}} |}}
{{#if: {{{examples|}}} |
===Examples===
{{{examples|}}} |}}
{{#if: {{{changes|}}} |
===Version Changes===
{{{changes|}}} |}}
<includeonly>[[Category:Macro Function]]</includeonly>
<noinclude>
<noinclude>
==Template Usage==
==Template Usage==
Line 43: Line 24:
|changes=
|changes=
In version X.N this function also didn't exist.
In version X.N this function also didn't exist.
|related=
These are links to other articles that are related to this one.
}}</pre>
}}</pre>
</noinclude>
</noinclude>
=={{{name}}}() Function==
{{#ifeq: {{{trusted|}}} | true | {{TrustedFunction}} |}}
{{#if: {{{version|}}} | <div>* '''Introduced in version {{{version|}}}.'''</div> |}}
{{#if: {{{compatibility|}}} | <div>* '''Last checked for compatibility with version {{{compatibility|}}}.'''</div> |}}{{{description|}}}
===Usage===
{{{usage}}}
{{#if: {{{example|}}} |
===Example===
{{{example|}}} |}}
{{#if: {{{examples|}}} |
===Examples===
{{{examples|}}} |}}
{{#if: {{{changes|}}} |
===Version Changes===
{{{changes|}}} |}}
{{#if: {{{related|}}} |
===Related Articles===
{{{related|}}} |}}
<includeonly>[[Category:Macro Function]]</includeonly>

Revision as of 20:24, 7 March 2009

Template Usage

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

Example

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

|related=
These are links to other articles that are related to this one.
}}

{{{name}}}() Function

Usage

{{{usage}}}