Class Xhtml1BaseParser

java.lang.Object

org.apache.maven.doxia.parser.AbstractParser

org.apache.maven.doxia.parser.AbstractXmlParser

org.apache.maven.doxia.parser.Xhtml5BaseParser

org.apache.maven.doxia.parser.Xhtml1BaseParser

All Implemented Interfaces:

MacroExecutor, HtmlMarkup, Markup, XmlMarkup, Parser

Direct Known Subclasses:

XdocParser

public class Xhtml1BaseParser
extends Xhtml5BaseParser

Acts as bridge between legacy parsers relying on XHTML 1.0 Transitional (based on HTML4) and the Xhtml5BaseParser only supporting (X)HTML5 elements/attributes. Adds support for elements/attributes which became obsolete in HTML5 but are commonly used for XDoc/FML.

See Also:

• HTML5 Differences from HTML4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	Xhtml1BaseParser.AttributeMapping

Nested classes/interfaces inherited from class AbstractXmlParser

AbstractXmlParser.CachedFileEntityResolver

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<String, Collection<Xhtml1BaseParser.AttributeMapping>>	ATTRIBUTE_MAPPING_TABLE	All obsolete attributes in a map with key = affected element name, value = collection if Xhtml1BaseParser.AttributeMappings
private static final Map<String,String>	ELEMENT_MAPPING_TABLE	All obsolete elements in a map with key = obsolete element name, value = non-obsolete replacement element name

Fields inherited from class Xhtml5BaseParser

hasDefinitionListItem, isBeginningOfLineInsideBlock

Fields inherited from interface HtmlMarkup

A, ABBR, ADDRESS, AREA, ARTICLE, ASIDE, AUDIO, B, BASE, BDI, BDO, BLOCKQUOTE, BODY, BR, BUTTON, CANVAS, CAPTION, CDATA_TYPE, CITE, CODE, COL, COLGROUP, COMMAND, DATA, DATALIST, DD, DEL, DETAILS, DFN, DIALOG, DIV, DL, DT, EM, EMBED, ENTITY_TYPE, FIELDSET, FIGCAPTION, FIGURE, FOOTER, FORM, H1, H2, H3, H4, H5, H6, HEAD, HEADER, HGROUP, HR, HTML, I, IFRAME, IMG, INPUT, INS, KBD, KEYGEN, LABEL, LEGEND, LI, LINK, MAIN, MAP, MARK, MENU, MENUITEM, META, METER, NAV, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, OUTPUT, P, PARAM, PICTURE, PRE, PROGRESS, Q, RB, RP, RT, RTC, RUBY, S, SAMP, SCRIPT, SECTION, SELECT, SMALL, SOURCE, SPAN, STRONG, STYLE, SUB, SUMMARY, SUP, SVG, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEMPLATE, TEXTAREA, TFOOT, TH, THEAD, TIME, TITLE, TR, TRACK, U, UL, VAR, VIDEO, WBR

Fields inherited from interface Markup

COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR

Fields inherited from interface Parser

TXT_TYPE, UNKNOWN_TYPE, XML_TYPE

Fields inherited from interface XmlMarkup

BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

Constructor Summary

Constructors

Constructor	Description
Xhtml1BaseParser()

Method Summary

Modifier and Type	Method	Description
protected boolean	baseEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Goes through a common list of possible html end tags.
protected boolean	baseStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)	Translates obsolete XHTML 1.0 attributes/elements to valid XHTML5 ones before calling the underlying Xhtml5BaseParser.
(package private) static final String	mapAlignToStyle(String alignValue)

Methods inherited from class Xhtml5BaseParser

baseEndTag, baseStartTag, consecutiveSections, emitHeadingSections, getSectionLevel, handleCdsect, handleComment, handleEndTag, handleStartTag, handleText, init, initXmlParser, isScriptBlock, isVerbatim, parse, processInsignificantLineBreaks, setSectionLevel, validAnchor, verbatim, verbatim_

Methods inherited from class AbstractXmlParser

getAddDefaultEntities, getAttributesFromParser, getLocalEntities, getText, getType, handleEntity, handleUnknown, handleUnknown, isCollapsibleWhitespace, isIgnorableWhitespace, isTrimmableWhitespace, isValidate, setAddDefaultEntities, setCollapsibleWhitespace, setIgnorableWhitespace, setTrimmableWhitespace, setValidate

Methods inherited from class AbstractParser

addSinkWrapperFactory, doxiaVersion, executeMacro, getBasedir, getMacroManager, getSinkWrapperFactories, getWrappedSink, isEmitAnchorsForIndexableEntries, isEmitComments, isSecondParsing, parse, parse, parse, setEmitAnchorsForIndexableEntries, setEmitComments, setMacroExecutor, setSecondParsing

Methods inherited from class Object

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

Field Details

ATTRIBUTE_MAPPING_TABLE

private static final Map<String, Collection<Xhtml1BaseParser.AttributeMapping>> ATTRIBUTE_MAPPING_TABLE

All obsolete attributes in a map with key = affected element name, value = collection if Xhtml1BaseParser.AttributeMappings

ELEMENT_MAPPING_TABLE

private static final Map<String,String> ELEMENT_MAPPING_TABLE

All obsolete elements in a map with key = obsolete element name, value = non-obsolete replacement element name

Constructor Details

Xhtml1BaseParser

public Xhtml1BaseParser()

Method Details

mapAlignToStyle

static final String mapAlignToStyle(String alignValue)

baseStartTag

protected boolean baseStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 Sink sink)

Translates obsolete XHTML 1.0 attributes/elements to valid XHTML5 ones before calling the underlying Xhtml5BaseParser.

Overrides:

baseStartTag in class Xhtml5BaseParser

Parameters:

parser - A parser.

sink - the sink to receive the events.

Returns:

True if the event has been handled by this method, i.e. the tag was recognized, false otherwise.

baseEndTag

protected boolean baseEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser,
 Sink sink)

Description copied from class: Xhtml5BaseParser

Goes through a common list of possible html end tags. These should be re-usable by different xhtml-based parsers. The tags handled here are the same as for Xhtml5BaseParser.baseStartTag(XmlPullParser,Sink), except for the empty elements (<br/>, <hr/>, <img/>).

Overrides:

baseEndTag in class Xhtml5BaseParser

Parameters:

parser - A parser.

sink - the sink to receive the events.

Returns:

True if the event has been handled by this method, false otherwise.