Overview

The main purpose of the plugin is to convert text based (XML) UML diagrams from your source tree into the binary image files that you embed or refer from your project site.

Converting Site Diagrams

By default the plugin expects UMLet Diagrams to be located under the src/site/resources/uml source sub-tree.

+- src/
   +- site/
      +- resources/
      |  +- uml/
      |     +- subdir1/
      |     |  +- subdiagram.uxf
      |     +- diagram1.uxf
      |     +- diagram2.uxf
      +- site.xml

The converted images (PNG by default) are stored in the generated site directory at target/site/uml.

+- target/
   +- site/
   |  +- uml/
   |     +- subdir1/
   |     |  +- subdiagram.png
   |     +- diagram1.png
   |     +- diagram2.png
   +- index.html

In order to apply diagrams converting in your project you just need to declare the plugin in your pom like following:

<project>
    ...
    <build>
        ...
        <plugins>
            ...
            <plugin>
                <groupId>com.kryshchuk.maven.plugins</groupId>
                <artifactId>umlet-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <id>convert-uml</id>
                        <goals>
                            <goal>convert</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            ...
        </plugins>
        ...
    </build>
    ...
</project>