Struct FormatDocumentParams 

pub struct FormatDocumentParams {
    pub style: StyleInput,
    pub style_overrides: Option<String>,
    pub locale: Option<String>,
    pub output_format: Option<OutputFormat>,
    pub refs: Value,
    pub citations: Value,
    pub bibliography_blocks: Vec<BibliographyBlockRequest>,
    pub document_options: Option<DocumentOptions>,
    pub nocite: Vec<String>,
}

Parameters for the format_document method (schema mirror of FormatDocumentRequest).

Fields

style: StyleInput

Style identifier, path, URI, or inline YAML.

style_overrides: Option<String>

Optional partial-style overlay (YAML or JSON) merged over the resolved base style for this request only. Uses the same null-aware, typed-merge semantics as extends inheritance. The base style is never mutated.

locale: Option<String>

Optional BCP 47 locale override.

output_format: Option<OutputFormat>

Output format (plain, html, djot, latex, typst). Defaults to plain.

refs: Value

Bibliography input as RefsInput: path (YAML/JSON/CBOR or .bib), inline YAML, inline JSON, inline BibLaTeX ({"kind":"biblatex","value":"@book{…}"}) or legacy bare map.

citations: Value

Ordered citations as they appear in the document.

bibliography_blocks: Vec<BibliographyBlockRequest>

Optional bibliography blocks to render in document order.

document_options: Option<DocumentOptions>

Optional document-level configuration.

nocite: Vec<String>

Reference IDs to include in the bibliography without an in-text citation.

Each ID must be present in refs. Unknown IDs produce a nocite_missing_ref warning and are otherwise ignored.

Trait Implementations

impl Debug for FormatDocumentParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FormatDocumentParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.