Template:RootCmd/doc

Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.

As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements, fixes or voice your opinion.

Use this template to show a shell box with a root command.

Parameters

Unnamed parameters (up to 10)
Add commands. Use {{=}} or {{!}} instead of the characters "=" or "|".
prompt (optional)
Change the command prompt (default: root #).
color (optional)
Change the prompt color (default: some red).
output (optional)
Add the command's output.

Usage

See the template's testcases:


Parameter: unnamed
Wiki code 
{{RootCmd|a command}}
Main version
root # a command
Sandbox version


Parameter: unnamed with the special characters "=" and "|"
Wiki code 
{{RootCmd|a command with {{=}} and {{!}}}}
Main version
root # a command with = and |
Sandbox version


Parameter: output
Wiki code 
{{RootCmd|a command|output=<pre>
Some output
</pre>}}
Main version
root # a command
Some output
Sandbox version


Parameter: prompt, color
Wiki code 
{{RootCmd
|a command
|prompt=example ?
|color=blue
}}
Main version
example ? a command
Sandbox version


Parameter: unnamed (10x)
Wiki code 
{{RootCmd
|1. command
|...
|10. command
}}
Main version
root # 1. command
root # 2. command
root # 3. command
root # 4. command
root # 5. command
root # 6. command
root # 7. command
root # 8. command
root # 9. command
root # 10. command
Sandbox version


See also

Last modified on 22 August 2014, at 08:51