konevsa/typst
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Expand label docs

Browse Source 
Co-Authored-By: Andrew Voynov <37143421+Andrew15-5@users.noreply.github.com>
This commit is contained in:
Laurenz 2023-10-09 13:58:39 +02:00
parent 6dab95473b
commit cb7079711a
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
crates/typst/src/model/label.rs
View File

@ -6,9 +6,12 @@ use crate::eval::{func, scope, ty, Repr};
/// A label for an element.
///
/// Inserting a label into content attaches it to the closest previous element
/// that is not a space. Then, the element can be [referenced]($ref) and styled
/// through the label.
/// Inserting a label into content attaches it to the closest preceding element
/// that is not a space. The preceding element must be in the same scope as the
/// label, which means that `[Hello #[<label>]]`, for instance, wouldn't work.
///
/// A labelled element can be [referenced]($ref), [queried]($query) for, and
/// [styled]($styling) through its label.
///
/// # Example
/// ```example
@ -22,6 +25,9 @@ use crate::eval::{func, scope, ty, Repr};
/// # Syntax
/// This function also has dedicated syntax: You can create a label by enclosing
/// its name in angle brackets. This works both in markup and code.
///
/// Currently, labels can only be attached to elements in markup mode, not in
/// code mode. This might change in the future.
#[ty(scope)]
#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct Label(pub EcoString);