Template:SpecialVariable: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (→‎Source: Slightly alter no-include pattern for clean template page view.)
(→‎Template Usage: Update example.)
Line 9: Line 9:
|name=example.specialvar
|name=example.specialvar
|proposed=true
|proposed=true
|deprecated=
|deprecated=[[newFunction|newFunction()]]
[[newFunction|newFunction()]]
|version=1.5.0
|version=1.5.0
|compatibility=1.9.0
|compatibility=1.9.0
|description=
|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! " "
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__}}
{{__TOC__}}
|usage=
|usage=

Revision as of 17:55, 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! " "
{{__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

Edit this section to view template source.