diff options
| author | Martin Haug <mhaug@live.de> | 2022-12-20 15:31:36 +0100 |
|---|---|---|
| committer | Martin Haug <mhaug@live.de> | 2022-12-20 15:55:15 +0100 |
| commit | b8ffd3ad3dcaebddbc674e03494e0d818b21fa51 (patch) | |
| tree | d33bbe2c2d2e0b37cdfd1031e16cbf9831a6a089 /library/src/meta/reference.rs | |
| parent | b4b022940b908d8fe490b9f4f68bc60dcfb76cd2 (diff) | |
Document meta and data loading categories
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. |
