Difference between revisions of "Template:API parameter"
From Roll20 Wiki
(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> | <}} | + | <includeonly>{{#ifeq: {{{optional|false}}} | true | <nowiki>[</nowiki> | <}}<em>{{{name}}}</em>{{#ifeq: {{{optional|false}}} | true | <nowiki>]</nowiki> | >}}</includeonly><noinclude>{{documentation}}</noinclude> |
Latest revision as of 23:06, 30 December 2014
Template documentationDisplays 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] |
| The above documentation is transcluded from Template:API parameter/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |
