Template:Equation box 1/doc

Displays an equation in a box.

The full syntax is:

{{Equation box 1|indent|title|equation|ref|cellpadding|border|border colour|background colour}}

Parameters

1. Indent: Type colon (:) to indent the box from the left side of the page, or two colons (::) for twice as much indentation. Leave blank, or use any other value, for no indentation. (Note that this uses CSS to adjust margins, rather than following the semantics of the leading colon in wiki markup, which would create an invalid description list.)
2. Title: Title/name of equation. Leave blank for no title.
3. Equation: The equation in whatever form, usually <math> equation in LaTeX ... </math>. Leave blank to get an equation showing the general form of a complex number, $z=re^{i\phi }=x+iy\,\!$ (only useful for examples).
4. Ref: Reference label. Calls {{EquationRef}} with provided value as the parameter. Leave blank for no reference label.
5. Cellpadding: Number of pixels to be used as padding of the box around the equation (how much the box wraps around the equation, margins). Default is 5.
6. Border: Thickness of the border line in pixels (do not include "px"; it will be added). Default is 2.
7. Border colour: Colour code (colour name or hex triplet) for the colour of the border line of the box. Default is #50C878, a nuance of green called emerald green.
8. Background colour: Colour code for the background area of the box. Default is #ECFCF4, a light grayish cyan.

See list of colours for use with the border and background colours. To use the parameters set the parameter equal to the value by using the equals sign.

Examples

Black/white theme

Complex number

$z=re^{i\phi }=x+iy\,\!$

{{Equation box 1
|title='''[[Complex number]]'''
|indent=:
|equation=<math>z=re^{i\phi}=x+iy \,\!</math>
|cellpadding = 6
|border = 1
|border colour = black
|background colour=white}}

Green theme

$z=re^{i\phi }=x+iy\,\!$

{{Equation box 1
|indent=:
|equation=<math>z=re^{i\phi}=x+iy \,\!</math>
|cellpadding
|border
|border colour = #50C878
|background colour = #ECFCF4}} 
}}

Blue theme

$z=re^{i\phi }=x+iy\,\!$

{{Equation box 1
|indent =:
|title=
|equation = <math>z=re^{i\phi}=x+iy \,\!</math>
|cellpadding= 6
|border
|border colour = #0073CF
|background colour=#F5FFFA}}

With reference

2 × 2 = 4   (1)

{{Equation box 1 |equation = {{math|1=2 × 2 = 4}} |ref=1}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Equation box 1

[[Category:TemplateData documentation{{#translation:}}]]

Displays an equation in a box.

Template parameters

Parameter		Description	Type	Status
Indent	indent	One or two colons for an indent from the left, OR a valid CSS margin value. Leave blank for no indent. Example :	String	optional
Cellpadding (margin)	cellpadding	Number of pixels to be used as padding of the box around the equation (how much the box wraps around the equation; margins). Default is 5. Default 5 Example 4	Number	optional
Border thickness	border	Thickness of border line in pixels. Default is 2. Default 2 Example 3	Number	optional
Border colour	border colour	Colour code (colour name or hex triplet in the format #RRGGBB) for the border line of the box. Default is #50C878, a nuance of green called emerald green. Default #50C878	String	optional
Background colour	background colour	Colour code (colour name or hex triplet in the format #RRGGBB) for the background colour of the box. Default is #ECFCF4, a light grayish cyan. Default #ECFCF4 Example #FFCC00	String	optional
Title/name	title	Title/name of equation. Can be left blank for no title. Example '''Time-dependent Schrödinger equation in position basis'''<br/>''(single [[relativistic quantum mechanics|nonrelativistic]] particle)''	Line	suggested
Equation	equation	The equation in whatever form, usually <math>equation in LaTeX...</math>. The default equation is the general form of a complex number. Example <math> z = e^{i \phi} = x + iy </math>	Content	required
Reference label	ref	Label for the equation for later reference. Calls {{EquationRef}} with provided value as the parameter. Example 1	String	optional