From 0bb0f1c98fc8eff5d7556bbe9d5801f02237a5c0 Mon Sep 17 00:00:00 2001 From: Laurenz Date: Mon, 6 Feb 2023 11:50:03 +0100 Subject: Import documentation Co-Authored-By: Martin Haug --- docs/src/reference/groups.yml | 63 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 docs/src/reference/groups.yml (limited to 'docs/src/reference/groups.yml') diff --git a/docs/src/reference/groups.yml b/docs/src/reference/groups.yml new file mode 100644 index 00000000..476a2a26 --- /dev/null +++ b/docs/src/reference/groups.yml @@ -0,0 +1,63 @@ +- name: variants + title: Variants + functions: ["serif", "sans", "frak", "mono", "bb", "cal"] + description: | + Alternate typefaces within formulas. + + These functions are distinct from the [`text`]($func/text) function because + math fonts contain multiple variants of each letter. + +- name: styles + title: Styles + functions: ["upright", "italic", "bold"] + description: | + Alternate letterforms within formulas. + + These functions are distinct from the [`text`]($func/text) function because + math fonts contain multiple variants of each letter. + +- name: underover + title: Under/Over + functions: [ + "underline", + "overline", + "underbrace", + "overbrace", + "underbracket", + "overbracket", + ] + description: | + Delimiters above or below parts of a formula. + + The braces and brackets further allow you to add an optional annotation + below or above themselves. + +- name: roots + title: Roots + functions: ["root", "sqrt"] + description: Square and non-square roots. + +- name: attach + title: Attach + functions: ["attach", "scripts", "limits"] + description: | + Subscript, superscripts, and limits. + + The `attach` function backs the `[$a_b^c$]` syntax that adds top and bottom + attachments to a part of a formula. Attachments can be displayed either as + sub/superscripts, or limits. Typst automatically decides which is more + suitable depending on the base, but you can also control this manually with + the `scripts` and `limits` functions. + +- name: lr + title: Left/Right + functions: ["lr", "abs", "norm", "floor", "ceil"] + description: | + Delimiter matching. + + The `lr` function allows you to match two delimiters and scale them with the + content they contain. While this also happens automatically for delimiters + that match syntactically, `lr` allows you to match two arbitrary delimiters + and control their size exactly. Apart from the `lr` function, Typst provides + a few more functions that create delimiter pairings for absolute, ceiled, + and floored values as well as norms. -- cgit v1.2.3