SnuggleTeX 1.3.0 · uk.ac.ed.ph.snuggletex.DOMOutputOptions

Modifier and Type	Class and Description
public static enum	DOMOutputOptions.ErrorOutputOptions Enumerates the various options for representing `InputError`s in the resulting DOM.

Modifier and Type	Field and Description
private boolean	addingMathSourceAnnotations Set to true to annotate MathML elements with the original SnuggleTeX source.
private boolean	applyingFirefox3SemanticsWorkaround Set to true to apply a workaround to the MathML to make it render better in Firefox 3 whenever `addingMathSourceAnnotations` is true.
public static final String	DEFAULT_MATHML_PREFIX Default prefix to use if/when prefixing MathML elements
public static final String	DEFAULT_SNUGGLETEX_XML_PREFIX Default prefix to use if/when prefixing SnuggleTeX XML elements
public static final String	DEFAULT_XHTML_PREFIX Default prefix to use if/when prefixing XHTML elements
private DOMPostProcessor[]	domPostProcessors List of optional `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.
private DOMOutputOptions.ErrorOutputOptions	errorOutputOptions Specifies how errors should be represented in the resulting DOM.
private Properties	inlineCSSProperties If non-null, then the given `Properties` will be used to work out CSS styles.
private boolean	inliningCSS Set to true to inline CSS styling (i.e. uses `style` attributes).
private LinkResolver	linkResolver Optional helper to "resolve" (i.e. munge) any XHTML links found during page creation.
private String	mathMLPrefix Prefix to use when prefixing MathML element names.
private boolean	mathVariantMapping Set to true to perform automatic mappings of (safe) Unicode characters when applying "stylings" like `\\mathcal` and `\\mathbb`.
private boolean	prefixingMathML Set to true if you want MathML element names to be prefixed.
private boolean	prefixingSnuggleXML Set to true if you want any SnuggleTeX-specific XML elements, such as error messages and certain MathML annotations to be prefixed.
private boolean	prefixingXHTML Set to true if you want XHTML element names to be prefixed.
private String	snuggleXMLPrefix Prefix to use when prefixing SnuggleTeX-specific XML element names.
private String	xhtmlPrefix Prefix to use when prefixing XHTML element names.

Access	Constructor and Description
public	DOMOutputOptions()

Method Summary

Modifier and Type	Method and Description
public void	addDOMPostProcessors(DOMPostProcessor... array of `DOMPostProcessor` to append to currently specified `DOMPostProcessor`s, which may be empty. domPostProcessors) Appends to the currently specified `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public DOMPostProcessor[]	getDOMPostProcessors() Returns the array of `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.
public DOMOutputOptions.ErrorOutputOptions	getErrorOutputOptions() Gets the current `ErrorOutputOptions`, specifying how (and whether) error details should be embedded into the resulting XML.
public Properties	getInlineCSSProperties() Gets the `Properties` Object that will be used to determine inline CSS properties, if used.
public LinkResolver	getLinkResolver() Gets the currently specified "link resolver" which can fix up any XHTML links created by certain LaTeX inputs.
public String	getMathMLPrefix() Gets the prefix to use for MathML elements when `isPrefixingMathML()` returns true.
public String	getSnuggleXMLPrefix() Gets the prefix to use for custom SnuggleTeX XML elements when `isPrefixingSnuggleXML()` returns true.
public String	getXHTMLPrefix() Gets the prefix to use for XHTML elements when `isPrefixingXHTML()` returns true.
public boolean	isAddingMathAnnotations() Deprecated Use `isAddingMathSourceAnnotations()` instead
public boolean	isAddingMathSourceAnnotations() Returns whether the MathML `math` elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them.
public boolean	Returns: true if applying the workaround described above when, false otherwise. isApplyingFirefox3SemanticsWorkaround() Returns whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....
public boolean	isInliningCSS() Get whether CSS styling is being inlined via `style` attributes or not.
public boolean	isMathVariantMapping() Returns whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like `\\mathcal` and `\\mathbb`.
public boolean	isPrefixingMathML() Returns whether MathML elements should be prefixed or not.
public boolean	isPrefixingSnuggleXML() Returns whether custom SnuggleTeX XML elements should be prefixed or not.
public boolean	isPrefixingXHTML() Returns whether XHTML elements should be prefixed or not.
public void	setAddingMathAnnotations(boolean addingMathSourceAnnotations) Deprecated Use `setAddingMathSourceAnnotations(boolean)` instead
public void	setAddingMathSourceAnnotations(boolean set true to include source annotations, false otherwise. addingMathSourceAnnotations) Sets whether the MathML `math` elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them.
public void	setApplyingFirefox3SemanticsWorkaround(boolean true to applying the workaround described above when, false otherwise. applyingFirefox3SemanticsWorkaround) Specifies whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....
public void	setDOMPostProcessors(DOMPostProcessor... array of `DOMPostProcessor` to use, which may be empty. domPostProcessors) Sets the array of `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.
public void	setErrorOutputOptions(DOMOutputOptions.ErrorOutputOptions new `ErrorOutputOptions`, which must not be null. errorOutputOptions) Sets the current `ErrorOutputOptions`, specifying how (and whether) error details should be embedded into the resulting XML.
public void	setInlineCSSProperties(Properties Properties file used to determine inline CSS properties, which should be null if you want to use the SnuggleTeX defaults. inlineCSSProperties) Sets the `Properties` Object that will be used to determine inline CSS properties, if used.
public void	setInliningCSS(boolean true to inline CSS, false otherwise inliningCSS) Set whether CSS styling is to be inlined via `style` attributes or not.
public void	setLinkResolver(LinkResolver new `LinkResolver` to use, which may be null to indicate you want links left as-is. linkResolver) Sets the "link resolver" that will be given a chance to fix up any XHTML links created by certain LaTeX inputs.
public void	setMathMLPrefix(String desired prefix, which must be non-null and a valid XML NCName. mathMLPrefix) Sets the prefix to use for MathML elements when `isPrefixingMathML()` returns true.
public void	setMathVariantMapping(boolean set true to perform mappings, false otherwise. mathVariantMapping) Sets whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like `\\mathcal` and `\\mathbb`.
public void	setPrefixingMathML(boolean true to prefix MathML elements, false otherwise. prefixingMathML) Sets whether MathML elements should be prefixed or not.
public void	setPrefixingSnuggleXML(boolean true to prefix custom SnuggleTeX XML elements, false otherwise. prefixingSnuggleXML) Sets whether custom SnuggleTeX XML elements should be prefixed or not.
public void	setPrefixingXHTML(boolean true to prefix XHTML elements, false otherwise. prefixingXHTML) Sets whether XHTML elements should be prefixed or not.
public void	setSnuggleXMLPrefix(String desired prefix, which must be non-null and a valid XML NCName. snuggleXMLPrefix) Sets the prefix to use for custom SnuggleTeX XML elements when `isPrefixingSnuggleXML()` returns true.
public void	setXHTMLPrefix(String desired prefix, which must be non-null and a valid XML NCName. xhtmlPrefix) Sets the prefix to use for XHTML elements when `isPrefixingXHTML()` returns true.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

