{"route":"/en-US-v0.14.1/reference/math/equation/","title":"Equation","description":"Documentation for the `equation` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"syntax","name":"Syntax","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-block","name":"block","children":[]},{"id":"parameters-numbering","name":"numbering","children":[]},{"id":"parameters-number-align","name":"number-align","children":[]},{"id":"parameters-supplement","name":"supplement","children":[]},{"id":"parameters-alt","name":"alt","children":[]},{"id":"parameters-body","name":"body","children":[]}]}],"body":{"kind":"func","content":{"path":["math"],"name":"equation","title":"Equation","keywords":[],"oneliner":"A mathematical equation.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A mathematical equation.

\n

Can be displayed inline with text or as a separate block. An equation\nbecomes block-level through the presence of whitespace after the opening\ndollar sign and whitespace before the closing dollar sign.

\n

Example

\n
#set text(font: "New Computer Modern")\n\nLet $a$, $b$, and $c$ be the side\nlengths of right-angled triangle.\nThen, we know that:\n$ a^2 + b^2 = c^2 $\n\nProve by induction:\n$ sum_(k=1)^n k = (n(n+1)) / 2 $\n
\"Preview\"
\n

By default, block-level equations will not break across pages. This can be\nchanged through show math.equation: set block(breakable: true).

\n

Syntax

\n

This function also has dedicated syntax: Write mathematical markup within\ndollar signs to create an equation. Starting and ending the equation with\nwhitespace lifts it into a separate block that is centered horizontally.\nFor more details about math syntax, see the\nmain math page.

"}],"self":false,"params":[{"name":"block","details":[{"kind":"html","content":"

Whether the equation is displayed as a separate block.

"}],"types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"numbering","details":[{"kind":"html","content":"

How to number block-level equations. Accepts a\nnumbering pattern or function taking a single number.

"},{"kind":"example","content":{"body":"
#set math.equation(numbering: "(1)")\n\nWe define:\n$ phi.alt := (1 + sqrt(5)) / 2 $ <ratio>\n\nWith @ratio, we get:\n$ F_n = floor(1 / sqrt(5) phi.alt^n) $\n
\"Preview\"
","title":null}}],"types":["none","str","function"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"number-align","details":[{"kind":"html","content":"

The alignment of the equation numbering.

\n

By default, the alignment is end + horizon. For the horizontal\ncomponent, you can use right, left, or start and end\nof the text direction; for the vertical component, you can use\ntop, horizon, or bottom.

"},{"kind":"example","content":{"body":"
#set math.equation(numbering: "(1)", number-align: bottom)\n\nWe can calculate:\n$ E &= sqrt(m_0^2 + p^2) \\\n    &approx 125 "GeV" $\n
\"Preview\"
","title":null}}],"types":["alignment"],"strings":[],"default":"end + horizon","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"supplement","details":[{"kind":"html","content":"

A supplement for the equation.

\n

For references to equations, this is added before the referenced number.

\n

If a function is specified, it is passed the referenced equation and\nshould return content.

"},{"kind":"example","content":{"body":"
#set math.equation(numbering: "(1)", supplement: [Eq.])\n\nWe define:\n$ phi.alt := (1 + sqrt(5)) / 2 $ <ratio>\n\nWith @ratio, we get:\n$ F_n = floor(1 / sqrt(5) phi.alt^n) $\n
\"Preview\"
","title":null}}],"types":["none","auto","content","function"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"alt","details":[{"kind":"html","content":"

An alternative description of the mathematical equation.

\n

This should describe the full equation in natural language and will be\nmade available to Assistive Technology. You can learn more in the\nTextual Representations section of the Accessibility\nGuide.

"},{"kind":"example","content":{"body":"
#math.equation(\n  alt: "integral from 1 to infinity of a x squared plus b with respect to x",\n  block: true,\n  $ integral_1^oo a x^2 + b dif x $,\n)\n
\"Preview\"
","title":null}}],"types":["none","str"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"body","details":[{"kind":"html","content":"

The contents of the equation.

"}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["content"],"scope":[]}}}