Template:KernelBox/doc
From HPC Wiki
Jump to:navigation
Jump to:search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.
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 or fixes, or to voice your opinion.
Displays a block element with for required kernel options
Important
The contents may contain special characters (| or =) that break the MediaWiki templating system. You have these options to put the contents if you need to escape these characters:
The contents may contain special characters (| or =) that break the MediaWiki templating system. You have these options to put the contents if you need to escape these characters:
{{KernelBox|1=contents}}{{KernelBox|<nowiki>contents</nowiki>}}{{KernelBox|<pre>contents</pre>}}
Parameters
| Parameter name | Required? | Default value | Description |
|---|---|---|---|
Anonymous parameter 1 |
Yes | (n/a) | Kernel configuration |
title |
No | (n/a) | Title to display in the box header |
Usage
See the template's testcases:
| No parameter | |
|---|---|
| Wiki code | {{KernelBox}}
|
| Main version | Template:XYZ |
| Sandbox version | Template:XYZ/sandbox |
| Parameters: 1=Some kernel options. | |
|---|---|
| Wiki code | {{KernelBox|1=Some kernel options.}}
|
| Main version | KERNEL
|
| Sandbox version | KERNEL
|
| Parameters: title=KernelBox example, 1=Some kernel options. | |
|---|---|
| Wiki code | {{KernelBox|title=KernelBox with title example|1=Some kernel options.}}
|
| Main version | KERNEL KernelBox with title example
|
| Sandbox version | KERNEL KernelBox with title example
|