addingMathSourceAnnotations	back to summary
private boolean addingMathSourceAnnotations Set to true to annotate MathML elements with the original SnuggleTeX source.

applyingFirefox3SemanticsWorkaround	back to summary
private boolean applyingFirefox3SemanticsWorkaround Set to true to apply a workaround to the MathML to make it render better in Firefox 3 whenever `addingMathSourceAnnotations` is true.

DEFAULT_MATHML_PREFIX	back to summary
public static final String DEFAULT_MATHML_PREFIX Default prefix to use if/when prefixing MathML elements

DEFAULT_SNUGGLETEX_XML_PREFIX	back to summary
public static final String DEFAULT_SNUGGLETEX_XML_PREFIX Default prefix to use if/when prefixing SnuggleTeX XML elements

DEFAULT_XHTML_PREFIX	back to summary
public static final String DEFAULT_XHTML_PREFIX Default prefix to use if/when prefixing XHTML elements

domPostProcessors back to summary

domPostProcessors	back to summary
private DOMPostProcessor[] domPostProcessors List of optional `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built. One use of this is by registering a `DownConvertingPostProcessor`, which will attempt to "down-convert" simple MathML expressions into (X)HTML equivalents. For example, simple linear expressions and simple sub/superscripts can often be converted to acceptable XHTML alternatives. Any expressions deemed too complex to be down-converted are kept as MathML. The SnuggleTeX Up-Conversion module also includes an "UpConvertingPostProcessor" that may be used here as well. See Also `DownConvertingPostProcessor`

private DOMPostProcessor[] domPostProcessors

List of optional DOMPostProcessor that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.

One use of this is by registering a DownConvertingPostProcessor, which will attempt to "down-convert" simple MathML expressions into (X)HTML equivalents. For example, simple linear expressions and simple sub/superscripts can often be converted to acceptable XHTML alternatives. Any expressions deemed too complex to be down-converted are kept as MathML.

The SnuggleTeX Up-Conversion module also includes an "UpConvertingPostProcessor" that may be used here as well.

See Also: DownConvertingPostProcessor

errorOutputOptions	back to summary
private DOMOutputOptions.ErrorOutputOptions errorOutputOptions Specifies how errors should be represented in the resulting DOM.

inlineCSSProperties	back to summary
private Properties inlineCSSProperties If non-null, then the given `Properties` will be used to work out CSS styles. If null, the default CSS will be used.

inliningCSS	back to summary
private boolean inliningCSS Set to true to inline CSS styling (i.e. uses `style` attributes). This is useful if your output is going to end up embedded in someone else's page or in a system where you have no control over stylesheets.

linkResolver	back to summary
private LinkResolver linkResolver Optional helper to "resolve" (i.e. munge) any XHTML links found during page creation. This may be useful if generating a set of hyperlinked pages.

mathMLPrefix back to summary

mathMLPrefix	back to summary
private String mathMLPrefix Prefix to use when prefixing MathML element names. Only used if `prefixingMathML` is true. Default is `DEFAULT_MATHML_PREFIX` Must be non-null and a valid NCName.

private String mathMLPrefix

Prefix to use when prefixing MathML element names. Only used if prefixingMathML is true.

Default is DEFAULT_MATHML_PREFIX Must be non-null and a valid NCName.

mathVariantMapping back to summary

mathVariantMapping	back to summary
private boolean mathVariantMapping Set to true to perform automatic mappings of (safe) Unicode characters when applying "stylings" like `\\mathcal` and `\\mathbb`. Doing this can help if you don't have control over CSS and if clients may not have appropriate fonts installed as it forces the mapping of certain characters to glyphs that may be available. (Firefox by default does not change fonts for these cases as it is not clear what font to map to so setting this to true can help with some characters.) Todo Revisit how best to do mathvariant with Firefox.

private boolean mathVariantMapping

Set to true to perform automatic mappings of (safe) Unicode characters when applying "stylings" like \\mathcal and \\mathbb. Doing this can help if you don't have control over CSS and if clients may not have appropriate fonts installed as it forces the mapping of certain characters to glyphs that may be available.

(Firefox by default does not change fonts for these cases as it is not clear what font to map to so setting this to true can help with some characters.)

Todo

Revisit how best to do mathvariant with Firefox.

prefixingMathML	back to summary
private boolean prefixingMathML Set to true if you want MathML element names to be prefixed. If false, then the default namespace is changed when entering a MathML element scope. Default is false.

prefixingMathML

back to summary

private boolean prefixingMathML

Set to true if you want MathML element names to be prefixed. If false, then the default namespace is changed when entering a MathML element scope.

Default is false.

prefixingSnuggleXML	back to summary
private boolean prefixingSnuggleXML Set to true if you want any SnuggleTeX-specific XML elements, such as error messages and certain MathML annotations to be prefixed. If false, then the default namespace is changed when entering the scope of these elements. Default is false.

prefixingSnuggleXML

back to summary

private boolean prefixingSnuggleXML

Set to true if you want any SnuggleTeX-specific XML elements, such as error messages and certain MathML annotations to be prefixed.

If false, then the default namespace is changed when entering the scope of these elements.

Default is false.

prefixingXHTML	back to summary
private boolean prefixingXHTML Set to true if you want XHTML element names to be prefixed. If false, then the default namespace is changed when entering an XHTML element scope. Default is false.

prefixingXHTML

back to summary

private boolean prefixingXHTML

Set to true if you want XHTML element names to be prefixed. If false, then the default namespace is changed when entering an XHTML element scope.

Default is false.

snuggleXMLPrefix back to summary

snuggleXMLPrefix	back to summary
private String snuggleXMLPrefix Prefix to use when prefixing SnuggleTeX-specific XML element names. Only used if `prefixingSnuggleXML` is true and ignored if prefix is null. (Note that this currently has no effect on any SnuggleTeX elements generated within MathML elements.) Default is `DEFAULT_SNUGGLETEX_XML_PREFIX`. Must be non-null and a valid NCName.

private String snuggleXMLPrefix

Prefix to use when prefixing SnuggleTeX-specific XML element names. Only used if prefixingSnuggleXML is true and ignored if prefix is null.

(Note that this currently has no effect on any SnuggleTeX elements generated within MathML elements.)

Default is DEFAULT_SNUGGLETEX_XML_PREFIX. Must be non-null and a valid NCName.

xhtmlPrefix back to summary

xhtmlPrefix	back to summary
private String xhtmlPrefix Prefix to use when prefixing XHTML element names. Only used if `prefixingXHTML` is true. Default is `DEFAULT_XHTML_PREFIX` Must be non-null and a valid NCName.

private String xhtmlPrefix

Prefix to use when prefixing XHTML element names. Only used if prefixingXHTML is true.

Default is DEFAULT_XHTML_PREFIX Must be non-null and a valid NCName.

Constructor Detail

DOMOutputOptions	back to summary
public DOMOutputOptions()

Method Detail

addDOMPostProcessors back to summary

addDOMPostProcessors	back to summary
public void addDOMPostProcessors(DOMPostProcessor... domPostProcessors) Appends to the currently specified `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built. Parameters domPostProcessors:DOMPostProcessor[] array of `DOMPostProcessor` to append to currently specified `DOMPostProcessor`s, which may be empty. See Also `DownConvertingPostProcessor`

