Skip to main content

PostOptions

Struct PostOptions 

Source
pub struct PostOptions<'a> {
Show 26 fields pub pmml: bool, pub cmml: bool, pub keep_xmath: bool, pub stylesheet: Option<&'a str>, pub destination: Option<&'a str>, pub source_directory: Option<&'a str>, pub site_directory: Option<&'a str>, pub search_paths: &'a [String], pub nodefaultresources: bool, pub css_files: &'a [String], pub js_files: &'a [String], pub noinvisibletimes: bool, pub plane1: bool, pub hackplane1: bool, pub mathtex: bool, pub navigationtoc: Option<&'a str>, pub schemadocs: bool, pub split: bool, pub split_xpath: Option<String>, pub split_naming: Option<&'a str>, pub xslt_parameters: &'a [String], pub graphics_svg_threshold_kb: u32, pub graphicimages: bool, pub timestamp: Option<&'a str>, pub icon: Option<&'a str>, pub whatsout: Whatsout,
}
Expand description

Options for the post-processing pipeline.

Fields§

§pmml: bool§cmml: bool§keep_xmath: bool§stylesheet: Option<&'a str>§destination: Option<&'a str>§source_directory: Option<&'a str>

Base directory of the original LaTeX source (--sourcedirectory; Perl Config.pm L147, passed to Post as sourceDirectory in LaTeXML.pm L429). Used to locate graphics/resources the post-phase copies. When None, the caller defaults it to the source file’s own directory.

§site_directory: Option<&'a str>

Root directory of the generated site (--sitedirectory; Perl Config.pm L146, passed to Post as siteDirectory in LaTeXML.pm L430). Establishes the base against which cross-document/resource URLs are made relative. When None, Post defaults it to the destination’s directory (Perl Config.pm L466-469; document.rs mirrors that fallback).

§search_paths: &'a [String]

Extra resource search paths (the --path flag): directories searched for --css/--javascript files (and other post resources) to copy into the destination, in addition to the document’s own paths, the current directory, and the binary’s embedded resource table.

§nodefaultresources: bool§css_files: &'a [String]§js_files: &'a [String]§noinvisibletimes: bool§plane1: bool

Remap styled alphanumerics to Unicode Plane-1 (Perl --plane1, default on).

§hackplane1: bool

Remap only the poorly-supported variants, to their simpler form (Perl --hackplane1); implies plane1.

§mathtex: bool§navigationtoc: Option<&'a str>§schemadocs: bool§split: bool§split_xpath: Option<String>§split_naming: Option<&'a str>§xslt_parameters: &'a [String]§graphics_svg_threshold_kb: u32

If > 0, try the vector-SVG converters (mutool → pdftocairo) for PDF graphics smaller than this many KB (vector-preservation path). Fall back to the raster ImageMagick convert/gs → PNG path on failure or timeout. Tracks upstream brucemiller/LaTeXML#902.

§graphicimages: bool

Convert \includegraphics figures to web images (Perl graphicimages!dographics, default on). When false (--nographicimages) the Graphics post-phase is skipped entirely: the output keeps the raw <ltx:graphics> references untouched — useful for faster runs or hosts without the image tools.

§timestamp: Option<&'a str>

Timestamp string embedded in the generated page (Perl --timestamp, XSLT TIMESTAMP param). None → no timestamp emitted (the deterministic default; Perl instead defaults to the current time). Perl’s --timestamp=0 “omit” case is normalized to None by the caller.

§icon: Option<&'a str>

Favicon resource for the generated site (Perl --icon, XSLT ICON param): emitted as a <link rel="icon"> and copied to the destination.

§whatsout: Whatsout

Output extraction mode (Perl LaTeXML::Util::Pack::whatsout). Document (default) → serialize the full post-processed document; Fragment → embeddable HTML snippet via latexml_post::extract::get_embeddable; Math → math subtree via get_math. Applied to each PostDocument in the final serialization loop.

Auto Trait Implementations§

§

impl<'a> Freeze for PostOptions<'a>

§

impl<'a> RefUnwindSafe for PostOptions<'a>

§

impl<'a> Send for PostOptions<'a>

§

impl<'a> Sync for PostOptions<'a>

§

impl<'a> Unpin for PostOptions<'a>

§

impl<'a> UnsafeUnpin for PostOptions<'a>

§

impl<'a> UnwindSafe for PostOptions<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.