Jump to content

Template:Set2: Difference between revisions

From pool
[unchecked revision][unchecked revision]
Content deleted Content added
No edit summary
No edit summary
 
(4 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;"><span style="color: red; display: inline;">'''{{#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|<pre>Need an Example</pre>}}}}}}}}}}</div></div>{{#if:{{{inline|}}}||<br><br style="clear:both;">}}<noinclude>
{{#switch: {{{warning|{{#lst:Cli:{{{1}}}|warning}}}}}| VeryDangerous = <div style="float:left" title="IMPORTANT:This set command can cause Data Unavailable or Data Loss if used incorrectly, CSE only!">[[File:Skull_sm_40.png]]</div>| NotDangerous = <div style="float:left" title="Careful Now!">[[File:One_Pixel.png]]</div>| #default = <div style="float:left" title="IMPORTANT:No set command should ever be run without Senior Engineer verification!">[[File:Warn_sm_20.png]]</div>}}<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: red; 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>


{{Warning|The Set2 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 Set2 is better suited for long pages where the template is reused many times}}



<templatedata>
<templatedata>
Line 11: Line 15:
"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 17: Line 21:
"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 26: Line 30:
"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 46: Line 50:
"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:38, 31 March 2020

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




 
Warning:  
The Set2 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 Set2 is better suited for long pages where the template is reused many times


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