public void addDOMPostProcessors(DOMPostProcessor... domPostProcessors)

Appends to the currently specified DOMPostProcessor that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.

Parameters

domPostProcessors:DOMPostProcessor[]: array of DOMPostProcessor to append to currently specified DOMPostProcessors, which may be empty.

See Also

DownConvertingPostProcessor

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Annotations @Override

public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Annotations

@Override

getDOMPostProcessors back to summary

getDOMPostProcessors	back to summary
public DOMPostProcessor[] getDOMPostProcessors() Returns the array of `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built. The default is null, which is treated the same as an empty array here. One use of this is by registering a `DownConvertingPostProcessor`, which will attempt to "down-convert" simple MathML expressions into (X)HTML equivalents. For example, simple linear expressions and simple sub/superscripts can often be converted to acceptable XHTML alternatives. Any expressions deemed too complex to be down-converted are kept as MathML. The SnuggleTeX Up-Conversion module also includes an "UpConvertingPostProcessor" that may be used here as well. See Also `DownConvertingPostProcessor`

public DOMPostProcessor[] getDOMPostProcessors()

Returns the array of DOMPostProcessor that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.

The default is null, which is treated the same as an empty array here.

The SnuggleTeX Up-Conversion module also includes an "UpConvertingPostProcessor" that may be used here as well.

See Also: DownConvertingPostProcessor

getErrorOutputOptions	back to summary
public DOMOutputOptions.ErrorOutputOptions getErrorOutputOptions() Gets the current `ErrorOutputOptions`, specifying how (and whether) error details should be embedded into the resulting XML. The default is `ErrorOutputOptions#NO_OUTPUT`.

