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.

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:
  1. {{KernelBox|1=contents}}
  2. {{KernelBox|<nowiki>contents</nowiki>}}
  3. {{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
Some kernel options.
Sandbox version
KERNEL
Some kernel options.
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
Some kernel options.
Sandbox version
KERNEL KernelBox with title example
Some kernel options.

See also