Struct MathCoreConfig 

pub struct MathCoreConfig {
    pub pretty_print: PrettyPrint,
    pub xml_namespace: bool,
    pub ignore_unknown_commands: bool,
    pub annotation: bool,
    pub allow_unreliable_rendering: bool,
    pub global_group: bool,
    pub unicode_substitution: UnicodeSubstitution,
    pub css_classes: CssClassNames,
    pub indentation: Indentation,
    pub max_expansions: MaxExpansions,
    pub id_prefix: String,
    pub tags: TaggingStrategy,
}

Configuration object for the LaTeX to MathML conversion.

Example usage

use math_core::{MathCoreConfig, PrettyPrint};

// Default values
let config = MathCoreConfig::default();

// Specifying pretty-print behavior and enabling annotations
let config = MathCoreConfig {
    pretty_print: PrettyPrint::Always,
    annotation: true,
    ..Default::default()
 };

Fields

pretty_print: PrettyPrint

A configuration for pretty-printing the MathML output. See PrettyPrint for details.

xml_namespace: bool

If true, include xmlns="http://www.w3.org/1998/Math/MathML" in the <math> tag.

ignore_unknown_commands: bool

If true, unknown commands will be rendered as red text in the output, instead of returning an error.

annotation: bool

If true, wrap the MathML output in <semantics> tags with an <annotation encoding="application/x-tex"> child containing the original LaTeX source.

allow_unreliable_rendering: bool

If true, allow rendering commands that produce MathML Core output that is unreliably rendered by browsers.

global_group: bool

If true, run the conversion in the global group, which means that commands defined at the top level of a snippet with \newcommand (and related commands) stay defined for the snippets which come after it.

If false (the default), such definitions are local to the snippet which contains them. This matches LaTeX, where constructs like \begin{equation} and $$ open a local group, and it matches the default behavior of KaTeX.

unicode_substitution: UnicodeSubstitution

If not UnicodeSubstitution::Never, substitute certain LaTeX commands with their Unicode equivalents in the MathML output.

css_classes: CssClassNames

CSS class names for various elements in the output.

indentation: Indentation

The indentation unit used when pretty-printing the MathML output. Either a number of spaces (e.g. 2) or the string "tab" for a tab character. See Indentation.

max_expansions: MaxExpansions

How many custom commands may be expanded in one snippet before the conversion gives up. See MaxExpansions.

id_prefix: String

Add this string to the start of every generated id attribute. This is not URL escaped. Use the percent-encoding crate if you need to.

tags: TaggingStrategy

The strategy used for numbering equations. See TaggingStrategy.

Trait Implementations

impl Clone for MathCoreConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MathCoreConfig

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

Formats the value using the given formatter.

impl Default for MathCoreConfig

fn default() -> Self

Returns the “default value” for a type.