|
|
|
|
|
Création d'une tâche ANT
|
Writing an Ant Task
|
|
|
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 @startXYZ et génèrent les images .png correspondantes.
|
You must have something like this into your Ant build.xml file:
<project name="OwnTaskExample" default="main" basedir=".">
<!-- task definition -->
<taskdef name="plantuml" classname="net.sourceforge.plantuml.ant.PlantUmlTask" classpath="plantuml.jar" />
<!-- process ./src files -->
<target name="main">
<plantuml dir="./src" />
</target>
</project>
The Ant task processes all .c, .h, .cpp, .tex, .html, .htm or .java of the provided directory ( ./src in this example). It looks for @startXYZ and generates .png images.
|
Répertoire de sortie
|
Output Directory
|
|
|
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>
|
You can also specify a output directory for all generated images, using
output tag.
<!-- Put images in c:/images directory -->
<target name="main">
<plantuml dir="./src" output="c:/images" />
</target>
|
Traiter récursivement les répertoires
|
Recurse through directories
|
|
|
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>
|
You can also use Ant standard fileset
or filelist.
For example, if you want to process all java file in c:/src and subdirectories, (except files ending by Test.java), and generate images into d:/images, you can use:
<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
|
SVG or EPS Support
|
|
|
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>
|
You can also use format="svg" or format="eps" in the Ant task definition.
<target name="main">
<plantuml dir="./src" format="svg" />
</target>
|
Fichier de configuration
|
Configuration file
|
|
|
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>
|
You can also provide a configuration file which will be included before each diagram.
<target name="main">
<plantuml dir="./src" config="./config.cfg" />
</target>
|
Autres paramètres
|
Other parameters
|
|
|
|
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
|
false
|
true 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
|
false
|
true pour arrêter le traitement si des diagrammes sont en erreur
|
|
checkonly
|
false
|
true si vous voulez uniquement contrôler la syntaxe sans générer d'images
|
|
overwrite
|
false
|
true pour forcer l'écriture des fichiers en lecture seule
|
|
enablestats
|
false
|
true pour activer les statistiques
|
|
htmlstats
|
false
|
true pour générer les statistiques dans le fichier plantuml-stats.html
|
|
xmlstats
|
false
|
true pour générer les statistiques dans le fichier plantuml-stats.xml
|
|
realtimestats
|
false
|
true pour générer les statistiques en temps réel plutôt qu'à la fin du traitement
|
|
|
Parameter
|
Default
|
Description
|
|
nbthread
|
1
|
Number of thread for processing
|
|
graphvizDot
|
|
Path of the dot executable
|
|
format
|
png
|
Format for image generation: xmi, xmi:argo, xmi:start, eps, svg, txt, utxt
|
|
verbose
|
false
|
true for more logs
|
|
config
|
|
File config to include before all diagrams
|
|
charset
|
|
Charset to use when reading files
|
|
output
|
|
Output directory for generated images
|
|
dir
|
|
Input directory to process (You can use <fileset>/<filelist> instead)
|
|
failonerror
|
false
|
true to fail the build if some syntax error occurs
|
|
checkonly
|
false
|
true if you want to only check the syntax of files without generating images
|
|
overwrite
|
false
|
true if you want overwrite read-only files
|
|
enablestats
|
false
|
true to enable statistics
|
|
htmlstats
|
false
|
true to output general statistics in file plantuml-stats.html
|
|
xmlstats
|
false
|
true to output general statistics in file plantuml-stats.xml
|
|
realtimestats
|
false
|
true to generate statistics on the fly rather than at the end
|
|
|
|
|
