Template:Get: Difference between revisions

Browse history interactively

[unchecked revision]

← Older edit Newer edit →

Content deleted Content added

VisualWikitext

Inline

Revision as of 01:06, 31 March 2020

{{{1}}}

Need an Example

Usage

Only Specify the Command:

{{Get|Command show}}

Command show

 
cli> volume show
 #  |                  id                  |         name         |  type   |       wwn       |   size    | protecti~
----+--------------------------------------+----------------------+---------+-----------------+-----------+-----------
  1 | 0008c12f-d24a-4117-bab9-2b7927e43b19 | Karin-Vol-Test4      | Primary | naa.68ccf09800~ | 42949672~ |
  2 | 05706c29-9743-4773-9a9d-320205f950a8 | Linux-Lab-VM-1-Vol-0 | Primary | naa.68ccf09800~ | 10737418~ |
  3 | 081946cf-86bb-4b40-baa1-15411288f325 | Linux-Lab-VM-3-005   | Primary | naa.68ccf09800~ | 10737418~ |
  4 | 0c0a4a8d-8c17-4c5c-b103-ce8062fe58ef | Karin-Vol-Test2      | Primary | naa.68ccf09800~ | 16106127~ |
  5 | 142b7bee-cc3e-4bc8-a58b-20582809bfa3 | Linux-Lab-VM-1-Vol-~ | Primary | naa.68ccf09800~ | 11059540~ |
  6 | 247187ee-55cb-4c73-ae5b-0c13fa734790 | Linux-Lab-VM-4-002   | Primary | naa.68ccf09800~ | 16106127~ |
  7 | 2ab636d6-3b43-43eb-a803-9f7551d9f5a2 | Karin-Vol-Test3      | Primary | naa.68ccf09800~ | 32212254~ |
  8 | 2d2ae6f3-5a94-4dca-9f68-62f54b0ff8ba | gslab3t1-vol5        | Primary | naa.68ccf09800~ | 26843545~ |
  9 | 3e3e0ed9-192e-4f1e-bcb4-5600842fc88d | Linux-Lab-VM-3-004   | Primary | naa.68ccf09800~ | 10737418~ |
 10 | 40187368-1bef-4925-9e46-a7019d24e7ee | Lab VMs              | Primary | naa.68ccf09800~ | 10844792~ |
 11 | 4126b8b7-fca8-46dd-8200-65389873304d | gslab3t1-vol3        | Primary | naa.68ccf09800~ | 26843545~ |
cli>

Provide a different example :

{{Get|Command show|example=
<pre>
cli> dns show
 #  |  id  |  addresses
----+------+-------------
  1 | DNS1 | 10.24.27.42
    |      | 10.24.27.41
</pre>}}

Command show

cli> dns show
 #  |  id  |  addresses
----+------+-------------
  1 | DNS1 | 10.24.27.42
    |      | 10.24.27.41
cli>

Provide a different example, this time using syntaxhighlight and recoloring:

{{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>}}

Command show

cli> dns show
 #  |  id  |  addresses
----+------+-------------
  1 | DNS1 | 10.24.27.42
    |      | 10.24.27.41
cli>

Specify alternative section of page to pull example from:

{{Get|Command show|section=hosts}}

Command show

 
cli> host show
 #  |                  id                  |      name      | description | os_type | host_group.name
----+--------------------------------------+----------------+-------------+---------+-----------------
  1 | 021f9529-171b-4adb-8a49-58cfa07ef4c4 | Linux-Lab-VM-3 |             | Linux   |
  2 | 30553818-2ac7-47ca-b52c-9e8d21012c36 | ESX2-Test      |             | ESXi    | EST-Test
  3 | 684006b2-08ac-472d-9a6b-cc9bd36dc9ab | Linux-Lab-VM-2 |             | Linux   |
  4 | 6ccec73e-d2af-4fcf-bd13-b92d1802b43a | ESX1-Test      |             | ESXi    | EST-Test
  5 | a4098f08-4b29-49cc-94a1-722922bf0d17 | Linux-Lab-VM-4 |             | Linux   |
  6 | ce7d89e5-fafe-410c-b257-afa5c42982b4 | ESX3-Test      |             | ESXi    | EST-Test
  7 | ddb081ea-bd85-48b7-bb4d-f0bfb2970b74 | Linux-Lab-VM-1 |             | Linux   |
cli>

Note:

If you omit the section =YourSectionName, by default the section called example will be used

Show alternative Text:

{{Get|command show|volume show|color=blue-white}}

volume show

 
cli> volume show
 #  |                  id                  |         name         |  type   |       wwn       |   size    | protecti~
----+--------------------------------------+----------------------+---------+-----------------+-----------+-----------
  1 | 0008c12f-d24a-4117-bab9-2b7927e43b19 | Karin-Vol-Test4      | Primary | naa.68ccf09800~ | 42949672~ |
  2 | 05706c29-9743-4773-9a9d-320205f950a8 | Linux-Lab-VM-1-Vol-0 | Primary | naa.68ccf09800~ | 10737418~ |
  3 | 081946cf-86bb-4b40-baa1-15411288f325 | Linux-Lab-VM-3-005   | Primary | naa.68ccf09800~ | 10737418~ |
  4 | 0c0a4a8d-8c17-4c5c-b103-ce8062fe58ef | Karin-Vol-Test2      | Primary | naa.68ccf09800~ | 16106127~ |
  5 | 142b7bee-cc3e-4bc8-a58b-20582809bfa3 | Linux-Lab-VM-1-Vol-~ | Primary | naa.68ccf09800~ | 11059540~ |
  6 | 247187ee-55cb-4c73-ae5b-0c13fa734790 | Linux-Lab-VM-4-002   | Primary | naa.68ccf09800~ | 16106127~ |
  7 | 2ab636d6-3b43-43eb-a803-9f7551d9f5a2 | Karin-Vol-Test3      | Primary | naa.68ccf09800~ | 32212254~ |
  8 | 2d2ae6f3-5a94-4dca-9f68-62f54b0ff8ba | gslab3t1-vol5        | Primary | naa.68ccf09800~ | 26843545~ |
  9 | 3e3e0ed9-192e-4f1e-bcb4-5600842fc88d | Linux-Lab-VM-3-004   | Primary | naa.68ccf09800~ | 10737418~ |
 10 | 40187368-1bef-4925-9e46-a7019d24e7ee | Lab VMs              | Primary | naa.68ccf09800~ | 10844792~ |
 11 | 4126b8b7-fca8-46dd-8200-65389873304d | gslab3t1-vol3        | Primary | naa.68ccf09800~ | 26843545~ |
