org.asciidoctor.maven

Class AsciidoctorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.asciidoctor.maven.AsciidoctorMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AsciidoctorRefreshMojo, AsciidoctorZipMojo

@Mojo(name="process-asciidoc")
public class AsciidoctorMojo
extends org.apache.maven.plugin.AbstractMojo

Basic maven plugin to render AsciiDoc files using Asciidoctor, a ruby port.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ASCIIDOC_REG_EXP_EXTENSION
protected String	attributeMissing
protected Map<String,Object>	attributes
protected String	attributeUndefined
protected String	backend
protected File	baseDir
protected String	doctype
protected boolean	embedAssets
protected String	eruby
protected List<ExtensionConfiguration>	extensions
protected String	gemPath
protected boolean	headerFooter
protected String	imagesDir
protected File	outputDirectory
protected boolean	preserveDirectories
protected File	projectDirectory
protected boolean	relativeBaseDir
protected List<String>	requires
protected File	rootDir
protected boolean	skip
protected File	sourceDirectory
protected List<String>	sourceDocumentExtensions
protected String	sourceDocumentName
protected String	sourceHighlighter
protected List<Synchronization>	synchronizations
protected File	templateDir
protected String	templateEngine
protected String	title

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AsciidoctorMojo()

Method Summary

Modifier and Type	Method and Description
protected void	ensureOutputExists()
void	execute()
protected org.asciidoctor.Asciidoctor	getAsciidoctorInstance(String gemPath)
String	getAttributeMissing()
Map<String,Object>	getAttributes()
String	getAttributeUndefined()
String	getBackend()
File	getBaseDir()
String	getDoctype()
String	getEruby()
List<ExtensionConfiguration>	getExtensions()
String	getGemPath()
String	getImagesDir()
File	getOutputDirectory()
File	getProjectDirectory()
File	getRootDir()
File	getSourceDirectory()
List<String>	getSourceDocumentExtensions()
String	getSourceDocumentName()
String	getSourceHighlighter()
List<Synchronization>	getSynchronizations()
File	getTemplateDir()
String	getTemplateEngine()
String	getTitle()
boolean	isEmbedAssets()
boolean	isHeaderFooter()
boolean	isSkip()
protected void	logRenderedFile(File f)
protected void	renderFile(org.asciidoctor.Asciidoctor asciidoctor, Map<String,Object> options, File f)
void	setAttributeMissing(String attributeMissing)
void	setAttributes(Map<String,Object> attributes)
protected void	setAttributesOnBuilder(org.asciidoctor.AttributesBuilder attributesBuilder)
void	setAttributeUndefined(String attributeUndefined)
void	setBackend(String backend)
void	setBaseDir(File baseDir)
void	setDoctype(String doctype)
void	setEmbedAssets(boolean embedAssets)
void	setEruby(String eruby)
void	setExtensions(List<ExtensionConfiguration> extensions)
void	setGemPath(String gemPath)
void	setHeaderFooter(boolean headerFooter)
void	setImagesDir(String imagesDir)
protected void	setOptions(org.asciidoctor.OptionsBuilder optionsBuilder)
void	setOutputDirectory(File outputDirectory)
void	setPreserveDirertories(boolean preserveDirertories)
void	setProjectDirectory(File projectDirectory)
void	setRelativeBaseDir(boolean relativeBaseDir)
void	setRootDir(File rootDir)
void	setSkip(boolean skip)
void	setSourceDirectory(File sourceDirectory)
void	setSourceDocumentExtensions(List<String> sourceDocumentExtensions)
void	setSourceDocumentName(String sourceDocumentName)
void	setSourceHighlighter(String sourceHighlighter)
void	setSynchronizations(List<Synchronization> synchronizations)
void	setTemplateDir(File templateDir)
void	setTemplateEngine(String templateEngine)
void	setTitle(String title)
protected void	synchronize(Synchronization synchronization)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

ASCIIDOC_REG_EXP_EXTENSION

protected static final String ASCIIDOC_REG_EXP_EXTENSION

See Also:

Constant Field Values

sourceDirectory

@Parameter(property="asciidoctor.sourceDir",
           defaultValue="${basedir}/src/main/asciidoc",
           required=true)
protected File sourceDirectory

outputDirectory

@Parameter(property="asciidoctor.outputDir",
           defaultValue="${project.build.directory}/generated-docs",
           required=true)
protected File outputDirectory

preserveDirectories

@Parameter(property="asciidoctor.preserveDirectories",
           defaultValue="false",
           required=false)
protected boolean preserveDirectories

relativeBaseDir

@Parameter(property="asciidoctor.relativeBaseDir",
           defaultValue="false",
           required=false)
protected boolean relativeBaseDir

projectDirectory

@Parameter(property="asciidoctor.projectDirectory",
           defaultValue="${basedir}",
           required=false,
           readonly=false)
protected File projectDirectory

rootDir

@Parameter(property="asciidoctor.rootDir",
           defaultValue="${basedir}",
           required=false,
           readonly=false)
protected File rootDir

baseDir

@Parameter(property="asciidoctor.baseDir",
           required=false)
protected File baseDir

skip

@Parameter(property="asciidoctor.skip",
           required=false)
protected boolean skip

gemPath

@Parameter(property="asciidoctor.gemPath",
           defaultValue="",
           required=false)
protected String gemPath

requires

@Parameter(property="asciidoctor.requires")
protected List<String> requires

attributes

