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"

From Roll20 Wiki

Jump to: navigation, search
(Created page with "{{#ifeq: {{{optional|false}}} | true | <nowiki>[</nowiki> | <}}''{{{name}}}''{{#ifeq: {{{optional|false}}} | true | <nowiki>]</nowiki> | >}}")
 
m
 
(3 intermediate revisions by one user not shown)
Line 1: Line 1:
{{#ifeq: {{{optional|false}}} | true | <nowiki>[</nowiki> | &lt;}}''{{{name}}}''{{#ifeq: {{{optional|false}}} | true | <nowiki>]</nowiki> | &gt;}}
+
<includeonly>{{#ifeq: {{{optional|false}}} | true | <nowiki>[</nowiki> | &lt;}}<em>{{{name}}}</em>{{#ifeq: {{{optional|false}}} | true | <nowiki>]</nowiki> | &gt;}}</includeonly><noinclude>{{documentation}}</noinclude>

Latest revision as of 23:06, 30 December 2014

[view] [edit] [history] [purge] Documentation icon Template documentation

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]