Uses of Package
uk.ac.ed.ph.snuggletex

Packages that use uk.ac.ed.ph.snuggletex

Package	Description
uk.ac.ed.ph.snuggletex	Public API Package - almost all of the classes you will need for normal SnuggleTeX use are contained in here.
uk.ac.ed.ph.snuggletex.definitions	Defines built-in commands, environments, accent maps, globals and related concepts.
uk.ac.ed.ph.snuggletex.internal	This package contains the guts of SnuggleTeX; classes here are responsible for the parsing process, token fixing and DOM/web building.
uk.ac.ed.ph.snuggletex.internal.util
uk.ac.ed.ph.snuggletex.tokens	Internal package defining the various types of LaTeX tokens produced by the parsing process.
uk.ac.ed.ph.snuggletex.utilities	Public utility classes, plus some more general but occasionally useful helpers for dealing with LaTeX.

Classes in uk.ac.ed.ph.snuggletex used by uk.ac.ed.ph.snuggletex

Class and Description
DOMOutputOptions This class is used to specify how you want DOM trees to be built when calling relevant methods in SnuggleSession (e.g.
DOMOutputOptions.ErrorOutputOptions Enumerates the various options for representing InputErrors in the resulting DOM.
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.
InputError Encapsulates an error in the LaTeX input, providing information about what the error is and where it occurred.
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.
SerializationMethod Enumerates the XML serialization methods available.
SerializationSpecifier Interface specifying various options for serializing XML produced by SnuggleTeX and some of its utility classes.
SessionConfiguration Specifies options for how a SnuggleSession should parse and process SnuggleInputs.
SnuggleInput Simple container for an input into SnuggleTeX.
SnuggleInput.InputType Enumerates the various types of inputs we support.
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.
SnuggleSession.EndOutputAction Trivial enumeration which specifies the possible actions to perform once we finish writing with the various SnuggleSession.writeWebPage(WebPageOutputOptions, OutputStream) methods.
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.
WebPageOutputOptions.WebPageType Deprecated. Use WebPageOutputOptionsBuilder to generate different types of web pages. More properties have been added to this class to control some of the finer aspects of this.
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.

Classes in uk.ac.ed.ph.snuggletex used by uk.ac.ed.ph.snuggletex.definitions

Class and Description
ErrorCode Interface representing a code for an Error caused by client input.
ErrorGroup Interface representing a grouping for a set of related ErrorCodes.
SnugglePackage A SnugglePackage defines a collection of BuiltinCommands, BuiltinEnvironments, and ErrorCodes/ErrorGroups that can be registered with a SnuggleEngine to add in extra functionality.

Classes in uk.ac.ed.ph.snuggletex used by uk.ac.ed.ph.snuggletex.internal

Class and Description
DOMOutputOptions This class is used to specify how you want DOM trees to be built when calling relevant methods in SnuggleSession (e.g.
ErrorCode Interface representing a code for an Error caused by client input.
InputContext Read-only view of the current document being parsed, which will change shape as user-defined macros and environments are being expanded.
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.
SnuggleInput Simple container for an input into SnuggleTeX.
SnuggleSession.EndOutputAction Trivial enumeration which specifies the possible actions to perform once we finish writing with the various SnuggleSession.writeWebPage(WebPageOutputOptions, OutputStream) methods.
WebPageOutputOptions Builds on XMLStringOutputOptions to add in options for configuring how to build a web page using the relevant methods in SnuggleSession (e.g.

Classes in uk.ac.ed.ph.snuggletex used by uk.ac.ed.ph.snuggletex.internal.util

Class and Description
SerializationSpecifier Interface specifying various options for serializing XML produced by SnuggleTeX and some of its utility classes.

Classes in uk.ac.ed.ph.snuggletex used by uk.ac.ed.ph.snuggletex.tokens

Class and Description
InputError Encapsulates an error in the LaTeX input, providing information about what the error is and where it occurred.

Classes in uk.ac.ed.ph.snuggletex used by uk.ac.ed.ph.snuggletex.utilities

Class and Description
DOMOutputOptions This class is used to specify how you want DOM trees to be built when calling relevant methods in SnuggleSession (e.g.
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.
InputError Encapsulates an error in the LaTeX input, providing information about what the error is and where it occurred.
SerializationMethod Enumerates the XML serialization methods available.
SerializationSpecifier Interface specifying various options for serializing XML produced by SnuggleTeX and some of its utility classes.