Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "Template:API parameter/doc"

From Roll20 Wiki

Jump to: navigation, search
m
m
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
 +
{{documentation subpage|override=api parameter/doc|API parameter}}
 
Displays a parameter to an API command for use with API script syntax descriptions.
 
Displays a parameter to an API command for use with API script syntax descriptions.
  
Line 15: Line 16:
 
| <code><nowiki>{{API parameter|name=my-optional-parameter|optional=true}}</nowiki></code>
 
| <code><nowiki>{{API parameter|name=my-optional-parameter|optional=true}}</nowiki></code>
 
| {{API parameter|name=my-optional-parameter|optional=true}}
 
| {{API parameter|name=my-optional-parameter|optional=true}}
|}<noinclude>[[Category:Template Documentation]]</noinclude>
+
|}<includeonly>[[Category:API Templates]]</includeonly>

Latest revision as of 22:44, 14 January 2015

Displays a parameter to an API command for use with API script syntax descriptions.

[edit] Usage

Parameters can be optional or required. Indicate that the parameter is optional with the optional parameter to this template.

Wikitext Output
{{API parameter|name=my-parameter}} <my-parameter>
{{API parameter|name=my-optional-parameter|optional=true}} [my-optional-parameter]