Template:KernelBox/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 or fixes, or to voice your opinion.

Displays a block element for kernel options.

Important
File contents may contain the special characters | or = which are incompatible with MediaWiki's templating system. Substitute | with {{!}} and = with {{=}} for arguments to the 1= parameter for correct template usage. If substitution is ignored, then formatting will not work correctly with this template.

Parameters

Displays a block element for kernel options

Template parameters

Parameter		Description	Type	Status
Kernel configuration	1	no description	Content	required
Title	title	Additional title to display in the box header	String	suggested

Usage

See the template's testcases:

Correct

Empty unnamed parameter with {{KEntry}} inside preformatted text (note the single space at the start of each line)

Wiki code

{{KernelBox|1=}}
 Device Drivers --->
   Input device support --->
     <*>  {{KEntry|Event interface|INPUT_EVDEV}}

Main version

KERNEL

Device Drivers --->
  Input device support --->
    <*>  Event interface Search for <code>CONFIG_INPUT_EVDEV</code> to find this item.

Sandbox version

KERNEL

{{{1}}}

Device Drivers --->
  Input device support --->
    <*>  Event interface Search for <code>CONFIG_INPUT_EVDEV</code> to find this item.

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.

Incorrect

No parameter
Wiki code	{{KernelBox}}
Main version	KERNEL {{{1}}}
Sandbox version	KERNEL {{{1}}}

{{KEntry}} inside parameter 1

Wiki code

{{KernelBox|1=
Device Drivers --->
  Input device support --->
    <*>  {{KEntry|Event interface|INPUT_EVDEV}}
}}

Main version

KERNEL

Device Drivers --->
  Input device support --->
    <*>  Event interface <span class="smw-highlighter" data-type="8" data-state="inline" data-title="Note" title="Search for CONFIG_INPUT_EVDEV to find this item."><span class="smwtticon note"></span><span class="smwttcontent">[[:Kernel/Configuration#Search_modules|Search]] for &lt;code&gt;CONFIG_INPUT_EVDEV&lt;/code&gt; to find this item.</span></span>

Sandbox version

KERNEL

Device Drivers --->
  Input device support --->
    <*>  Event interface <span class="smw-highlighter" data-type="8" data-state="inline" data-title="Note" title="Search for CONFIG_INPUT_EVDEV to find this item."><span class="smwtticon note"></span><span class="smwttcontent">[[:Kernel/Configuration#Search_modules|Search]] for &lt;code&gt;CONFIG_INPUT_EVDEV&lt;/code&gt; to find this item.</span></span>

See also

• {{CodeBox}}
• {{FileBox}}
• {{PreBox}} - Parent template of *Box templates.