Template:Get: Difference between revisions
| [unchecked revision] | [unchecked revision] |
Caleb Cooper (talk | contribs) No edit summary |
Caleb Cooper (talk | contribs) No edit summary |
||
| Line 43: | Line 43: | ||
"label": "Sample output", |
"label": "Sample output", |
||
"description": "An example output of runing this command", |
"description": "An example output of runing this command", |
||
"example": " |
"example": "<pre>volume show where status = offline</pre>", |
||
"type": "string" |
"type": "string" |
||
}, |
}, |
||
Revision as of 23:45, 30 March 2020
Syntax Examples -
Only Specify the Command:
{{Get|command|section=YourSectionName}}
Show alternative Text:
{{Get|command|alt text|section=YourSectionName}}
Show alternative Text and specify code sample:
{{Get|command|alt text|<pre>sample code</pre>|section=YourSectionName}}
By setting the boolean "open" the code sample is shown by default:
{{Get|command|alt text|<pre>sample code</pre>|open=1|section=YourSectionName}}
With the Word "open" the code sample is shown by default:
{{Get|command|alt text|<pre>sample code</pre>|open=1|color=blue-white|section=YourSectionName}}
Show a Command with a collapsed div containing an example
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Command Name | 1 | Command Name, will like match page name describing this command
| String | required |
| Alternative Command Description | 2 | Either Alternate Description of Command or an Example
| String | optional |
| Sample output | 3 | An example output of runing this command
| String | optional |
| Pre Color | color | Color of Pre-formatted Example
| String | optional |
| Name of page section | Section | Name of page section where pre-formatted example is found
| String | optional |
| Open | open | Shows pre-formatted example as open by default
| Boolean | optional |
| Inline | inline | Removes all new lines / carraige returns
| Boolean | optional |
| Sample output | example | An example output of runing this command
| String | optional |
| Alternative Command Description | alt-text | Either Alternate Description of Command or an Example
| String | optional |