getInlineCSSProperties	back to summary
public Properties getInlineCSSProperties() Gets the `Properties` Object that will be used to determine inline CSS properties, if used. If null, the default CSS supplied within SnuggleTeX will be used. Default is null.

getLinkResolver	back to summary
public LinkResolver getLinkResolver() Gets the currently specified "link resolver" which can fix up any XHTML links created by certain LaTeX inputs. Default is null, which does nothing.

getMathMLPrefix	back to summary
public String getMathMLPrefix() Gets the prefix to use for MathML elements when `isPrefixingMathML()` returns true. Default is `DEFAULT_MATHML_PREFIX`.

getSnuggleXMLPrefix	back to summary
public String getSnuggleXMLPrefix() Gets the prefix to use for custom SnuggleTeX XML elements when `isPrefixingSnuggleXML()` returns true. Default is `DEFAULT_SNUGGLETEX_XML_PREFIX`.

getXHTMLPrefix	back to summary
public String getXHTMLPrefix() Gets the prefix to use for XHTML elements when `isPrefixingXHTML()` returns true. Default is `DEFAULT_XHTML_PREFIX`.

isAddingMathAnnotations	back to summary
public boolean isAddingMathAnnotations() Deprecated Use `isAddingMathSourceAnnotations()` instead Annotations @Deprecated

