Template:SpecialVariable

From RPTools Wiki
Revision as of 03:18, 21 June 2021 by Melek (talk | contribs)
Jump to navigation Jump to search

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! " "
{{__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=
[[equivFunction|equivFunction()]]

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

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

Source

Edit this section to view template source.