Home

Description

This maven plugin converts the Evolus Pencil project files to SVG images. It is intended to be used as an one of the plugins which builds the project documentation.

Adding the plugin to the local maven repository

If you have a maven\bin directory on your PATH then you run:

mvn install:install-file -Dfile=pencil2svg-maven-plugin-1.0.jar -DpomFile=pom.xml

or

add-to-maven-repository.bat

Usage

Place your .ep files under /site/pencil directory of your maven project. This the default location where plugin will search for ep files. You can change it by specifying the inputDirectory configuration properties. The generated SVG images will be placed under target/site/pencil directory, which you also can altered by outputDirectory parameter.

The goal when plugin runs is named ep2svg and the phase is site.

To run the plugins during the site phase of the build use this declaration. Configuration has the default values and can be removed.

  <build>
    <plugins>
      <plugin>
        <groupId>net.olsza.maven</groupId>
        <artifactId>pencil2svg-maven-plugin</artifactId>
        <version>1.0</version>
        <configuration>
          <inputDirectory>src/site/pencil</inputDirectory>
          <outputDirectory>target/site/pencil</outputDirectory>
        </configuration>
        <executions>
          <execution>
            <goals>
              <goal>ep2svg</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

Output

The plugins can produce the multiple SVG files from one ep file. Each SVG file name is build form the page name of scene in ep file preceed by the ep's file name and _. So if have the following ep projects:

• mockups1.ep (with pages: page1 and page2)
• user-interface.ep (with pages: login_view and menu)

Then as a result you will get 4 files:

• mockups1_page1.svg
• mockups1_page2.svg
• user-interface_login_view.svg
• user-interface_menu.svg

I recommend to not use the blanks inside the name of the file and pages name.