uk.ac.ed.ph.snuggletex.utilities

Class SnuggleUtilities

java.lang.Object

uk.ac.ed.ph.snuggletex.utilities.SnuggleUtilities

public final class SnuggleUtilities
extends Object

A collection of occasionally useful SnuggleTeX-related utility methods, as well as some more general LaTeX stuff.

Version:

$Revision$

Author:

David McKain

Constructor Summary

Constructors

Constructor and Description
SnuggleUtilities()

Method Summary

Modifier and Type	Method and Description
static String	extractSnuggleTeXAnnotation(Element mathmlElement) Extracts a SnuggleTeX annotation from a MathML math element, if found.
static String	quoteTextForInput(String text) Quotes the given (ASCII) String so that it could be safely input in TEXT Mode in LaTeX input.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnuggleUtilities

public SnuggleUtilities()

Method Detail

quoteTextForInput

public static String quoteTextForInput(String text)

Quotes the given (ASCII) String so that it could be safely input in TEXT Mode in LaTeX input.

Parameters:

text - text to quote, assumed to be ASCII.

Returns:

quoted text suitable for being input into LaTeX.

extractSnuggleTeXAnnotation

public static String extractSnuggleTeXAnnotation(Element mathmlElement)

Extracts a SnuggleTeX annotation from a MathML math element, if found. This allows you to extract the input LaTeX from a MathML element created by SnuggleTeX, provided that DOMOutputOptions.isAddingMathSourceAnnotations() returned true when the element was generated.

Parameters:

mathmlElement -

Returns:

SnuggleTeX encoding, or null if not present.