org.apache.maven.doxia.module.markdown

Class MarkdownParser

java.lang.Object

org.apache.maven.doxia.parser.AbstractParser

org.apache.maven.doxia.parser.AbstractXmlParser

org.apache.maven.doxia.parser.XhtmlBaseParser

org.apache.maven.doxia.module.xhtml.XhtmlParser

org.apache.maven.doxia.module.markdown.MarkdownParser

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, HtmlMarkup, Markup, XmlMarkup, XhtmlMarkup, Parser

@Component(role=org.apache.maven.doxia.parser.Parser.class,
           hint="markdown")
public class MarkdownParser
extends XhtmlParser

Implementation of Parser for Markdown documents.

Defers parsing to the PegDown library.

Since:

1.3

Author:

Julien Nicoulaud

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.maven.doxia.parser.AbstractXmlParser

AbstractXmlParser.CachedFileEntityResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.pegdown.PegDownProcessor	PEGDOWN_PROCESSOR The PegDownProcessor used to convert Pegdown documents to HTML.
static String	ROLE_HINT The role hint for the MarkdownParser Plexus component.

Fields inherited from interface org.apache.maven.doxia.module.xhtml.XhtmlMarkup

XHTML_NAMESPACE, XHTML_TRANSITIONAL_PUBLIC_ID, XHTML_TRANSITIONAL_SYSTEM_ID

Fields inherited from interface org.apache.maven.doxia.markup.HtmlMarkup

A, ABBR, ACRONYM, ADDRESS, APPLET, AREA, B, BASE, BASEFONT, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, DD, DEL, DFN, DIR, DIV, DL, DT, EM, ENTITY_TYPE, FIELDSET, FONT, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, LABEL, LEGEND, LI, LINK, MAP, MENU, META, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, P, PARAM, PRE, Q, S, SAMP, SCRIPT, SELECT, SMALL, SPAN, STRIKE, STRONG, STYLE, SUB, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TITLE, TR, TT, U, UL, VAR

Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup

BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

Fields inherited from interface org.apache.maven.doxia.markup.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 org.apache.maven.doxia.parser.Parser

ROLE, TXT_TYPE, UNKNOWN_TYPE, XML_TYPE

Constructor Summary

Constructors

Constructor and Description
MarkdownParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	baseEndTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)
protected boolean	baseStartTag(org.codehaus.plexus.util.xml.pull.XmlPullParser parser, Sink sink)
static boolean	isHtmlComment(org.pegdown.ast.Node node)
static String	nodeText(org.pegdown.ast.Node node)
void	parse(Reader source, Sink sink)

Methods inherited from class org.apache.maven.doxia.module.xhtml.XhtmlParser

handleEndTag, handleStartTag, init

Methods inherited from class org.apache.maven.doxia.parser.XhtmlBaseParser

consecutiveSections, getSectionLevel, handleCdsect, handleComment, handleText, initXmlParser, isScriptBlock, isVerbatim, setSectionLevel, validAnchor, verbatim_, verbatim

Methods inherited from class org.apache.maven.doxia.parser.AbstractXmlParser

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

Methods inherited from class org.apache.maven.doxia.parser.AbstractParser

doxiaVersion, enableLogging, executeMacro, getBasedir, getLog, getMacroManager, isSecondParsing, setSecondParsing

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_HINT

public static final String ROLE_HINT

The role hint for the MarkdownParser Plexus component.

See Also:

Constant Field Values

PEGDOWN_PROCESSOR

protected static final org.pegdown.PegDownProcessor PEGDOWN_PROCESSOR

The PegDownProcessor used to convert Pegdown documents to HTML.

Constructor Detail

MarkdownParser

public MarkdownParser()

Method Detail

parse

public void parse(Reader source,
         Sink sink)
           throws ParseException

Specified by:

parse in interface Parser

Overrides:

parse in class XhtmlBaseParser

Throws:

ParseException

isHtmlComment

public static boolean isHtmlComment(org.pegdown.ast.Node node)

nodeText

public static String nodeText(org.pegdown.ast.Node node)

baseEndTag

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

Overrides:

baseEndTag in class XhtmlBaseParser

baseStartTag

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

Overrides:

baseStartTag in class XhtmlBaseParser