diff options
| author | Laurenz <laurmaedje@gmail.com> | 2022-12-22 18:25:29 +0100 |
|---|---|---|
| committer | Laurenz <laurmaedje@gmail.com> | 2022-12-22 18:25:29 +0100 |
| commit | 8527517258cf62a2f229796cc3f118d8bf0494b6 (patch) | |
| tree | 7662e90bcb9d610e63f4b1a9f1f12f84cb1f742a /library/src/basics | |
| parent | 947522b71aa6220ce8f006bfab4700d6e3cb04f1 (diff) | |
Rename `desc` to `terms`
Diffstat (limited to 'library/src/basics')
| -rw-r--r-- | library/src/basics/enum.rs | 4 | ||||
| -rw-r--r-- | library/src/basics/list.rs | 4 | ||||
| -rw-r--r-- | library/src/basics/mod.rs | 4 | ||||
| -rw-r--r-- | library/src/basics/terms.rs (renamed from library/src/basics/desc.rs) | 52 |
4 files changed, 31 insertions, 33 deletions
diff --git a/library/src/basics/enum.rs b/library/src/basics/enum.rs index f0ca217a..81a36b61 100644 --- a/library/src/basics/enum.rs +++ b/library/src/basics/enum.rs @@ -5,8 +5,8 @@ use crate::layout::{BlockNode, GridNode, ParNode, Spacing, TrackSizing}; use crate::prelude::*; use crate::text::TextNode; -/// # Enumeration -/// An ordered list. +/// # Numbered List +/// A numbered list. /// /// Displays a sequence of items vertically and numbers them consecutively. /// diff --git a/library/src/basics/list.rs b/library/src/basics/list.rs index eaba6594..24c7b21c 100644 --- a/library/src/basics/list.rs +++ b/library/src/basics/list.rs @@ -2,8 +2,8 @@ use crate::layout::{BlockNode, GridNode, ParNode, Spacing, TrackSizing}; use crate::prelude::*; use crate::text::TextNode; -/// # List -/// An unordered list. +/// # Bullet List +/// An bullet list. /// /// Displays a sequence of items vertically, with each item introduced by a /// marker. diff --git a/library/src/basics/mod.rs b/library/src/basics/mod.rs index 431cb004..7520c42d 100644 --- a/library/src/basics/mod.rs +++ b/library/src/basics/mod.rs @@ -1,14 +1,14 @@ //! Common document elements. -mod desc; #[path = "enum.rs"] mod enum_; mod heading; mod list; mod table; +mod terms; -pub use self::desc::*; pub use self::enum_::*; pub use self::heading::*; pub use self::list::*; pub use self::table::*; +pub use self::terms::*; diff --git a/library/src/basics/desc.rs b/library/src/basics/terms.rs index 2c764c59..1570d177 100644 --- a/library/src/basics/desc.rs +++ b/library/src/basics/terms.rs @@ -2,7 +2,7 @@ use crate::layout::{BlockNode, GridNode, HNode, ParNode, Spacing, TrackSizing}; use crate::prelude::*; use crate::text::{SpaceNode, TextNode}; -/// # Description List +/// # Term List /// A list of terms and their descriptions. /// /// Displays a sequence of terms and their descriptions vertically. When the @@ -11,8 +11,7 @@ use crate::text::{SpaceNode, TextNode}; /// /// ## Syntax /// This function also has dedicated syntax: Starting a line with a slash, -/// followed by a term, a colon and a description creates a description list -/// item. +/// followed by a term, a colon and a description creates a term list item. /// /// ## Example /// ``` @@ -23,10 +22,10 @@ use crate::text::{SpaceNode, TextNode}; /// /// ## Parameters /// - items: Content (positional, variadic) -/// The descrition list's children. +/// The term list's children. /// -/// When using the description list syntax, adjacents items are automatically -/// collected into description lists, even through constructs like for loops. +/// When using the term list syntax, adjacents items are automatically +/// collected into term lists, even through constructs like for loops. /// /// ### Example /// ``` @@ -38,17 +37,17 @@ use crate::text::{SpaceNode, TextNode}; /// ``` /// /// - tight: bool (named) -/// If this is `{false}`, the items are spaced apart with [description list -/// spacing](@desc/spacing). If it is `{true}`, they use normal -/// [leading](@par/leading) instead. This makes the description list more -/// compact, which can look better if the items are short. +/// If this is `{false}`, the items are spaced apart with [term list +/// spacing](@terms/spacing). If it is `{true}`, they use normal +/// [leading](@par/leading) instead. This makes the term list more compact, +/// which can look better if the items are short. /// /// ### Example /// ``` -/// / Fact: If a description list has -/// a lot of text, and maybe other -/// inline content, it should not be -/// tight anymore. +/// / Fact: If a term list has a lot +/// of text, and maybe other inline +/// content, it should not be tight +/// anymore. /// /// / Tip: To make it wide, simply /// insert a blank line between the @@ -60,15 +59,15 @@ use crate::text::{SpaceNode, TextNode}; #[func] #[capable(Layout)] #[derive(Debug, Hash)] -pub struct DescNode { +pub struct TermsNode { /// If true, the items are separated by leading instead of list spacing. pub tight: bool, /// The individual bulleted or numbered items. - pub items: StyleVec<DescItem>, + pub items: StyleVec<TermItem>, } #[node] -impl DescNode { +impl TermsNode { /// The indentation of each item's term. #[property(resolve)] pub const INDENT: Length = Length::zero(); @@ -77,15 +76,14 @@ impl DescNode { /// /// # Example /// ``` - /// #set desc(hanging-indent: 0pt) - /// / Term: This description list - /// does not make use of hanging - /// indents. + /// #set terms(hanging-indent: 0pt) + /// / Term: This term list does not + /// make use of hanging indents. /// ``` #[property(resolve)] pub const HANGING_INDENT: Length = Em::new(1.0).into(); - /// The spacing between the items of a wide (non-tight) description list. + /// The spacing between the items of a wide (non-tight) term list. /// /// If set to `{auto}` uses the spacing [below blocks](@block/below). pub const SPACING: Smart<Spacing> = Smart::Auto; @@ -109,7 +107,7 @@ impl DescNode { } } -impl Layout for DescNode { +impl Layout for TermsNode { fn layout( &self, vt: &mut Vt, @@ -151,16 +149,16 @@ impl Layout for DescNode { } } -/// A description list item. +/// A term list item. #[derive(Debug, Clone, Hash)] -pub struct DescItem { +pub struct TermItem { /// The term described by the list item. pub term: Content, /// The description of the term. pub description: Content, } -impl DescItem { +impl TermItem { /// Encode the item into a value. fn encode(&self) -> Value { Value::Array(array