isAddingMathSourceAnnotations	back to summary
public boolean isAddingMathSourceAnnotations() Returns whether the MathML `math` elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them. Default is false.

isApplyingFirefox3SemanticsWorkaround back to summary

isApplyingFirefox3SemanticsWorkaround	back to summary
public boolean isApplyingFirefox3SemanticsWorkaround() Returns whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....</mstyle> wrapper when generating annotated MathML when `isAddingMathSourceAnnotations()` returns true. This is a workaround for Bug 468059 which first seemed to appear in Firefox 3 and MathML within semantics elements to effectively ignore any `display="block"` attribute on the enclosing MathML element. This property is ignored if `isAddingMathSourceAnnotations()` returns false. Use this if having annotations and good rendering in Firefox 3 is important to you. Returns:boolean true if applying the workaround described above when, false otherwise. Since 1.2.1

public boolean isApplyingFirefox3SemanticsWorkaround()

Returns whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....</mstyle> wrapper when generating annotated MathML when isAddingMathSourceAnnotations() returns true.

This is a workaround for Bug 468059 which first seemed to appear in Firefox 3 and MathML within semantics elements to effectively ignore any display="block" attribute on the enclosing MathML element.

This property is ignored if isAddingMathSourceAnnotations() returns false.

Use this if having annotations and good rendering in Firefox 3 is important to you.

Returns:boolean: true if applying the workaround described above when, false otherwise.
Since: 1.2.1

isInliningCSS	back to summary
public boolean isInliningCSS() Get whether CSS styling is being inlined via `style` attributes or not. This is useful if your output is going to end up embedded in someone else's page or in a system where you have no control over stylesheets. The default is false.

isMathVariantMapping back to summary

isMathVariantMapping	back to summary
public boolean isMathVariantMapping() Returns whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like `\\mathcal` and `\\mathbb`. Doing this can help if you don't have control over CSS and if clients may not have appropriate fonts installed as it forces the mapping of certain characters to glyphs that may be available. (Firefox by default does not change fonts for these cases as it is not clear what font to map to so setting this to true can help with some characters.) Default is false.

public boolean isMathVariantMapping()

Returns whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like \\mathcal and \\mathbb. Doing this can help if you don't have control over CSS and if clients may not have appropriate fonts installed as it forces the mapping of certain characters to glyphs that may be available.

(Firefox by default does not change fonts for these cases as it is not clear what font to map to so setting this to true can help with some characters.)

Default is false.

isPrefixingMathML	back to summary
public boolean isPrefixingMathML() Returns whether MathML elements should be prefixed or not. Default is false.

isPrefixingSnuggleXML	back to summary
public boolean isPrefixingSnuggleXML() Returns whether custom SnuggleTeX XML elements should be prefixed or not. Default is false.

isPrefixingXHTML	back to summary
public boolean isPrefixingXHTML() Returns whether XHTML elements should be prefixed or not. Default is false.

setAddingMathAnnotations	back to summary
public void setAddingMathAnnotations(boolean addingMathSourceAnnotations) Deprecated Use `setAddingMathSourceAnnotations(boolean)` instead Annotations @Deprecated

setAddingMathSourceAnnotations back to summary

setAddingMathSourceAnnotations	back to summary
public void setAddingMathSourceAnnotations(boolean addingMathSourceAnnotations) Sets whether the MathML `math` elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them. Parameters addingMathSourceAnnotations:boolean set true to include source annotations, false otherwise.

public void setAddingMathSourceAnnotations(boolean addingMathSourceAnnotations)

Sets whether the MathML math elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them.

Parameters

addingMathSourceAnnotations:boolean: set true to include source annotations, false otherwise.

setApplyingFirefox3SemanticsWorkaround back to summary

setApplyingFirefox3SemanticsWorkaround	back to summary
public void setApplyingFirefox3SemanticsWorkaround(boolean applyingFirefox3SemanticsWorkaround) Specifies whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....</mstyle> wrapper when generating annotated MathML when `isAddingMathSourceAnnotations()` returns true. This is a workaround for Bug 468059 which first seemed to appear in Firefox 3 and MathML within semantics elements to effectively ignore any `display="block"` attribute on the enclosing MathML element. This property is ignored if `isAddingMathSourceAnnotations()` returns false. Use this if having annotations and good rendering in Firefox 3 is important to you. Parameters applyingFirefox3SemanticsWorkaround:boolean true to applying the workaround described above when, false otherwise. Since 1.2.1

