Template:Example/doc

Description

As the name suggests, this template produces a colored box, which is used when you want to give an example on a page. You can use common wiki-formatting (e.g. bold, links) if you wish. The formatting of this template is kept subtle on purpose, so as not to interfere too much with the general flow of a page (if you want a stronger emphasis for your text, you can use {{Note box}} or even {{Important note box}}).

Dependencies

Uses

{{Color box}}

Syntax

{{Example|<content>|<width= width>}}

Parameters

content

The note text inside the box. All wiki-formatting (bold, text color, links, etc) work as normal. If the text you would like to use include an equals sign (=), you need to explicitly declare your text as a numbered parameter (i.e. put 1= before your text), otherwise the template will display nothing.

width

Sets the width of the box. It's recommended to set this as a percentage (of the paragraph width), so 50% will produce a text box half as wide as the surrounding paragraph. If omitted, the text box will be as wide as the surrounding paragraph. When width is set to less than 100%, the box will be centered.

Examples

{{Example|An example to ''illustrate'' my article with a link to the [[Venture]].}}

gives ...

An example to illustrate my article with a link to the Venture.

{{Example|How not to put the formula 2+2=4 into an example.}}

gives ...

An example!

{{Example|1= How to put the formula 2+2=4 into an example.}}

gives ...

How to put the formula 2+2=4 into an example.

See also

• {{Note box}} and {{Important note box}} , designed for general notes and warnings on pages.
• {{Color box}} , the general template for creating colored boxes with text in them.