Struct bookbinder_latex::PreambleOptions

pub struct PreambleOptions { /* fields omitted */ }

Options for generating a pdf through LaTeX

Implementations

impl PreambleOptions

pub fn chapter_label<S: Into<Cow<'static, str>>>(
    &mut self,
    label: S
) -> &mut Self

Set a custom label for chapters (i.e. renew \\chaptername in the preamble)

pub fn set_linespread(&mut self, linespread: f32) -> &mut Self

Set the linespread

pub fn open_any(&mut self) -> &mut Self

Open on any

pub fn set_secnumdepth(&mut self, secnumdepth: LatexSecNumDepth) -> &mut Self

Set the secnumdepth

pub fn set_publisher_logo(&mut self, p: PathBuf) -> Result<&mut Self, String>

Set the logo of a publisher to use on the titlepage

pub fn set_sans_typeface<T: Into<LatexFont>>(
    &mut self,
    typeface: T
) -> &mut Self

Set the sans typeface; this is used in sans text, but is also the fallback typeface for headings, headers and footers, and the titlepage

pub fn set_serif_typeface<T: Into<LatexFont>>(
    &mut self,
    typeface: T
) -> &mut Self

Set the serif typeface

pub fn set_mono_typeface<T: Into<LatexFont>>(
    &mut self,
    typeface: T
) -> &mut Self

Set the monospace typeface to use in code samples, urls, etc

pub fn set_titlepage_typeface<T: Into<LatexFont>>(
    &mut self,
    typeface: T
) -> &mut Self

Set the typeface to use on the titlepage

pub fn set_headers_and_footers_typeface<T: Into<LatexFont>>(
    &mut self,
    typeface: T
) -> &mut Self

Set the typeface to use in running headers and footers

pub fn set_heading_typeface<T: Into<LatexFont>>(
    &mut self,
    typeface: T
) -> &mut Self

Set the typeface to use in headings

pub fn suppress_chapter_titles(&mut self) -> &mut Self

Do not show any given chapter's title -- rely instead on its label. For example, Chapter 1: Wolves Attack! would be represented as Chapter 1

pub fn suppress_chapter_label(&mut self) -> &mut Self

Do not label chapters as such in headings; i.e. use only the chapter title. For example, Chapter 1: Wolves Attack! would be represented as Wolves Attack!

pub fn only_number_chapters(&mut self) -> &mut Self

Indicate chapters only by using a numerical indication, in whatever format. For example, Chapter 1: Wolves Attack! would be represented as 1, or I if use_roman_numerals_for_chapter_labels was called

pub fn use_roman_numerals_for_chapter_labels(&mut self) -> &mut Self

Label chapters with roman rather than arabic numerals: e.g. a third chapter would be labelled as Chapter III not Chapter 3

pub fn use_words_for_chapter_labels(&mut self) -> &mut Self

Label chapters with words rather than numbers: e.g. a first chapter would be labelled as Chapter One not Chapter 1

pub fn include_toc(&mut self) -> &mut Self

Include a table of contents

pub fn suppress_footers(&mut self) -> &mut Self

have blank pdf running footers

pub fn page_number_only_in_footers(&mut self) -> &mut Self

only include the page number in pdf running footers

pub fn do_not_suppress_figure_labels(&mut self) -> &mut Self

label figures in pdf output

pub fn ten_pt(&mut self) -> &mut Self

set the font size to use in pdf output at 11pt

pub fn eleven_pt(&mut self) -> &mut Self

set the font size to use in pdf output at 11pt

pub fn twelve_pt(&mut self) -> &mut Self

set the font size to use in pdf output at 11pt

pub fn set_papersize(&mut self, size: PaperSize) -> &mut Self

Set the size of paper to use in this book

Trait Implementations

impl Clone for PreambleOptions

fn clone(&self) -> PreambleOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PreambleOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PreambleOptions

fn default() -> Self

Returns the "default value" for a type.

impl From<PreambleOptions> for OptionsWithRenderedPreamble

fn from(src: PreambleOptions) -> Self

Performs the conversion.