org.asciidoctor.maven.site

Class AsciidoctorParser

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.asciidoctor.maven.site.AsciidoctorParser

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.HtmlMarkup, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, org.apache.maven.doxia.module.xhtml.XhtmlMarkup, org.apache.maven.doxia.parser.Parser

@Component(role=org.apache.maven.doxia.parser.Parser.class,
           hint="asciidoc")
public class AsciidoctorParser
extends org.apache.maven.doxia.module.xhtml.XhtmlParser

This class is used by the Doxia framework to handle the actual parsing of the AsciiDoc input files into HTML to be consumed/wrapped by the site generation process.

Author:

jdlee, mojavelinux

Nested Class Summary

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

org.apache.maven.doxia.parser.AbstractXmlParser.CachedFileEntityResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected org.asciidoctor.Asciidoctor	asciidoctor
protected org.apache.maven.project.MavenProject	project
static String	ROLE_HINT The role hint for the AsciidoctorParser 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
AsciidoctorParser()

Method Summary

Modifier and Type	Method and Description
protected String	convertAsciiDoc(String source, org.asciidoctor.OptionsBuilder options)
protected org.codehaus.plexus.util.xml.Xpp3Dom	getSiteConfig(org.apache.maven.project.MavenProject project)
protected org.asciidoctor.AttributesBuilder	initAttributes(org.apache.maven.project.MavenProject project, File siteDirectory)
protected org.asciidoctor.OptionsBuilder	initOptions(org.apache.maven.project.MavenProject project, File siteDirectory)
void	parse(Reader reader, org.apache.maven.doxia.sink.Sink sink)
protected org.asciidoctor.OptionsBuilder	processAsciiDocConfig(org.codehaus.plexus.util.xml.Xpp3Dom siteConfig, org.asciidoctor.OptionsBuilder options, org.asciidoctor.AttributesBuilder attributes)
protected File	resolveSiteDirectory(org.apache.maven.project.MavenProject project, org.codehaus.plexus.util.xml.Xpp3Dom siteConfig)
protected File	resolveTemplateDir(org.apache.maven.project.MavenProject project, String path)

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, 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

project

@Requirement
protected org.apache.maven.project.MavenProject project

ROLE_HINT

public static final String ROLE_HINT

The role hint for the AsciidoctorParser Plexus component.

See Also:

Constant Field Values

asciidoctor

protected final org.asciidoctor.Asciidoctor asciidoctor

Constructor Detail

AsciidoctorParser

public AsciidoctorParser()

Method Detail

parse

public void parse(Reader reader,
                  org.apache.maven.doxia.sink.Sink sink)
           throws org.apache.maven.doxia.parser.ParseException

Specified by:

parse in interface org.apache.maven.doxia.parser.Parser

Overrides:

parse in class org.apache.maven.doxia.parser.XhtmlBaseParser

Throws:

org.apache.maven.doxia.parser.ParseException

getSiteConfig

protected org.codehaus.plexus.util.xml.Xpp3Dom getSiteConfig(org.apache.maven.project.MavenProject project)

resolveSiteDirectory

protected File resolveSiteDirectory(org.apache.maven.project.MavenProject project,
                                    org.codehaus.plexus.util.xml.Xpp3Dom siteConfig)

initOptions

protected org.asciidoctor.OptionsBuilder initOptions(org.apache.maven.project.MavenProject project,
                                                     File siteDirectory)

initAttributes

protected org.asciidoctor.AttributesBuilder initAttributes(org.apache.maven.project.MavenProject project,
                                                           File siteDirectory)

processAsciiDocConfig

protected org.asciidoctor.OptionsBuilder processAsciiDocConfig(org.codehaus.plexus.util.xml.Xpp3Dom siteConfig,
                                                               org.asciidoctor.OptionsBuilder options,
                                                               org.asciidoctor.AttributesBuilder attributes)

convertAsciiDoc

protected String convertAsciiDoc(String source,
                                 org.asciidoctor.OptionsBuilder options)

resolveTemplateDir

protected File resolveTemplateDir(org.apache.maven.project.MavenProject project,
                                  String path)