public void setApplyingFirefox3SemanticsWorkaround(boolean applyingFirefox3SemanticsWorkaround)

Specifies whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....</mstyle> wrapper when generating annotated MathML when isAddingMathSourceAnnotations() returns true.

This property is ignored if isAddingMathSourceAnnotations() returns false.

Use this if having annotations and good rendering in Firefox 3 is important to you.

Parameters

applyingFirefox3SemanticsWorkaround:boolean: true to applying the workaround described above when, false otherwise.

Since

1.2.1

setDOMPostProcessors back to summary

setDOMPostProcessors	back to summary
public void setDOMPostProcessors(DOMPostProcessor... domPostProcessors) Sets the array of `DOMPostProcessor` that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built. One use of this is by registering a `DownConvertingPostProcessor`, which will attempt to "down-convert" simple MathML expressions into (X)HTML equivalents. For example, simple linear expressions and simple sub/superscripts can often be converted to acceptable XHTML alternatives. Any expressions deemed too complex to be down-converted are kept as MathML. The SnuggleTeX Up-Conversion module also includes an "UpConvertingPostProcessor" that may be used here as well. Parameters domPostProcessors:DOMPostProcessor[] array of `DOMPostProcessor` to use, which may be empty. See Also `DownConvertingPostProcessor`

public void setDOMPostProcessors(DOMPostProcessor... domPostProcessors)

Sets the array of DOMPostProcessor that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.

The SnuggleTeX Up-Conversion module also includes an "UpConvertingPostProcessor" that may be used here as well.

Parameters

domPostProcessors:DOMPostProcessor[]: array of DOMPostProcessor to use, which may be empty.

See Also

DownConvertingPostProcessor

setErrorOutputOptions back to summary

setErrorOutputOptions	back to summary
public void setErrorOutputOptions(DOMOutputOptions.ErrorOutputOptions errorOutputOptions) Sets the current `ErrorOutputOptions`, specifying how (and whether) error details should be embedded into the resulting XML. Parameters errorOutputOptions:DOMOutputOptions.ErrorOutputOptions new `ErrorOutputOptions`, which must not be null.

public void setErrorOutputOptions(DOMOutputOptions.ErrorOutputOptions errorOutputOptions)

Sets the current ErrorOutputOptions, specifying how (and whether) error details should be embedded into the resulting XML.

Parameters

errorOutputOptions:DOMOutputOptions.ErrorOutputOptions: new ErrorOutputOptions, which must not be null.

setInlineCSSProperties back to summary

setInlineCSSProperties	back to summary
public void setInlineCSSProperties(Properties inlineCSSProperties) Sets the `Properties` Object that will be used to determine inline CSS properties, if used. If null, the default CSS supplied within SnuggleTeX will be used. Parameters inlineCSSProperties:Properties Properties file used to determine inline CSS properties, which should be null if you want to use the SnuggleTeX defaults.

public void setInlineCSSProperties(Properties inlineCSSProperties)

Sets the Properties Object that will be used to determine inline CSS properties, if used. If null, the default CSS supplied within SnuggleTeX will be used.

Parameters

inlineCSSProperties:Properties: Properties file used to determine inline CSS properties, which should be null if you want to use the SnuggleTeX defaults.

setInliningCSS back to summary

setInliningCSS	back to summary
public void setInliningCSS(boolean inliningCSS) Set whether CSS styling is to be inlined via `style` attributes or not. This is useful if your output is going to end up embedded in someone else's page or in a system where you have no control over stylesheets. Parameters inliningCSS:boolean true to inline CSS, false otherwise

public void setInliningCSS(boolean inliningCSS)

Set whether CSS styling is to be inlined via style attributes or not. This is useful if your output is going to end up embedded in someone else's page or in a system where you have no control over stylesheets.

Parameters

inliningCSS:boolean: true to inline CSS, false otherwise

setLinkResolver back to summary

setLinkResolver	back to summary
public void setLinkResolver(LinkResolver linkResolver) Sets the "link resolver" that will be given a chance to fix up any XHTML links created by certain LaTeX inputs. Parameters linkResolver:LinkResolver new `LinkResolver` to use, which may be null to indicate you want links left as-is.

