Difference between revisions of "Template:Formal API command/doc"
From Roll20 Wiki
m |
m |
||
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{documentation subpage|override=formal api command/doc|Formal API command}} | ||
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. | 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. | ||
| Line 12: | Line 13: | ||
| <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}} | ||
| − | |} | + | |}<includeonly>[[Category:API Templates]][[Category:Regular Grammar Templates]]</includeonly> |
Latest revision as of 16:10, 16 January 2015
 |
This is a documentation subpage for Formal API command. It contains usage information, categories and other content that is not part of the original template page. |
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.
[edit] Usage
| Wikitext | Output |
|---|---|
{{formal API command|Command description here}}
|
Formally:
Command description here
|
