Jump to content

Template:Get

From pool
Revision as of 18:35, 30 March 2020 by Caleb Cooper (talk | contribs)
This content is in the Template Namespace. Used for page-templates that can be re-used across the wiki.
{{{1}}}




Syntax Examples - Only Specify the Command:

{{Get|command|section=YourSectionName}}


command



Template:Note: If you omit the section=YourSectionName, by default will be used the section example


Show alternative Text:

{{Get|command|alt text|section=YourSectionName}}


alt text
Need an Example




Show alternative Text and specify code sample:

{{Get|command|alt text|<pre>sample code</pre>|section=YourSectionName}}


alt text
<pre>sample code</pre>




By setting the boolean "open" the code sample is shown by default:

{{Get|command|alt text|<pre>sample code</pre>|open=1|section=YourSectionName}}


alt text
sample code




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}}
alt text
sample code




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 Description2

Either Alternate Description of Command or an Example

Example
volume show where status = offline
Stringoptional
Sample output3

An example output of runing this command

Example
&lt;pre&gt;volume show where status = offline&lt;/pre&gt;
Stringoptional
Pre Colorcolor

Color of Pre-formatted Example

Example
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
Sample outputexample

An example output of runing this command

Example
&lt;pre&gt;volume show where status = offline&lt;/pre&gt;
Stringoptional
Alternative Command Descriptionalt-text

Either Alternate Description of Command or an Example

Example
volume show where status = offline
Stringoptional