org.apache.maven.doxia.module.markdown

Class MarkdownParser

java.lang.Object

org.apache.maven.doxia.parser.AbstractParser

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

All Implemented Interfaces:

LogEnabled, Parser

@Component(role=Parser.class,
           hint="markdown")
public class MarkdownParser
extends AbstractParser

Implementation of Parser for Markdown documents.

Defers effective parsing to the PegDown library, which generates HTML content then delegates parsing of this content to a slightly modified Doxia Xhtml parser.

Since:

1.3

See Also:

MarkdownToDoxiaHtmlSerializer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarkdownParser.PegDownHtmlParser Internal parser for HTML generated by PegDown library.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	MULTI_MARKDOWN_METADATA_ENTRY Regex that captures the key and value of a multimarkdown-style metadata entry.
private static java.lang.String	MULTI_MARKDOWN_METADATA_SECTION Regex that identifies a multimarkdown-style metadata section at the start of the document
private MarkdownParser.PegDownHtmlParser	parser
protected static org.pegdown.PegDownProcessor	PEGDOWN_PROCESSOR The PegDownProcessor used to convert Pegdown documents to HTML.
static java.lang.String	ROLE_HINT The role hint for the MarkdownParser Plexus component.
private static java.lang.String[]	STANDARD_METADATA_KEYS In order to ensure that we have minimal risk of false positives when slurping metadata sections, the first key in the metadata section must be one of these standard keys or else the entire metadata section is ignored.

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

Modifier and Type	Method and Description
int	getType() The parser type value could be Parser.UNKNOWN_TYPE, Parser.TXT_TYPE or Parser.XML_TYPE.
static boolean	isHtmlComment(org.pegdown.ast.Node node)
static java.lang.String	nodeText(org.pegdown.ast.Node node)
void	parse(java.io.Reader source, Sink sink) Parses the given source model and emits Doxia events into the given sink.
private java.lang.String	toHtml(java.io.Reader source) uses PegDown library to parse content and generate HTML output.

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

doxiaVersion, enableLogging, executeMacro, getBasedir, getLog, getMacroManager, init, isEmitComments, isSecondParsing, parse, parse, setEmitComments, 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 java.lang.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.

MULTI_MARKDOWN_METADATA_SECTION

private static final java.lang.String MULTI_MARKDOWN_METADATA_SECTION

Regex that identifies a multimarkdown-style metadata section at the start of the document

See Also:

Constant Field Values

MULTI_MARKDOWN_METADATA_ENTRY

private static final java.lang.String MULTI_MARKDOWN_METADATA_ENTRY

Regex that captures the key and value of a multimarkdown-style metadata entry.

See Also:

Constant Field Values

STANDARD_METADATA_KEYS

private static final java.lang.String[] STANDARD_METADATA_KEYS

In order to ensure that we have minimal risk of false positives when slurping metadata sections, the first key in the metadata section must be one of these standard keys or else the entire metadata section is ignored.

parser

@Requirement
private MarkdownParser.PegDownHtmlParser parser

Constructor Detail

MarkdownParser

public MarkdownParser()

Method Detail

getType

public int getType()

Description copied from class: AbstractParser

The parser type value could be Parser.UNKNOWN_TYPE, Parser.TXT_TYPE or Parser.XML_TYPE.

Specified by:

getType in interface Parser

Overrides:

getType in class AbstractParser

Returns:

the type of Parser

parse

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

Description copied from interface: Parser

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

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.

toHtml

private java.lang.String toHtml(java.io.Reader source)
                         throws java.io.IOException

uses PegDown library to parse content and generate HTML output.

Parameters:

source - the Markdown source

Returns:

HTML content generated by PegDown

Throws:

java.io.IOException

See Also:

MarkdownToDoxiaHtmlSerializer

isHtmlComment

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

nodeText

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