Difference between revisions of "Template:Formal API command/doc"
From Roll20 Wiki
(Created page with "Creates a region for documenting API commands using formal constructs such as regular grammar. Because the formal definitions are not widely understood, they can be hidden by ...") |
m |
||
| Line 12: | Line 12: | ||
| <code><nowiki>{{formal API command|Command description here}}</nowiki></code> | | <code><nowiki>{{formal API command|Command description here}}</nowiki></code> | ||
| {{formal API command|Command description here}} | | {{formal API command|Command description here}} | ||
| − | |}<noinclude>[[Category:Template Documentation]]</noinclude> | + | |}<noinclude>[[Category:Template Documentation]]</noinclude><includeonly>[[Category:API Templates]][[Category:Regular Grammar Templates]]</includeonly> |
Revision as of 23:05, 30 December 2014
Creates a region for documenting API commands using formal constructs such as regular grammar. Because the formal definitions are not widely understood, they can be hidden by default.
This template should be used after {{syntaxbox top}} and before {{syntaxbox bottom}}. Ideally, it should be used after the {{API command}} that it describes. In order to make the formal command description hidden by default, you must specify as much when you use the Syntaxbox top template.
Usage
| Wikitext | Output |
|---|---|
{{formal API command|Command description here}}
|
Formally:
Command description here
|
