diff options
Diffstat (limited to 'library/src/meta/document.rs')
| -rw-r--r-- | library/src/meta/document.rs | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/library/src/meta/document.rs b/library/src/meta/document.rs index e20821c5..c5d4e050 100644 --- a/library/src/meta/document.rs +++ b/library/src/meta/document.rs @@ -1,7 +1,14 @@ use crate::layout::{LayoutRoot, PageNode}; use crate::prelude::*; -/// The root node that represents a full document. +/// The root element of a document and its metadata. +/// +/// All documents are automatically wrapped in a `document` element. The main +/// use of this element is to use it in `set` rules to specify document +/// metadata. +/// +/// The metadata set with this function is not rendered within the document. +/// Instead, it is embedded in the compiled PDF file. /// /// # Tags /// - meta @@ -12,7 +19,8 @@ pub struct DocumentNode(pub StyleVec<PageNode>); #[node] impl DocumentNode { - /// The document's title. + /// The document's title. This is often rendered as the title of the + /// PDF viewer window. #[property(referenced)] pub const TITLE: Option<EcoString> = None; |
