Template:KernelBox/doc

From Gentoo Wiki
Jump to: navigation, 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
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

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
KERNEL
{{{1}}}
Sandbox version
KERNEL
 {{{1}}}


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.


Parameters: title=KernelBox example, collapse-output=true, 1=Some long kernel configuration options ...
Wiki code {{KernelBox|title=KernelBox with title example|collapse-output=true|1=Some long kernel options ...}}

Main version
KERNEL KernelBox with title example
Some kernel options ...

Some more options...

... very long options.
Sandbox version
KERNEL KernelBox with title example
 Some long kernel options with collapsible output.

Some more options...

... very long options.


See also