User:Verisimilar/Sandbox
How To Use This Template
When creating a new page that displays information about a macro function, this template should be used for uniformity. What follows are instructions on how to use this template. You can enter template parameters in any order, but it is suggested that you use the same order as these instructions to assist other editors with easily finding sections that might need updating.
Begin
Required - Begin the template:
{{MacroFunction
Name
Required - Name the function:
|name=exampleFunction
Trusted
Optional - Indicate the function can only be used in a trusted macro:
|trusted=true
Version
Optional - Indicate the version of MapTool that this function was introduced:
|version=1.3b52
Compatibility
Optional - Indicate the most recent version of MapTool that the syntax on this page is compatible with:
|compatibility=1.3b52
Description
Multi-Line, Optional - Describe the function in a general way:
|description=This is the description of this exampleFunction.
Usage
Required - Declare the required syntax for use of the function.
|usage=
Usage Block
Repeatable, Optional - Uses a subtemplate for each usage block.
Block Begin
Required
{{FunctionUsage
Block Name
Optional - If you wish you provide a name for your usage block:
|name=Standard Use
Block Description
Multi-line, Optional - Describe your usage block:
|description=This is the description for the standard use usage block.
Block Syntax
Required - Provide the syntax for the function:
|syntax=exampleFunction(param1, param2)
Block End
Required
|syntax=exampleFunction(param1, param2)
Examples
Optional - Provide examples of different way to use the function. Removing the 's' from from 'examples' will cause the header to properly display a singular example.
|examples=
Example Block
Repeatable, Optional - Uses a subtemplate for each example block.
Block Begin
Required
{{FunctionExample
Block Name
Optional
|name=Standard Example
Block Description
Multi-line, Optional
|description=This is the description for the standard example.
Block Syntax
Multi-line, Required
|name=Standard Example
Block Return
|name=Standard Example
Block End
Example
sdfdsf
sdfsdf
sdfsdfs