pub struct CoverPageStyle {Show 30 fields
pub enabled: bool,
pub margin_x: Option<f32>,
pub margin_y: Option<f32>,
pub logo: Option<LogoSpec>,
pub logo_position: LogoPosition,
pub hero: Option<LogoSpec>,
pub hero_gap: f32,
pub top_margin: f32,
pub logo_to_title_gap: f32,
pub title_font_size: f32,
pub title_accent: String,
pub title_accent_color: Option<ColorRgb>,
pub title_to_subtitle_gap: f32,
pub subtitle: String,
pub subtitle_font_size: f32,
pub subtitle_to_authors_gap: f32,
pub show_authors: bool,
pub authors_font_size: f32,
pub authors_to_date_gap: f32,
pub show_date: bool,
pub date_font_size: f32,
pub text_color: ColorRgb,
pub align: CoverAlign,
pub detail_lines: Vec<String>,
pub detail_font_size: f32,
pub title_to_detail_gap: f32,
pub detail_line_gap: f32,
pub detail_color: Option<ColorRgb>,
pub blank_page_after: bool,
pub font_families: Vec<String>,
}Fields§
§enabled: bool§margin_x: Option<f32>Horizontal page margin for the cover page only, in points. Defaults
to the document margin_x. A smaller value lets cover art (the hero
image) bleed wider than the body text column.
margin_y: Option<f32>Vertical page margin for the cover page only, in points. Defaults to
the document margin_y. A smaller value gives the cover more room
(e.g. for a tall hero) and lifts the logo toward the page top. Only
honoured when the cover page skips its header / footer.
logo: Option<LogoSpec>§logo_position: LogoPositionWhere the logo sits relative to the title. See LogoPosition.
hero: Option<LogoSpec>Optional hero image (e.g. a product photo) drawn below the cover
metadata — a second image slot so a cover can show both a brand
logo (above the title) and a hero image. id / src are templates
({title} / any frontmatter var). Prefer id for an asset-library
GUID ({coverImage}); src still accepts a filename such as
{title}.png. Unlike the logo, the hero fills the cover column
width and keeps the source aspect ratio; width / height on the
spec are ignored.
hero_gap: f32Gap above the hero image.
top_margin: f32Vertical space above the first element on the page (the logo
when logo_position = "above", otherwise the title).
Defaults to ~1/4 of A4 height.
logo_to_title_gap: f32Gap between the logo image and the title text — applied
regardless of logo_position. When above, the gap is below
the logo; when below_title, it’s between the title and the
logo.
title_font_size: f32§title_accent: StringOptional accent run appended inline to the title and rendered in
a lighter weight and (optionally) a different colour — e.g. a
title of “MyProduct” with title_accent = " Manual" renders the
product name bold and “Manual” in a muted accent beside it. The
string is a template ({title} / {date} / any frontmatter var)
so the accent can come from metadata; empty omits it.
title_accent_color: Option<ColorRgb>Colour for title_accent. Defaults to text_color when unset.
title_to_subtitle_gap: f32§subtitle: StringTemplate string for the subtitle — supports the same
{title}/{description}/{date} substitutions as headers.
Empty string omits the subtitle entirely.
subtitle_font_size: f32§show_date: bool§date_font_size: f32§text_color: ColorRgb§align: CoverAlignHorizontal alignment of every cover text block (title, subtitle, detail lines, authors, date). Defaults to centred.
detail_lines: Vec<String>Extra metadata lines rendered under the title, each a template
string ({title} / {description} / {date} / any
RenderContext var). Use for “Date: {date}”, “Version:
{version}”, etc. A line whose substitution is empty is skipped.
detail_font_size: f32Font size for detail_lines.
title_to_detail_gap: f32Gap below the title before the detail lines.
detail_line_gap: f32Vertical gap between consecutive detail lines.
detail_color: Option<ColorRgb>Colour for detail_lines. Defaults to text_color when unset;
typically a muted grey.
blank_page_after: boolWhen true, insert a fully blank page directly after the
cover page so the body content starts on page 3 — a recto in
double-sided printing. Useful for printed reports / books;
no effect when the document is read on screen.
font_families: Vec<String>Font families for this element, in fallback order. Empty means
“inherit the document body families” (body_font_families, or
the bundled Noto defaults when that is also empty). Names must
be families the font collection knows — either system-installed
or exposed by a file listed in font_paths.
Note this REPLACES the body list rather than extending it, so a Latin-only face here will lose the multi-script fallbacks. List the scripts you need explicitly if the document is not Latin-only.
Trait Implementations§
Source§impl Clone for CoverPageStyle
impl Clone for CoverPageStyle
Source§impl Debug for CoverPageStyle
impl Debug for CoverPageStyle
Source§impl Default for CoverPageStyle
impl Default for CoverPageStyle
Source§impl<'de> Deserialize<'de> for CoverPageStylewhere
CoverPageStyle: Default,
impl<'de> Deserialize<'de> for CoverPageStylewhere
CoverPageStyle: Default,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Forget for CoverPageStyle
impl Freeze for CoverPageStyle
impl Move for CoverPageStyle
impl RefUnwindSafe for CoverPageStyle
impl Send for CoverPageStyle
impl Sync for CoverPageStyle
impl Unpin for CoverPageStyle
impl UnsafeUnpin for CoverPageStyle
impl UnwindSafe for CoverPageStyle
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<U, T> ToOwnedObj<U> for Twhere
U: FromObjRef<T>,
impl<U, T> ToOwnedObj<U> for Twhere
U: FromObjRef<T>,
Source§fn to_owned_obj(&self, data: FontData<'_>) -> U
fn to_owned_obj(&self, data: FontData<'_>) -> U
T, using the provided data to resolve any offsets.