diff options
Diffstat (limited to 'library/src/meta/reference.rs')
| -rw-r--r-- | library/src/meta/reference.rs | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/library/src/meta/reference.rs b/library/src/meta/reference.rs index c49ff970..1a4b22e4 100644 --- a/library/src/meta/reference.rs +++ b/library/src/meta/reference.rs @@ -3,6 +3,18 @@ use crate::text::TextNode; /// A reference to a label. /// +/// *Note: This function is currently unimplemented.* +/// +/// The reference function produces a textual reference to a label. For example, +/// a reference to a heading will yield an appropriate string such as "Section +/// 1" for a reference to the first heading's label. The references are also +/// links to the respective labels. +/// +/// # Syntax +/// This function also has dedicated syntax: A reference to a label can be +/// created by typing an `@` followed by the name of the label (e.g. `[= +/// Introduction <intro>]` can be referenced by typing `[@intro]`). +/// /// # Parameters /// - target: Label (positional, required) /// The label that should be referenced. |