Template:SpecialVariable: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(→‎{{{name}}} Special Variable: First substantive update for Special Variable template from Macro Function template)
Line 11: Line 11:
|deprecated=
|deprecated=
[[newFunction|newFunction()]]
[[newFunction|newFunction()]]
|macroequiv=
[[equivFunction|equivFunction()]]
|version=1.5.0
|version=1.5.0
|compatibility=1.9.0
|compatibility=1.9.0
Line 32: Line 30:
DA74EB9CAA9B47C9970FFC45DB259949
DA74EB9CAA9B47C9970FFC45DB259949
</source>
</source>
|macroequiv=
[[equivmacro|equivFunction()]]


|also=
|also=
Line 39: Line 40:
* '''1.5.5''' - Correctly trims output.
* '''1.5.5''' - Correctly trims output.
}}</pre>
}}</pre>
=Source=
=Source=
</noinclude>{{#ifeq: {{{proposed|}}} | true | {{ProposedChange}} |}}{{#if: {{{deprecated|}}} | {{Deprecated|{{{deprecated}}} |}} |}}
</noinclude>{{#ifeq: {{{proposed|}}} | true | {{ProposedChange}} |}}{{#if: {{{deprecated|}}} | {{Deprecated|{{{deprecated}}} |}} |}}

Revision as of 16:27, 18 June 2021

Template Usage

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

Refer to Help:Editing for more detailed documentation.

Example

{{SpecialVariable
|name=example.specialvar
|proposed=true
|deprecated=
[[newFunction|newFunction()]]
|version=1.5.0
|compatibility=1.9.0
|description=
Refers to some MapTool internal data for quick access in Macros. This example of course doesn't refer to any real special variable, but it will when you use this template! "&nbsp;"
{{__TOC__}}
|usage=
<source lang="mtmacro" line>
[r: example.specialvar]
</source>

|example=
This example doesn't really do anything.
<source lang="mtmacro" line>
[r: example.specialvar)]
</source>
Returns:
<source lang="mtmacro" line>
DA74EB9CAA9B47C9970FFC45DB259949
</source>

|macroequiv=
[[equivmacro|equivFunction()]]

|also=
[[linkToRelatedArticle|Display Name of Related Article]]

|changes=
* '''1.5.5''' - Correctly trims output.
}}

Source

{{{name}}} Special Variable

Usage

{{{usage}}}