Return-Path: 
 <dev-return-137742-apmail-commons-dev-archive=commons.apache.org@commons.apache.org>
X-Original-To: apmail-commons-dev-archive@www.apache.org
Delivered-To: apmail-commons-dev-archive@www.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id 9DDA2D2DE
	for <apmail-commons-dev-archive@www.apache.org>;
 Mon, 20 Aug 2012 12:27:58 +0000 (UTC)
Received: (qmail 38958 invoked by uid 500); 20 Aug 2012 12:27:56 -0000
Delivered-To: apmail-commons-dev-archive@commons.apache.org
Received: (qmail 38676 invoked by uid 500); 20 Aug 2012 12:27:55 -0000
Mailing-List: contact dev-help@commons.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:dev-help@commons.apache.org>
List-Unsubscribe: <mailto:dev-unsubscribe@commons.apache.org>
List-Post: <mailto:dev@commons.apache.org>
List-Id: <dev.commons.apache.org>
Reply-To: "Commons Developers List" <dev@commons.apache.org>
Delivered-To: mailing list dev@commons.apache.org
Received: (qmail 38575 invoked by uid 99); 20 Aug 2012 12:27:53 -0000
Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230)
    by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 20 Aug 2012 12:27:53 +0000
X-ASF-Spam-Status: No, hits=0.7 required=5.0
	tests=SPF_NEUTRAL
X-Spam-Check-By: apache.org
Received-SPF: neutral (nike.apache.org: local policy)
Received: from [80.67.169.19] (HELO solo.fdn.fr) (80.67.169.19)
    by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 20 Aug 2012 12:27:47 +0000
Received: from lehrin.spaceroots.org (lehrin.spaceroots.org
 [IPv6:2001:910:10e5:6e78::7e41:1])
	by smtp.fdn.fr (Postfix) with ESMTP id 1728544D63
	for <dev@commons.apache.org>; Mon, 20 Aug 2012 14:27:27 +0200 (CEST)
Received: from [127.0.0.1] (lehrin.spaceroots.org [127.0.0.1])
	by lehrin.spaceroots.org (Postfix) with ESMTP id 312635F42D
	for <dev@commons.apache.org>; Mon, 20 Aug 2012 14:27:25 +0200 (CEST)
Message-ID: <50322D2D.4050501@free.fr>
Date: Mon, 20 Aug 2012 14:27:25 +0200
From: Luc Maisonobe <Luc.Maisonobe@free.fr>
User-Agent: Mozilla/5.0 (X11; Linux x86_64;
 rv:10.0.5) Gecko/20120624 Icedove/10.0.5
MIME-Version: 1.0
To: Commons Developers List <dev@commons.apache.org>
Subject: [all] displaying some class and sequence diagrams for our components
X-Enigmail-Version: 1.4.1
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit

Hello,

As our components are mainly low level libraries, they target
developers. I wonder if we could add some basic UML diagrams for some
elements.

I know such diagrams are a pain to maintain, so I have looked at
something really simple, with the goal to only display a few core elements.

I have found plantuml <http://plantuml.sourceforge.net/index.html> to be
almost a perfect fir for this goal. It can be used from the command
line, it can be used with eclipse, it can be used with Maven (see
<https://github.com/jeluard/maven-plantuml-plugin>).

Here are some diagrams I have made for [math]:
<http://people.apache.org/~luc/plantuml-apache-commons-math/>. There are
also other diagrams I have made for Orekit, which aslo show some
sequence diagrams:
<https://www.orekit.org/static/architecture/propagation.html>.

I would like to add such diagrams to our documentation, for example by
adding a "design" directory under "src/site" for holding the .puml text
files that depict the diagrams, and generating the png images under
target/site/images. This can be done by adding the following plugin
definition to the pom, in the build section:

      <plugin>
        <groupId>com.github.jeluard</groupId>
        <artifactId>maven-plantuml-plugin</artifactId>
        <version>7876</version>
        <configuration>
          <sourceFiles>
            <directory>${basedir}</directory>
            <includes>
              <include>
                src/site/design/*.puml
              </include>
            </includes>
          </sourceFiles>
          <outputDirectory>
            ${basedir}/target/site/images/design
          </outputDirectory>
        </configuration>
        <executions>
          <execution>
            <phase>pre-site</phase>
            <goals>
              <goal>generate</goal>
            </goals>
          </execution>
        </executions>
        <dependencies>
          <dependency>
            <groupId>net.sourceforge.plantuml</groupId>
            <artifactId>plantuml</artifactId>
            <version>7930</version>
          </dependency>
        </dependencies>
      </plugin>

I don't know however if this runs everywhere, as I guess plantuml itself
has a hidden dependency to graphviz.

I have two questions. Could someone check if the maven integration runs
by itself on a pristine computer with nothing special installed (i.e.
without having graphviz pre-installed) ? What do you think about adding
such feature, either with an automatic generation of images or with the
images pre-generated by our own build tools and included (together with
their source script) in the distribution archive?

best regards,
Luc

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org