org.codehaus.mojo.latex

Class LaTeXMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.latex.LaTeXMojo

All Implemented Interfaces:

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

public class LaTeXMojo
extends org.apache.maven.plugin.AbstractMojo

LaTeX documents building goal.

Author:

Julien Ponge, FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field and Description
private String	bibtex Name of bibtex executable.
private String	binariesPath Path to the LaTeX binaries installation.
private File	buildDir The Maven build directory.
private String	commonsDirName Common files directory inside the documents root (the only directory to be skipped).
private File	docsRoot The documents root.
static String	DUMMY_TEMPLATE template for dummy PDFs, taken from here
private boolean	dummyBuild Generates dummy PDFs.
private boolean	forceBuild Allows to force the build.
private File	latexBuildDir The LaTeX builds directory.
static String	PLACEHOLDER_NAME the placeholder for the name in the PDF template.
static String	PLACEHOLDER_STARTXREF the placeholder for the startxref value in the PDF template.
private boolean	skipBuild Allows to skip the build.
static int	XREF_OFFSET the startxref offset if printed name is length 0.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
LaTeXMojo()

Method Summary

Modifier and Type	Method and Description
private void	buildDocuments(File[] buildDirs)
private void	createDummyFile(String name) Creates a dummy PDF file in the build directory.
private String	executablePath(String executable)
void	execute()
private void	execute(org.apache.commons.exec.CommandLine commandLine, File dir)
private File[]	getDocDirs()
private File[]	prepareLaTeXBuildDirectories(File[] docDirs)
private boolean	requiresBuilding(File dir, File pdfFile)

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

DUMMY_TEMPLATE

public static final String DUMMY_TEMPLATE

template for dummy PDFs, taken from here

See Also:

Constant Field Values

XREF_OFFSET

public static final int XREF_OFFSET

the startxref offset if printed name is length 0.

See Also:

Constant Field Values

PLACEHOLDER_NAME

public static final String PLACEHOLDER_NAME

the placeholder for the name in the PDF template.

See Also:

Constant Field Values

PLACEHOLDER_STARTXREF

public static final String PLACEHOLDER_STARTXREF

the placeholder for the startxref value in the PDF template.

See Also:

Constant Field Values

docsRoot

private File docsRoot

The documents root.

commonsDirName

private String commonsDirName

Common files directory inside the documents root (the only directory to be skipped).

buildDir

private File buildDir

The Maven build directory.

latexBuildDir

private File latexBuildDir

The LaTeX builds directory.

binariesPath

private String binariesPath

Path to the LaTeX binaries installation.

bibtex

private String bibtex

Name of bibtex executable. Use this to invoke bibtex8 or biber instead of bibtex.

skipBuild

private boolean skipBuild

Allows to skip the build.

forceBuild

private boolean forceBuild

Allows to force the build.

dummyBuild

private boolean dummyBuild

Generates dummy PDFs. Useful when no LaTeX installed.

Constructor Detail

LaTeXMojo

public LaTeXMojo()

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

createDummyFile

private void createDummyFile(String name)

Creates a dummy PDF file in the build directory.

Parameters:

name - the name of the PDF file

buildDocuments

private void buildDocuments(File[] buildDirs)
                     throws IOException,
                            org.apache.maven.plugin.MojoFailureException

Throws:

IOException

org.apache.maven.plugin.MojoFailureException

requiresBuilding

private boolean requiresBuilding(File dir,
                                 File pdfFile)
                          throws IOException

Throws:

IOException

executablePath

private String executablePath(String executable)

execute

private void execute(org.apache.commons.exec.CommandLine commandLine,
                     File dir)
              throws IOException,
                     org.apache.maven.plugin.MojoFailureException

Throws:

IOException

org.apache.maven.plugin.MojoFailureException

prepareLaTeXBuildDirectories

private File[] prepareLaTeXBuildDirectories(File[] docDirs)
                                     throws IOException

Throws:

IOException

getDocDirs

private File[] getDocDirs()