@Parameter(property="asciidoctor.attributes",
           required=false)
protected Map<String,Object> attributes

backend

@Parameter(property="asciidoctor.backend",
           defaultValue="docbook",
           required=true)
protected String backend

doctype

@Parameter(property="asciidoctor.doctype",
           required=false)
protected String doctype

eruby

@Parameter(property="asciidoctor.eruby",
           required=false)
protected String eruby

headerFooter

@Parameter(property="asciidoctor.headerFooter",
           required=false)
protected boolean headerFooter

templateDir

@Parameter(property="asciidoctor.templateDir",
           required=false)
protected File templateDir

templateEngine

@Parameter(property="asciidoctor.templateEngine",
           required=false)
protected String templateEngine

imagesDir

@Parameter(property="asciidoctor.imagesDir",
           required=false)
protected String imagesDir

sourceHighlighter

@Parameter(property="asciidoctor.sourceHighlighter",
           required=false)
protected String sourceHighlighter

title

@Parameter(property="asciidoctor.title",
           required=false)
protected String title

sourceDocumentName

@Parameter(property="asciidoctor.sourceDocumentName",
           required=false)
protected String sourceDocumentName

sourceDocumentExtensions

@Parameter(property="asciidoctor.sourceDocumentExtensions")
protected List<String> sourceDocumentExtensions

synchronizations

@Parameter(property="asciidoctor.synchronizations",
           required=false)
protected List<Synchronization> synchronizations

extensions

@Parameter(property="asciidoctor.extensions")
protected List<ExtensionConfiguration> extensions

embedAssets

@Parameter(property="asciidoctor.embedAssets")
protected boolean embedAssets

attributeMissing

@Parameter(property="asciidoctor.attributeMissing")
protected String attributeMissing

attributeUndefined

@Parameter(property="asciidoctor.attributeUndefined")
protected String attributeUndefined

Constructor Detail

AsciidoctorMojo

public AsciidoctorMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getAsciidoctorInstance

protected org.asciidoctor.Asciidoctor getAsciidoctorInstance(String gemPath)
                                                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

renderFile

protected void renderFile(org.asciidoctor.Asciidoctor asciidoctor,
                          Map<String,Object> options,
                          File f)

logRenderedFile

protected void logRenderedFile(File f)

synchronize

protected void synchronize(Synchronization synchronization)

ensureOutputExists

protected void ensureOutputExists()

setOptions

protected void setOptions(org.asciidoctor.OptionsBuilder optionsBuilder)

setAttributesOnBuilder

protected void setAttributesOnBuilder(org.asciidoctor.AttributesBuilder attributesBuilder)
                               throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getSourceDirectory

public File getSourceDirectory()

setSourceDirectory

public void setSourceDirectory(File sourceDirectory)

getOutputDirectory

public File getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

getBackend

public String getBackend()

setBackend

public void setBackend(String backend)

isSkip

public boolean isSkip()

setSkip

public void setSkip(boolean skip)

getDoctype

public String getDoctype()

setDoctype

public void setDoctype(String doctype)

getAttributes

public Map<String,Object> getAttributes()

setAttributes

public void setAttributes(Map<String,Object> attributes)

isHeaderFooter

public boolean isHeaderFooter()

setHeaderFooter

public void setHeaderFooter(boolean headerFooter)

getTemplateDir

public File getTemplateDir()

setTemplateDir

public void setTemplateDir(File templateDir)

getTemplateEngine

public String getTemplateEngine()

setTemplateEngine

public void setTemplateEngine(String templateEngine)

getImagesDir

public String getImagesDir()

setImagesDir

public void setImagesDir(String imagesDir)

getSourceHighlighter

public String getSourceHighlighter()

setSourceHighlighter

public void setSourceHighlighter(String sourceHighlighter)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getSourceDocumentExtensions

public List<String> getSourceDocumentExtensions()

setSourceDocumentExtensions

public void setSourceDocumentExtensions(List<String> sourceDocumentExtensions)

getEruby

public String getEruby()

setEruby

public void setEruby(String eruby)

getSourceDocumentName

public String getSourceDocumentName()

setSourceDocumentName

public void setSourceDocumentName(String sourceDocumentName)

getSynchronizations

public List<Synchronization> getSynchronizations()

setSynchronizations

public void setSynchronizations(List<Synchronization> synchronizations)

isEmbedAssets

public boolean isEmbedAssets()

setEmbedAssets

public void setEmbedAssets(boolean embedAssets)

getAttributeMissing

public String getAttributeMissing()

setAttributeMissing

public void setAttributeMissing(String attributeMissing)

getAttributeUndefined

public String getAttributeUndefined()

setAttributeUndefined

public void setAttributeUndefined(String attributeUndefined)

getProjectDirectory

public File getProjectDirectory()

setProjectDirectory

public void setProjectDirectory(File projectDirectory)

getRootDir

public File getRootDir()

setRootDir

public void setRootDir(File rootDir)

getGemPath

public String getGemPath()

setGemPath

public void setGemPath(String gemPath)

getBaseDir

public File getBaseDir()

setBaseDir

public void setBaseDir(File baseDir)

setPreserveDirertories

public void setPreserveDirertories(boolean preserveDirertories)

setRelativeBaseDir

public void setRelativeBaseDir(boolean relativeBaseDir)

getExtensions

public List<ExtensionConfiguration> getExtensions()

setExtensions

public void setExtensions(List<ExtensionConfiguration> extensions)