caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-08-21 18:24:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve user-facing documentation

Browse Source
This commit is contained in:
Malo 2025-06-12 21:48:01 +01:00
parent 2b180bd68f
commit 0a4d4ffa8d
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
crates/typst-library/src/text/shift.rs
View File

@ -16,12 +16,11 @@ use typst_library::text::ScriptMetrics;
/// ``` /// ```
#[elem(title = "Subscript", Show)] #[elem(title = "Subscript", Show)]
pub struct SubElem { pub struct SubElem {
/// Whether to create artificial subscripts by shifting and scaling down /// Whether to create artificial subscripts by lowering and scaling down
/// regular glyphs. /// regular glyphs.
/// ///
/// Ideally, subscripts glyphs should be provided by the font (using the /// Ideally, subscripts glyphs are provided by the font (using the `subs`
/// `subs` OpenType feature). Otherwise, Typst is able to synthesize /// OpenType feature). Otherwise, Typst is able to synthesize subscripts.
/// subscripts as explained above.
/// ///
/// When this is set to `{false}`, synthesized glyphs will be used /// When this is set to `{false}`, synthesized glyphs will be used
/// regardless of whether the font provides dedicated subscript glyphs. When /// regardless of whether the font provides dedicated subscript glyphs. When
@ -35,11 +34,14 @@ pub struct SubElem {
#[default(true)] #[default(true)]
pub typographic: bool, pub typographic: bool,
/// The baseline shift for synthesized subscripts. /// The downward baseline shift for synthesized subscripts.
/// ///
/// This only applies to synthesized subscripts. In other words, this has no /// This only applies to synthesized subscripts. In other words, this has no
/// effect if `typographic` is `{true}` and the font provides the necessary /// effect if `typographic` is `{true}` and the font provides the necessary
/// subscript glyphs. /// subscript glyphs.
///
/// If set to `{auto}`, the baseline is shifted according to the metrics
/// provided by the font.
pub baseline: Smart<Length>, pub baseline: Smart<Length>,
/// The font size for synthesized subscripts. /// The font size for synthesized subscripts.
@ -47,6 +49,9 @@ pub struct SubElem {
/// This only applies to synthesized subscripts. In other words, this has no /// This only applies to synthesized subscripts. In other words, this has no
/// effect if `typographic` is `{true}` and the font provides the necessary /// effect if `typographic` is `{true}` and the font provides the necessary
/// subscript glyphs. /// subscript glyphs.
///
/// If set to `{auto}`, the size is scaled according to the metrics provided
/// by the font.
pub size: Smart<TextSize>, pub size: Smart<TextSize>,
/// The text to display in subscript. /// The text to display in subscript.
@ -80,12 +85,11 @@ impl Show for Packed<SubElem> {
/// ``` /// ```
#[elem(title = "Superscript", Show)] #[elem(title = "Superscript", Show)]
pub struct SuperElem { pub struct SuperElem {
/// Whether to create artificial superscripts by shifting and scaling down /// Whether to create artificial superscripts by raising and scaling down
/// regular glyphs. /// regular glyphs.
/// ///
/// Ideally, superscripts glyphs should be provided by the font (using the /// Ideally, superscripts glyphs are provided by the font (using the `sups`
/// `subs` OpenType feature). Otherwise, Typst is able to synthesize /// OpenType feature). Otherwise, Typst is able to synthesize superscripts.
/// superscripts as explained above.
/// ///
/// When this is set to `{false}`, synthesized glyphs will be used /// When this is set to `{false}`, synthesized glyphs will be used
/// regardless of whether the font provides dedicated superscript glyphs. /// regardless of whether the font provides dedicated superscript glyphs.
@ -99,11 +103,18 @@ pub struct SuperElem {
#[default(true)] #[default(true)]
pub typographic: bool, pub typographic: bool,
/// The baseline shift for synthesized superscripts. /// The downward baseline shift for synthesized superscripts.
/// ///
/// This only applies to synthesized superscripts. In other words, this has /// This only applies to synthesized superscripts. In other words, this has
/// no effect if `typographic` is `{true}` and the font provides the /// no effect if `typographic` is `{true}` and the font provides the
/// necessary superscript glyphs. /// necessary superscript glyphs.
///
/// If set to `{auto}`, the baseline is shifted according to the metrics
/// provided by the font.
///
/// Note that, since the baseline shift is applied downward, you will need
/// to provide a negative value for the content to appear as raised above
/// the normal baseline.
pub baseline: Smart<Length>, pub baseline: Smart<Length>,
/// The font size for synthesized superscripts. /// The font size for synthesized superscripts.
@ -111,6 +122,9 @@ pub struct SuperElem {
/// This only applies to synthesized superscripts. In other words, this has /// This only applies to synthesized superscripts. In other words, this has
/// no effect if `typographic` is `{true}` and the font provides the /// no effect if `typographic` is `{true}` and the font provides the
/// necessary superscript glyphs. /// necessary superscript glyphs.
///
/// If set to `{auto}`, the size is scaled according to the metrics provided
/// by the font.
pub size: Smart<TextSize>, pub size: Smart<TextSize>,
/// The text to display in superscript. /// The text to display in superscript.