OutputFormat

Enum OutputFormat 

Source
pub enum OutputFormat {
    HtmlAndMathml,
    Html,
    Mathml,
}
Expand description

Output format options for KaTeX mathematical expression rendering.

This enum specifies the format of the rendered output, controlling whether KaTeX generates HTML, MathML, or both. The choice affects browser compatibility, accessibility, and styling capabilities.

§LaTeX/KaTeX Context

Different output formats serve different purposes in mathematical publishing:

  • HTML provides broad browser support and styling flexibility
  • MathML offers semantic markup and screen reader accessibility
  • Combined output balances compatibility with advanced features

§Cross-references

  • See Settings::output for configuring the output format.
  • Related to browser compatibility and accessibility requirements.
  • Affects CSS styling and semantic markup generation.

Variants§

§

HtmlAndMathml

Generate both HTML and MathML markup.

This is the default format, providing the best balance of compatibility, accessibility, and styling. HTML is used for visual rendering, while MathML provides semantic information for screen readers and other tools.

§

Html

Generate HTML markup only.

Produces clean HTML output with CSS styling. Best for web pages where MathML support is not required or desired. More predictable rendering across different browsers.

§

Mathml

Generate MathML markup only.

Produces semantic MathML output optimized for accessibility and mathematical software. Best for applications requiring precise mathematical semantics over visual presentation.

Trait Implementations§

Source§

impl Clone for OutputFormat

Source§

fn clone(&self) -> OutputFormat

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OutputFormat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for OutputFormat

Source§

fn eq(&self, other: &OutputFormat) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for OutputFormat

Source§

impl Eq for OutputFormat

Source§

impl StructuralPartialEq for OutputFormat

Auto Trait Implementations§

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.