org.wisdom.asciidoc

Class AsciidocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.wisdom.maven.mojos.AbstractWisdomMojo

org.wisdom.maven.mojos.AbstractWisdomWatcherMojo

org.wisdom.asciidoc.AsciidocMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.wisdom.maven.Constants, org.wisdom.maven.Watcher

@Mojo(name="compile-asciidoc",
      threadSafe=false,
      requiresDependencyResolution=COMPILE,
      requiresProject=true,
      defaultPhase=COMPILE)
public class AsciidocMojo
extends org.wisdom.maven.mojos.AbstractWisdomWatcherMojo
implements org.wisdom.maven.Constants

Compiles Asciidoc files to HTML documents.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	attributes
protected String	backend
protected boolean	compact
(package private) File	destinationForExternals
(package private) File	destinationForInternals
protected String	doctype
protected boolean	embedAssets
protected String	eruby
protected List<String>	extensions
(package private) File	externalSources
protected boolean	headerFooter
protected String	imagesDir
(package private) org.asciidoctor.Asciidoctor	instance
(package private) File	internalSources
protected String	sourceHighlighter
protected String	stylesheet
protected String	stylesheetDir
protected File	templateDir
protected String	templateEngine

Fields inherited from class org.wisdom.maven.mojos.AbstractWisdomMojo

basedir, buildDirectory, javaHome, plugin, pluginDependencies, pluginManager, project, projectHelper, remoteRepos, repoSession, repoSystem, session

Fields inherited from interface org.wisdom.maven.Constants

ASSETS_DIR, ASSETS_SRC_DIR, CONFIGURATION_DIR, CONFIGURATION_SRC_DIR, DEPENDENCIES_FILE, EXTRA_HEADERS_FILE, INSTRUCTIONS_FILE, MAIN_RESOURCES_DIR, MAIN_SRC_DIR, NODE_VERSION, NPM_VERSION, OSGI_PROPERTIES, TEMPLATES_DIR, TEMPLATES_SRC_DIR, TEST_RESOURCES_DIR, TEST_SRC_DIR, WISDOM_BASE_RUNTIME_ARTIFACT_ID, WISDOM_DIRECTORY_NAME, WISDOM_RUNTIME_ARTIFACT_ID

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AsciidocMojo()

Method Summary

Modifier and Type	Method and Description
boolean	accept(File file)
void	execute()
boolean	fileCreated(File file)
boolean	fileDeleted(File file)
boolean	fileUpdated(File file)
private File	findFileInDirectory(File file, File directory) Searches for a file with the same name as the given file in the given directory.
protected org.asciidoctor.Asciidoctor	getAsciidoctorInstance()
private File	getOutputHTMLFile(File input)
protected void	renderFile(Map<String,Object> options, File f)
private List<File>	scanSourceFiles(File root)

Methods inherited from class org.wisdom.maven.mojos.AbstractWisdomWatcherMojo

removeFromWatching, setSession

Methods inherited from class org.wisdom.maven.mojos.AbstractWisdomMojo

getNodeManager, getWisdomRootDirectory

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

attributes

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

backend

@Parameter(property="backend",
           defaultValue="html5",
           required=true)
protected String backend

compact

@Parameter(property="compact",
           required=false)
protected boolean compact

doctype

@Parameter(property="doctype",
           defaultValue="article",
           required=true)
protected String doctype

eruby

@Parameter(property="eruby",
           required=false,
           defaultValue="erb")
protected String eruby

headerFooter

@Parameter(property="headerFooter",
           required=false,
           defaultValue="true")
protected boolean headerFooter

templateDir

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

templateEngine

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

imagesDir

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

sourceHighlighter

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

extensions

@Parameter(property="extensions")
protected List<String> extensions

embedAssets

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

stylesheet

@Parameter
protected String stylesheet

stylesheetDir

@Parameter
protected String stylesheetDir

internalSources

File internalSources

destinationForInternals

File destinationForInternals

externalSources

File externalSources

destinationForExternals

File destinationForExternals

instance

org.asciidoctor.Asciidoctor instance

Constructor Detail

AsciidocMojo

public AsciidocMojo()

Method Detail

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

getAsciidoctorInstance

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

Throws:

org.apache.maven.plugin.MojoExecutionException

scanSourceFiles

private List<File> scanSourceFiles(File root)

renderFile

protected void renderFile(Map<String,Object> options,
                          File f)
                   throws IOException

Throws:

IOException

findFileInDirectory

private File findFileInDirectory(File file,
                                 File directory)

Searches for a file with the same name as the given file in the given directory.

Parameters:

file - the file

directory - the directory

Returns:

the found file or null if not found

accept

public boolean accept(File file)

Specified by:

accept in interface org.wisdom.maven.Watcher

fileCreated

public boolean fileCreated(File file)
                    throws org.wisdom.maven.WatchingException

Specified by:

fileCreated in interface org.wisdom.maven.Watcher

Throws:

org.wisdom.maven.WatchingException

fileUpdated

public boolean fileUpdated(File file)
                    throws org.wisdom.maven.WatchingException

Specified by:

fileUpdated in interface org.wisdom.maven.Watcher

Throws:

org.wisdom.maven.WatchingException

fileDeleted

public boolean fileDeleted(File file)
                    throws org.wisdom.maven.WatchingException

Specified by:

fileDeleted in interface org.wisdom.maven.Watcher

Throws:

org.wisdom.maven.WatchingException

getOutputHTMLFile

private File getOutputHTMLFile(File input)