uk.ac.ed.ph.snuggletex

Enum WebPageOutputOptions.WebPageType

java.lang.Object

java.lang.Enum<WebPageOutputOptions.WebPageType>

uk.ac.ed.ph.snuggletex.WebPageOutputOptions.WebPageType

All Implemented Interfaces:

Serializable, Comparable<WebPageOutputOptions.WebPageType>

Enclosing class:

WebPageOutputOptions

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.

@Deprecated
public static enum WebPageOutputOptions.WebPageType
extends Enum<WebPageOutputOptions.WebPageType>

Enumerates the different web page "types" supported. This is used to tweak certain parts of the page generation process. You should avoid setting this explicitly unless you know what you're doing - use WebPageOutputOptionsBuilder instead.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIENT_SIDE_XSLT_STYLESHEET Deprecated. Use WebPageOutputOptionsBuilder.createUniversalStylesheetOptions(String) if you really need this, otherwise consider some of the MathJax outputs for better cross-browser impact.
CROSS_BROWSER_XHTML Deprecated. Use WebPageOutputOptionsBuilder.createLegacyCrossBrowserOptions() if you really need this, otherwise consider some of the MathJax outputs for better cross-browser impact.
MATHPLAYER_HTML Deprecated. See WebPageOutputOptionsBuilder.createIEMathPlayerSpecificOptions() if you really need this, otherwise consider some of the MathJax outputs for better cross-browser impact.
MOZILLA Deprecated. Use WebPageOutputOptionsBuilder.createMozillaSpecificOptions() if you really need this, otherwise consider some of the MathJax outputs for better cross-browser impact.
PROCESSED_HTML Deprecated. Use WebPageOutputOptionsBuilder.createHTML4Options()
UNIVERSAL_STYLESHEET Deprecated. Use WebPageOutputOptionsBuilder.createUniversalStylesheetOptions(String) if you really need this, otherwise consider some of the MathJax outputs for better cross-browser impact.

Method Summary

Modifier and Type	Method and Description
static WebPageOutputOptions.WebPageType	valueOf(String name) Deprecated. Returns the enum constant of this type with the specified name.
static WebPageOutputOptions.WebPageType[]	values() Deprecated. Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MOZILLA

@Deprecated
public static final WebPageOutputOptions.WebPageType MOZILLA

Deprecated. Use WebPageOutputOptionsBuilder.createMozillaSpecificOptions() if you really need this, otherwise consider some of the MathJax outputs for better cross-browser impact.

Mozilla-compatible output. XHTML + MathML; no XML declaration; no DOCTYPE.

This is intended to be served as application/xhtml+xml with encoding declared via HTTP header and meta element.

This is the best option for serving content exclusively on Mozilla-based browsers.

This will display as an XML tree on IE, which is not useful.

CROSS_BROWSER_XHTML

@Deprecated
public static final WebPageOutputOptions.WebPageType CROSS_BROWSER_XHTML

Deprecated. Use WebPageOutputOptionsBuilder.createLegacyCrossBrowserOptions() if you really need this, otherwise consider some of the MathJax outputs for better cross-browser impact.

"Cross-browser" XHTML + MathML; has XML declaration and DOCTYPE declaration consisting of the Public identifier defined in W3CConstants.XHTML_11_MATHML_20_PUBLIC_IDENTIFIER and System identifier defined in W3CConstants.XHTML_11_MATHML_20_SYSTEM_IDENTIFIER. The charset is declared only in the meta element in order to appease MathPlayer.

Intended to be served as application/xhtml+xml

Works on both Mozilla and IE6/7 (provided MathPlayer has been installed). This will display wrongly on IE6/7 if MathPlayer is not installed.

The main issue with this is that IE will want to download the relevant DTD, which hinders performance slightly.

MATHPLAYER_HTML

@Deprecated
public static final WebPageOutputOptions.WebPageType MATHPLAYER_HTML

Deprecated. See WebPageOutputOptionsBuilder.createIEMathPlayerSpecificOptions() if you really need this, otherwise consider some of the MathJax outputs for better cross-browser impact.

HTML + MathML intended for Internet Explorer 6/7 with the MathPlayer plug-in.

Intended to be served as text/html.

This only works on IE clients with the MathPlayer plug-in preinstalled, but is a good option if that's your target audience.

This will display wrongly on IE6/7 if MathPlayer is not installed.

UNIVERSAL_STYLESHEET

@Deprecated
public static final WebPageOutputOptions.WebPageType UNIVERSAL_STYLESHEET

Deprecated. Use WebPageOutputOptionsBuilder.createUniversalStylesheetOptions(String) if you really need this, otherwise consider some of the MathJax outputs for better cross-browser impact.

"Cross-browser" XHTML + MathML suitable for Mozilla and Internet Explorer 6/7. Intended to be used in conjunction with the client-side Universal StyleSheet XSLT to accommodate the two cases, prompting for the download of MathPlayer on IE6/7 if it is not already installed.

Page is created with an XML declaration but no DOCTYPE declaration.

The pref:renderer attribute on the html element will be set to mathplayer-dl.

You MUST also call WebPageOutputOptions.setClientSideXSLTStylesheetURLs(String...) to indicate where the USS is going to be loaded from. This MUST be on a server local to the document you are serving from, because IE enforces a "same origin" policy for loading XSLT stylesheets. If you don't do this, your page will not work on IE.

Notes

The SnuggleTeX source distribution contains a slightly fixed version of the USS that works in IE7 that you can use if you like.

CLIENT_SIDE_XSLT_STYLESHEET

@Deprecated
public static final WebPageOutputOptions.WebPageType CLIENT_SIDE_XSLT_STYLESHEET

Deprecated. Use WebPageOutputOptionsBuilder.createUniversalStylesheetOptions(String) if you really need this, otherwise consider some of the MathJax outputs for better cross-browser impact.

XHTML + MathML containing one or more processing instructions designed to invoke client-side XSLT. No XML declaration and no DOCTYPE.

Intended to be served as application/xhtml+xml.

Combining this with the Universal Math Stylesheet or something similar can give good cross-browser results.

PROCESSED_HTML

@Deprecated
public static final WebPageOutputOptions.WebPageType PROCESSED_HTML

Deprecated. Use WebPageOutputOptionsBuilder.createHTML4Options()

HTML deemed suitable for use by any User Agent.

Intended to be served as text/html.

You will have to use a suitable DOMPostProcessor to convert any MathML islands into other forms. (E.g. replace by an applet, replace by images, ...)

Method Detail

values

public static WebPageOutputOptions.WebPageType[] values()

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WebPageOutputOptions.WebPageType c : WebPageOutputOptions.WebPageType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WebPageOutputOptions.WebPageType valueOf(String name)

Deprecated.

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null