From b8ffd3ad3dcaebddbc674e03494e0d818b21fa51 Mon Sep 17 00:00:00 2001 From: Martin Haug Date: Tue, 20 Dec 2022 15:31:36 +0100 Subject: Document meta and data loading categories --- library/src/meta/reference.rs | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'library/src/meta/reference.rs') 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 ]` can be referenced by typing `[@intro]`). +/// /// # Parameters /// - target: Label (positional, required) /// The label that should be referenced. -- cgit v1.2.3