Difference between revisions of "Template:API parameter/doc"
From Roll20 Wiki
m |
m |
||
| 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}} | ||
| − | |} | + | |}<includeonly>[[Category:API Templates]]</includeonly> |
Latest revision as of 22:44, 14 January 2015
 |
This is a documentation subpage for API parameter. It contains usage information, categories and other content that is not part of the original template page. |
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] |
