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:

LogEnabled, HtmlMarkup, Markup, XmlMarkup, XhtmlMarkup, Parser

public class MarkdownParser
extends XhtmlParser

Implementation of Parser for Markdown documents.

Defers parsing to the PegDown library.

Since:

1.3

Author:

Julien Nicoulaud

Plexus component:

role:

"org.apache.maven.doxia.parser.Parser"

role-hint:

"markdown"

Nested Class Summary

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

AbstractXmlParser.CachedFileEntityResolver

Field Summary

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

MarkdownParser()

Method Summary

void	parse(Reader source, Sink sink) Parses the given source model and emits Doxia events into the given 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

baseEndTag, baseStartTag, consecutiveSections, getSectionLevel, handleCdsect, handleComment, handleText, 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

Parses the given source model and emits Doxia events into the given sink.

Specified by:

parse in interface Parser

Overrides:

parse in class XhtmlBaseParser

Parameters:

source - not null reader that provides the source document. You could use newReader methods from ReaderFactory.

sink - A sink that consumes the Doxia events.

Throws:

ParseException - if the model could not be parsed.