Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal	Description
latex:cfg	Builds documents in the formats configured in the pom from LaTeX sources. The goal is tied to the lifecycle phase `site` by default.
latex:chk	Checks all latex main files after having created all graphical files.
latex:clr	Clears all created files in the folders containing the LaTeX sources. The goal is tied to the lifecycle phase `clean` by default.
latex:docx	Builds documents in msword formats, above all docx from LaTeX sources.
latex:dvi	Builds DVI/XDV documents from LaTeX sources. Generically DVI is created but `xelatex` creates XDV instead.
latex:grp	Transforms all graphic files into formats which can be included into LaTeX files for the goal `grp` which is not tied to a lifecycle phase.
latex:help	Display help information on latex-maven-plugin. Call `mvn latex:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
latex:html	Builds HTML documents and XHTML documents from LaTeX sources.
latex:inj	Creates rc file `.latexmkrc` for latexmk and `.chktexrc` for chktex and further files for various use cases. The goal is tied to the lifecycle phase `validate` by default.
latex:odt	Build documents in open office formats from LaTeX sources.
latex:pdf	Builds PDF documents from LaTeX sources.
latex:rtf	Builds rtf documents from LaTeX sources.
latex:txt	Builds documents in plain text weakly formatted (e.g. symbols) .
latex:vrs	Displays version info of this plugin but above all on all converters. The goal is tied to the lifecycle phase `validate` by default.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.9.1
JDK	17

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version	Maven	JDK
2.0	3.9.1	17

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>eu.simuline.m2latex</groupId>
          <artifactId>latex-maven-plugin</artifactId>
          <version>2.1-SNAPSHOT</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>eu.simuline.m2latex</groupId>
        <artifactId>latex-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"