Template:KconfigBox/doc

Not to be confused with Template:KernelBox.

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 configuration 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 configuration options

Template parameters

Parameter		Description	Type	Status
Configuration options organized in a tree structure	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

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

Main version

KCONFIG

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

Sandbox version

KCONFIG

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

Incorrect

No parameter
Wiki code	{{KconfigBox}}
Main version	KCONFIG {{{1}}}
Sandbox version	KCONFIG {{{1}}}

See also

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