cli>

Show alternative Text and specify code example, no need to use "example=" if the example is the 3rd paramater:
{{Get\|command show\|volume show\|<pre>sample code</pre>\|section=YourSectionName}}
volume show sample code

Display several commands without additional line breaks:

{{Get|command show|command one|<pre>command one sample code</pre>|inline=1}}

{{Get|command show|command one|<pre>command two sample code</pre>|inline=1}}

{{Get|command show|command one|<pre>command three sample code</pre>|inline=1}}

command one

command one sample code

command two

command two sample code

command three

command three sample code

Change color and display open:

{{Get|Command show|open=1|color=basic}}

Command show

 
cli> volume show
 #  |                  id                  |         name         |  type   |       wwn       |   size    | protecti~
----+--------------------------------------+----------------------+---------+-----------------+-----------+-----------
  1 | 0008c12f-d24a-4117-bab9-2b7927e43b19 | Karin-Vol-Test4      | Primary | naa.68ccf09800~ | 42949672~ |
  2 | 05706c29-9743-4773-9a9d-320205f950a8 | Linux-Lab-VM-1-Vol-0 | Primary | naa.68ccf09800~ | 10737418~ |
  3 | 081946cf-86bb-4b40-baa1-15411288f325 | Linux-Lab-VM-3-005   | Primary | naa.68ccf09800~ | 10737418~ |
  4 | 0c0a4a8d-8c17-4c5c-b103-ce8062fe58ef | Karin-Vol-Test2      | Primary | naa.68ccf09800~ | 16106127~ |
  5 | 142b7bee-cc3e-4bc8-a58b-20582809bfa3 | Linux-Lab-VM-1-Vol-~ | Primary | naa.68ccf09800~ | 11059540~ |
  6 | 247187ee-55cb-4c73-ae5b-0c13fa734790 | Linux-Lab-VM-4-002   | Primary | naa.68ccf09800~ | 16106127~ |
  7 | 2ab636d6-3b43-43eb-a803-9f7551d9f5a2 | Karin-Vol-Test3      | Primary | naa.68ccf09800~ | 32212254~ |
  8 | 2d2ae6f3-5a94-4dca-9f68-62f54b0ff8ba | gslab3t1-vol5        | Primary | naa.68ccf09800~ | 26843545~ |
  9 | 3e3e0ed9-192e-4f1e-bcb4-5600842fc88d | Linux-Lab-VM-3-004   | Primary | naa.68ccf09800~ | 10737418~ |
 10 | 40187368-1bef-4925-9e46-a7019d24e7ee | Lab VMs              | Primary | naa.68ccf09800~ | 10844792~ |
 11 | 4126b8b7-fca8-46dd-8200-65389873304d | gslab3t1-vol3        | Primary | naa.68ccf09800~ | 26843545~ |
cli>

Show a Command with a collapsed div containing an example

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Command Name	`1`	Command Name, will like match page name describing this command Example volume show	String	required
Alternative Command Description	`2`	Either Alternate Description of Command or an Example Example volume show where status = offline	String	optional
Sample output	`3`	An example output of runing this command Example <pre>volume show where status = offline</pre>	String	optional
Pre Color	`color`	Color of Pre-formatted Example Example black-green, blue-white, black-white, net, esx	String	optional
Name of page section	`Section`	Name of page section where pre-formatted example is found Example example, example2	String	optional
Open	`open`	Shows pre-formatted example as open by default Example 1	Boolean	optional
Inline	`inline`	Removes all new lines / carraige returns Example 1	Boolean	optional
Sample output	`example`	An example output of runing this command Example <pre>volume show where status = offline</pre>	String	optional
Alternative Command Description	`alt-text`	Either Alternate Description of Command or an Example Example volume show where status = offline	String	optional

@@ Line 21: / Line 21: @@
 |-
 |<pre>{{Get|Command show|example=
-&lt;pre&gt;cli> dns show
+&lt;pre&gt;
+cli> dns show
  #  |  id  |  addresses
 ----+------+-------------
@@ Line 43: / Line 44: @@
 |Provide a different example, this time using syntaxhighlight and recoloring:
 |-
-|<pre>{{Get|Command show|color=black-white|example=&lt;syntaxhighlight lang="text" highlight="4"&gt;cli> dns show
+|<pre>{{Get|Command show|color=black-white|example=
+&lt;syntaxhighlight lang="text" highlight="4"&gt;
+cli> dns show
  #  |  id  |  addresses
 ----+------+-------------
 | DNS1 | 10.24.27.42
-    |      | 10.24.27.41&lt;/syntaxhighlight&gt;}}</pre>
+    |      | 10.24.27.41
+&lt;/syntaxhighlight&gt;}}</pre>
 |-
 |{{Get|Command show|color=black-white|example=