Template:Get: Difference between revisions
| [unchecked revision] | [unchecked revision] |
Content deleted Content added
Caleb Cooper (talk | contribs) No edit summary |
Caleb Cooper (talk | contribs) No edit summary |
||
| (21 intermediate revisions by the same user not shown) | |||
Line 1:
{{#ifexist:Cli:{{{1}}}|
<div class="mw-collapsible {{#if:{{{open|}}}||mw-collapsed}} force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="overflow:hidden; display: inline;">[[Cli:{{{1}}}|<span style="color: blue; display: inline;" title="{{#lst:Cli:{{{1}}}|description}} {{#if:{{#lst:Cli:{{{1}}}|version}}|{{#ifeq:{{#lst:Cli:{{{1}}}|version}}|07.0x.0y||(ver. {{#lst:Cli:{{{1}}}|version}} )}}|}}">'''{{{alt-text|{{{2|{{{1}}}}}}}}}'''</span>]]<div class="mw-collapsible-content {{{color|
|
<div class="mw-collapsible {{#if:{{{open|}}}||mw-collapsed}} {{#if:{{{color|}}}|{{{color}}}}} force-toggle-float-left" data-collapsetext="-" data-expandtext="+" style="overflow:hidden; display: inline;"><span style="color: blue; display: inline;">'''{{{alt-text|{{{2|{{{1}}}}}}}}}'''</span><div class="mw-collapsible-content {{{color|
}}<noinclude>
== Usage ==
{{Note|It is not necessary (but expected) when using this template that a page exists detailing the commands usage, it is from this page that the example and tool tip is taken, for the purpose of the examples below a test page has been created: [[Cli:Command show]]|info}}
{| class="wikitable"
Line 21 ⟶ 23:
|-
|<pre>{{Get|Command show|example=
<pre>
cli> dns show
# | id | addresses
----+------+-------------
Line 43 ⟶ 46:
|Provide a different example, this time using syntaxhighlight and recoloring:
|-
|<pre>{{Get|Command show|color=black-white|example=
<syntaxhighlight lang="text" highlight="4">
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
</syntaxhighlight>}}</pre>
|-
|{{Get|Command show|color=black-white|example=
Line 59 ⟶ 65:
</syntaxhighlight>}}
|}
{{Tip|The tool tips for version and description are take from the page in the Cli namespace having the same name as the command, you can spot them between tags like this:<br>
<code><nowiki><section begin=version />1.0.0.179<section end=version /></nowiki></code> and this:<br>
<code><nowiki><section begin=description />Description Goes Here!<section end=description /></nowiki></code>}}
Line 85 ⟶ 96:
|Show alternative Text and specify code example, no need to use "example=" if the example is the 3rd paramater:
|-
|<pre>{{Get|command show|
<pre>
cli> appliance show
# | id | name | service_tag | model | software_installed.release_version
----+----+-----------------------+-------------+------------------+------------------------------------
1 | A1 | PowerThor-appliance-1 | 59P42W2 | PowerStore 3000X | 1.0.0.1.3.720
cli> cluster show
# | name | management_address | storage_discovery_address | master_appliance_id | appliance_count | state
----+-----------+--------------------+---------------------------+---------------------+-----------------+------------
1 | PowerThor | 10.24.31.10 | 172.28.45.17 | A1 | 1 | Configured
cli>
</pre>}}</pre>
|-
|{{Get|command show|
<pre>
cli> appliance show
# | id | name | service_tag | model | software_installed.release_version
----+----+-----------------------+-------------+------------------+------------------------------------
1 | A1 | PowerThor-appliance-1 | 59P42W2 | PowerStore 3000X | 1.0.0.1.3.720
cli> cluster show
# | name | management_address | storage_discovery_address | master_appliance_id | appliance_count | state
----+-----------+--------------------+---------------------------+---------------------+-----------------+------------
1 | PowerThor | 10.24.31.10 | 172.28.45.17 | A1 | 1 | Configured
cli>
</pre>}}
|}
{{Caution|In order to format commands like the example below, with no additional line breaks, it is necessary to enclose the commands in a table or div, this page is a good example [[compiki:common commands]]}}
Line 95 ⟶ 132:
|-
|
<pre>{{Get|command show|command one|<pre>command one sample code</pre>|inline=1}}<br></pre><br>
<pre>{{Get|command show|command one|<pre>command two sample code</pre>|inline=1}}<br></pre><br>
<pre>{{Get|command show|command one|<pre>command three sample code</pre>|inline=1}}<br></pre><br>
|-
|
Line 104 ⟶ 141:
{{Get|command show|command three|<pre>command three sample code</pre>|inline=1}}<br>
|}
{{Note|The boilerplate page for documenting commands uses black and green coloring for the pre-formatted text, this can be set back to defaults by setting the color to basic like below|info-blue}}
Line 112 ⟶ 152:
|-
|{{Get|Command show|open=1|color=basic}}
|}
{| class="wikitable"
|Open=1 using syntaxhighlight and recoloring:
|-
|<pre>{{Get|Command show|open=1|color=blue-white|example=
<syntaxhighlight lang="text" highlight="4">
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
</syntaxhighlight>}}</pre>
|-
|{{Get|Command show|color=blue-white|open=1|example=
<syntaxhighlight lang="text" highlight="4">
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
cli>
</syntaxhighlight>}}
|}
Line 125 ⟶ 189:
"required": true
},
"
"label": "Alternative Command Description",
"description": "Either Alternate Description of Command or an Example",
Line 131 ⟶ 195:
"type": "string"
},
"
"label": "Sample output",
"description": "An example output of runing this command",
Line 140 ⟶ 204:
"label": "Pre Color",
"description": "Color of Pre-formatted Example",
"example": "basic, black-green, blue-white, black-white, net, esx",
"type": "string"
},
Line 160 ⟶ 224:
"example": "1",
"type": "boolean"
}
},
| |||