View source for Template:Equation box 1/doc

{{documentation subpage}}
Displays an equation in a box. 

The full syntax is:

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

==Parameters==

#'''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.)
#'''Title''': Title/name of equation. Leave blank for no title.
#'''Equation''': The equation in [[WP:«math»|whatever form]], usually [[Help:Displaying a formula|<kbd>&lt;math></kbd>]] ''equation in LaTeX ...'' <kbd>&lt;/math></kbd>. Leave blank to get an equation showing the general form of a complex number, <math>z=re^{i\phi}=x+iy \,\!</math> (only useful for examples).
#'''Ref''': Reference label. Calls {{tl|EquationRef}} with provided value as the parameter. Leave blank for no reference label.
#'''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.
#'''Border''': Thickness of the border line in pixels (do not include "px"; it will be added). Default is 2.
#'''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]].
#'''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===

{{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}}

<syntaxhighlight lang="moin">{{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}}</syntaxhighlight>

===Green theme===

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

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

===Blue theme===

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

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

===With reference===

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

<code><nowiki>{{Equation box 1
|equation = {{math|1=2 × 2 = 4}}
|ref=1}}</nowiki></code>

<includeonly>
[[Category:Mathematical formatting templates]]
</includeonly>
==TemplateData==
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"indent": {
			"label": "Indent",
			"description": "One or two colons for an indent from the left, OR a valid CSS margin value. Leave blank for no indent.",
			"example": ":",
			"type": "string"
		},
		"cellpadding": {
			"label": "Cellpadding (margin)",
			"description": "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",
			"type": "number"
		},
		"border": {
			"label": "Border thickness",
			"description": "Thickness of border line in pixels. Default is 2.",
			"example": "3",
			"type": "number",
			"default": "2"
		},
		"border colour": {
			"label": "Border colour",
			"description": "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.",
			"type": "string",
			"default": "#50C878"
		},
		"background colour": {
			"label": "Background colour",
			"description": "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.",
			"type": "string",
			"default": "#ECFCF4",
			"example": "#FFCC00"
		},
		"title": {
			"label": "Title/name",
			"description": "Title/name of equation. Can be left blank for no title.",
			"type": "line",
			"example": "'''Time-dependent Schrödinger equation in position basis'''<br/>''(single [[relativistic quantum mechanics|nonrelativistic]] particle)''",
			"suggested": true
		},
		"equation": {
			"label": "Equation",
			"description": "The equation in whatever form, usually <math>equation in LaTeX...</math>. The default equation is the general form of a complex number.",
			"type": "content",
			"example": "<math> z = e^{i \\phi} = x + iy </math>",
			"required": true
		},
		"ref": {
			"label": "Reference label",
			"description": "Label for the equation for later reference. Calls {{EquationRef}} with provided value as the parameter.",
			"example": "1",
			"type": "string"
		}
	},
	"description": "Displays an equation in a box."
}
</templatedata>