Package uk.ac.ed.ph.snuggletex

Public API Package - almost all of the classes you will need for normal SnuggleTeX use are contained in here.

See: Description

Interface Summary

Interface	Description
DOMPostProcessor	This interface allows you to hook into the SnuggleTeX process immediately after the raw DOM tree has been built.
ErrorCode	Interface representing a code for an Error caused by client input.
ErrorGroup	Interface representing a grouping for a set of related ErrorCodes.
InputContext	Read-only view of the current document being parsed, which will change shape as user-defined macros and environments are being expanded.
LinkResolver	This interface allows clients to have control over handling any hypertext links encountered in commands like HrefHandler, making it possible to remap links as required.
NumberMatcher	Interface for classes which identify numbers in Math mode input.
SerializationSpecifier	Interface specifying various options for serializing XML produced by SnuggleTeX and some of its utility classes.
SnuggleConstants	Public SnuggleTeX-related constants.

Class Summary

Class	Description
DecimalFormatNumberMatcher	Implementation of NumberMatcher that uses a standard Java DecimalFormat to match numbers.
DOMOutputOptions	This class is used to specify how you want DOM trees to be built when calling relevant methods in SnuggleSession (e.g.
DownConvertingPostProcessor	Trivial implementation of DOMPostProcessor that hooks into the MathMLDownConverter.
InputError	Encapsulates an error in the LaTeX input, providing information about what the error is and where it occurred.
SessionConfiguration	Specifies options for how a SnuggleSession should parse and process SnuggleInputs.
SimpleNumberMatcher	Very basic but fast implementation of NumberMatcher that handles western-style numeric characters, supporting Locale-specific decimal points.
SnuggleEngine	This is the main entry point into SnuggleTeX.
SnuggleInput	Simple container for an input into SnuggleTeX.
SnugglePackage	A SnugglePackage defines a collection of BuiltinCommands, BuiltinEnvironments, and ErrorCodes/ErrorGroups that can be registered with a SnuggleEngine to add in extra functionality.
SnuggleSession	This represents a single "job" for SnuggleTeX.
SnuggleSimpleMathRunner	FIXME: Document this type!
SnuggleSnapshot	A partial result of parsing one or more SnuggleInputs by a SnuggleSession, created via SnuggleSession.createSnapshot().
WebPageOutputOptions	Builds on XMLStringOutputOptions to add in options for configuring how to build a web page using the relevant methods in SnuggleSession (e.g.
WebPageOutputOptionsBuilder	Utility class that creates pre-configured and usable WebPageOutputOptions instances for various common scenarios.
WebPageOutputOptionsTemplates	Deprecated As of SnuggleTeX 1.3.0, use WebPageOutputOptionsBuilder.
XMLStringOutputOptions	Builds on DOMOutputOptions to add in options for configuring how to build an serialized output consisting of an XML (or possibly HTML) String using the relevant methods in SnuggleSession (e.g.

Enum Summary

Enum	Description
DOMOutputOptions.ErrorOutputOptions	Enumerates the various options for representing InputErrors in the resulting DOM.
SerializationMethod	Enumerates the XML serialization methods available.
SnuggleInput.InputType	Enumerates the various types of inputs we support.
SnuggleSession.EndOutputAction	Trivial enumeration which specifies the possible actions to perform once we finish writing with the various SnuggleSession.writeWebPage(WebPageOutputOptions, OutputStream) methods.
WebPageOutputOptions.WebPageType	Deprecated Use WebPageOutputOptionsBuilder to generate different types of web pages.

Exception Summary

Exception	Description
SnuggleLogicException	This RuntimeException is thrown if SnuggleTeX has detected something amiss with its logic.
SnuggleRuntimeException	This RuntimeException is used to indicate a problem within SnuggleTeX which is due to a mis-configuration of SnuggleTeX, rather than a problem with client input or bad logic within SnuggleTeX.

Package uk.ac.ed.ph.snuggletex Description

Public API Package - almost all of the classes you will need for normal SnuggleTeX use are contained in here.