Jump to content

Template:Get2: Difference between revisions

From pool
Browse history interactively
[unchecked revision][unchecked revision]
← Older edit
Content deleted Content added
VisualWikitext
No edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 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}} )}}|}}">'''{{#if:{{{2|}}}|{{#ifeq:{{#len:{{{2}}}}}|0|{{{1}}}|{{{alt-text|{{{2|{{{1}}}}}}}}}}}|{{{alt-text|{{{2|{{{1}}}}}}}}}}}'''</span>]]<div class="mw-collapsible-content {{#if:{{{color|}}}|{{#ifeq:{{{color}}}|default||{{{color}}}}}|shell}}" style="align: left;">{{#if:{{{2|}}}|{{#ifeq:{{#len:{{{2}}}}}|0|{{{2}}}|{{{example|{{{3|{{#lst:Cli:{{{1}}}|{{{section|example}}}}}}}}}}}}}|{{{example|{{{3|{{#lst:Cli:{{{1}}}|{{{section|example}}}}}}}}}}}}}</div></div>{{#if:{{{inline|}}}||<br><br style="clear:both;">}}<noinclude>
<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|shell}}}" style="align: left;">{{{example|{{{3|{{#lst:Cli:{{{1}}}|{{{section|example}}}}}}}}}}}</div></div>{{#if:{{{inline|}}}||<br><br style="clear:both;">}}<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}}


{{Warning|The Get2 template does not check if the page exists where it is pulling the description, version and example from, this is because the ifexists parser function is computationally expensive and so Get2 is better suited for long pages where the template is reused many times}}


{| class="wikitable"
|Only Specify the Command:
|-
|<pre>{{Get|Command show}}</pre>
|-
|{{Get|Command show}}
|}


{| class="wikitable"
|Provide a different example :
|-
|<pre>{{Get|Command show|example=
&lt;pre&gt;
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
&lt;/pre&gt;}}</pre>
|-
|{{Get|Command show|example=
<pre>
cli> dns show
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
cli>
</pre>}}
|}


{| class="wikitable"
|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
# | id | addresses
----+------+-------------
1 | DNS1 | 10.24.27.42
| | 10.24.27.41
&lt;/syntaxhighlight&gt;}}</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
cli>
</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>}}


{| class="wikitable"
|Specify alternative section of page to pull example from:
|-
|<pre>{{Get|Command show|section=hosts}}</pre>
|-
|{{Get|Command show|section=hosts}}
|}


{{Note|If you omit the section &#61;YourSectionName, by default the section called example will be used}}


{| class="wikitable"
|Show alternative Text:
|-
|<pre>{{Get|command show|volume show|color=blue-white}}</pre>
|-
|{{Get|command show|volume show|color=blue-white}}
|}


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


{| class="wikitable"
|Display several commands without additional line breaks:
|-
|
<pre>{{Get|command show|command one|&lt;pre&gt;command one sample code&lt;/pre&gt;|inline=1}}</pre><br>
<pre>{{Get|command show|command one|&lt;pre&gt;command two sample code&lt;/pre&gt;|inline=1}}</pre><br>
<pre>{{Get|command show|command one|&lt;pre&gt;command three sample code&lt;/pre&gt;|inline=1}}</pre><br>
|-
|
{{Get|command show|command one|<pre>command one sample code</pre>|inline=1}}<br>
{{Get|command show|command two|<pre>command two sample code</pre>|inline=1}}<br>
{{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}}


{| class="wikitable"
|Change color and display open:
|-
|<pre>{{Get|Command show|open=1|color=basic}}</pre>
|-
|{{Get|Command show|open=1|color=basic}}
|}


<templatedata>
<templatedata>
{
{
Line 10: Line 137:
"required": true
"required": true
},
},
"2": {
"alt-text": {
"label": "Alternative Command Description",
"label": "Alternative Command Description",
"description": "Either Alternate Description of Command or an Example",
"description": "Either Alternate Description of Command or an Example",
Line 16: Line 143:
"type": "string"
"type": "string"
},
},
"3": {
"example": {
"label": "Sample output",
"label": "Sample output",
"description": "An example output of runing this command",
"description": "An example output of runing this command",
"example": "&lt;pre&gt;volume show where status = offline&lt;/pre&gt;",
"example": "<pre>volume show where status = offline</pre>",
"type": "string"
"type": "string"
},
},
Line 25: Line 152:
"label": "Pre Color",
"label": "Pre Color",
"description": "Color of Pre-formatted Example",
"description": "Color of Pre-formatted Example",
"example": "black-green, blue-white, black-white, net, esx",
"example": "basic, black-green, blue-white, black-white, net, esx",
"type": "string"
"type": "string"
},
},
Line 45: Line 172:
"example": "1",
"example": "1",
"type": "boolean"
"type": "boolean"
},
"example": {
"label": "Sample output",
"description": "An example output of runing this command",
"example": "<pre>volume show where status = offline</pre>",
"type": "string"
},
"alt-text": {
"label": "Alternative Command Description",
"description": "Either Alternate Description of Command or an Example",
"example": "volume show where status = offline",
"type": "string"
}
}
},
},

Latest revision as of 01:36, 31 March 2020

[[Cli:{{{1}}}|{{{1}}}]]



Usage

 
  
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


 
Warning:  
The Get2 template does not check if the page exists where it is pulling the description, version and example from, this is because the ifexists parser function is computationally expensive and so Get2 is better suited for long pages where the template is reused many times


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>



 
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:

<section begin=version />1.0.0.179<section end=version /> and this:

<section begin=description />Description Goes Here!<section end=description />


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


 
  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


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.

ParameterDescriptionTypeStatus
Command Name1

Command Name, will like match page name describing this command

Example
volume show
Stringrequired
Alternative Command Descriptionalt-text

Either Alternate Description of Command or an Example

Example
volume show where status = offline
Stringoptional
Sample outputexample

An example output of runing this command

Example
<pre>volume show where status = offline</pre>
Stringoptional
Pre Colorcolor

Color of Pre-formatted Example

Example
basic, black-green, blue-white, black-white, net, esx
Stringoptional
Name of page sectionSection

Name of page section where pre-formatted example is found

Example
example, example2
Stringoptional
Openopen

Shows pre-formatted example as open by default

Example
1
Booleanoptional
Inlineinline

Removes all new lines / carraige returns

Example
1
Booleanoptional
Retrieved from "https://pool.calebcooper.ie/index.php?title=Template:Get2&oldid=10761"