Vous pouvez contribuer à cette page en cliquant ici  (Menu)


If you support us, you might vote for PlantUML as Project of the Month.
Just post VOTE: plantuml. Thanks !

 

 

Création d'une tâche ANT

Vous devez tout d'abord construire votre fichier build.xml de façon similaire à l'exemple suivant:

<project name="OwnTaskExample" default="main" basedir=".">
<!-- définition de la tâche-->
<taskdef name="plantuml" classname="net.sourceforge.plantuml.ant.PlantUmlTask" classpath="plantuml.jar" />

<!-- traitement des fichiers du répertoire ./src -->
<target name="main">
<plantuml dir="./src" />
</target>
</project>

La tâche ANT parcourt tous les fichiers .c, .h, .cpp, .tex, .html, .htm et .java du répertoire fourni (./src dans l'exemple précédent). Elle recherche des @startXXX et génèrent les images .png correspondantes.

 

 

Répertoire de sortie

Vous pouvez aussi spécifier un répertoire de sortie pour les images générées à l'aide de l'option output.

<!-- Générer les images dans c:/images -->
<target name="main">
<plantuml dir="./src" output="c:/images" />
</target>

 

 

Traiter récursivement les répertoires

Il est possible d'utiliser les notations ANT standard fileset ou filelist.

Par exemple, si vous voulez traiter tous les fichiers .java du répertoire c:/src ainsi que de ses sous-répertoires (sauf pour les fichiers finissant par Test.java), et générer les images dans d:/images, vous pouvez utiliser la description suivante:

<target name="main">
<plantuml output="d:/images" >
<fileset dir="c:/src">
<include name="**/*.java" />
<exclude name="**/*Test.java" />
</fileset>
</plantuml>
</target>

 

 

Format SVG et EPS

Vous pouvez préciser format="svg" ou format="eps" dans la définition de la tâche ANT.

<target name="main">
<plantuml dir="./src" format="svg" />
</target>

 

 

Fichier de configuration

Il est possible de définir un fichier de configuration qui sera inclus avant chaque diagramme.

<target name="main">
<plantuml dir="./src" config="./config.cfg" />
</target>

 

 

Autres paramètres

Paramètres Valeur par défaut Description
nbthread 1 Nombre de thread pour le traitement
graphvizDot Chemin de l'exécutable dot
format png Format de l'image générée: xmi, xmi:argo, xmi:start, eps, svg, txt, utxt
verbose falsetrue pour des détails de log
config Fichier de configuration inclus avant chaque diagramme
charset Codage de caractères à utiliser lors de la lecture des fichiers sources
output Répertoire de sortie pour les images
dir Répertoire à traiter (Vous pouvez utiliser <fileset>/<filelist> à la place)
failonerror falsetrue pour arrêter le traitement si des diagrammes sont en erreur
checkonly falsetrue si vous voulez uniquement contrôler la syntaxe sans générer d'images
overwrite falsetrue pour forcer l'écriture des fichiers en lecture seule
enablestats falsetrue pour activer les statistiques
htmlstats falsetrue pour générer les statistiques dans le fichier plantuml-stats.html
xmlstats falsetrue pour générer les statistiques dans le fichier plantuml-stats.xml
realtimestats falsetrue pour générer les statistiques en temps réel plutôt qu'à la fin du traitement