public void setLinkResolver(LinkResolver linkResolver)

Sets the "link resolver" that will be given a chance to fix up any XHTML links created by certain LaTeX inputs.

Parameters

linkResolver:LinkResolver: new LinkResolver to use, which may be null to indicate you want links left as-is.

setMathMLPrefix back to summary

setMathMLPrefix	back to summary
public void setMathMLPrefix(String mathMLPrefix) Sets the prefix to use for MathML elements when `isPrefixingMathML()` returns true. Parameters mathMLPrefix:String desired prefix, which must be non-null and a valid XML NCName.

public void setMathMLPrefix(String mathMLPrefix)

Sets the prefix to use for MathML elements when isPrefixingMathML() returns true.

Parameters

mathMLPrefix:String: desired prefix, which must be non-null and a valid XML NCName.

setMathVariantMapping back to summary

setMathVariantMapping	back to summary
public void setMathVariantMapping(boolean mathVariantMapping) Sets whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like `\\mathcal` and `\\mathbb`. Doing this can help if you don't have control over CSS and if clients may not have appropriate fonts installed as it forces the mapping of certain characters to glyphs that may be available. (Firefox by default does not change fonts for these cases as it is not clear what font to map to so setting this to true can help with some characters.) Parameters mathVariantMapping:boolean set true to perform mappings, false otherwise.

public void setMathVariantMapping(boolean mathVariantMapping)

Sets whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like \\mathcal and \\mathbb. Doing this can help if you don't have control over CSS and if clients may not have appropriate fonts installed as it forces the mapping of certain characters to glyphs that may be available.

(Firefox by default does not change fonts for these cases as it is not clear what font to map to so setting this to true can help with some characters.)

Parameters

mathVariantMapping:boolean: set true to perform mappings, false otherwise.

setPrefixingMathML	back to summary
public void setPrefixingMathML(boolean prefixingMathML) Sets whether MathML elements should be prefixed or not. Parameters prefixingMathML:boolean true to prefix MathML elements, false otherwise.

setPrefixingMathML

back to summary

public void setPrefixingMathML(boolean prefixingMathML)

Sets whether MathML elements should be prefixed or not.

Parameters

prefixingMathML:boolean: true to prefix MathML elements, false otherwise.

setPrefixingSnuggleXML

back to summary

public void setPrefixingSnuggleXML(boolean prefixingSnuggleXML)

Sets whether custom SnuggleTeX XML elements should be prefixed or not.

Parameters

prefixingSnuggleXML:boolean: true to prefix custom SnuggleTeX XML elements, false otherwise.

setPrefixingXHTML

back to summary

public void setPrefixingXHTML(boolean prefixingXHTML)

Sets whether XHTML elements should be prefixed or not.

Parameters

prefixingXHTML:boolean: true to prefix XHTML elements, false otherwise.

setSnuggleXMLPrefix back to summary

public void setSnuggleXMLPrefix(String snuggleXMLPrefix)

Sets the prefix to use for custom SnuggleTeX XML elements when isPrefixingSnuggleXML() returns true.

Parameters

snuggleXMLPrefix:String: desired prefix, which must be non-null and a valid XML NCName.

setXHTMLPrefix back to summary

public void setXHTMLPrefix(String xhtmlPrefix)

Sets the prefix to use for XHTML elements when isPrefixingXHTML() returns true.

Parameters

xhtmlPrefix:String: desired prefix, which must be non-null and a valid XML NCName.

Modifier and Type	Field and Description
public static final DOMOutputOptions.ErrorOutputOptions	NO_OUTPUT No error information is appended to the DOM.
public static final DOMOutputOptions.ErrorOutputOptions	XHTML Each error is marked up as an XHTML `div` element associated to the `error` CSS class.
public static final DOMOutputOptions.ErrorOutputOptions	XML_FULL Full error information is appended to the DOM as a text XML element containing the error code (as an attribute) plus full textual information of the error's location.
public static final DOMOutputOptions.ErrorOutputOptions	XML_SHORT Basic error information is appended to the DOM as an empty XML element containing just the error code.

Modifier and Type	Method and Description
public static DOMOutputOptions.ErrorOutputOptions	valueOf(String name)
public static DOMOutputOptions.ErrorOutputOptions[]	values()

public Class DOMOutputOptions

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum DOMOutputOptions.ErrorOutputOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail