Utilisation de plantumlAuteur : Julien Gauchet le 21/11/2017 (1 revision)

Cette page permet de décrire le fonctionnement de Plantuml. La documentation est disponnible sur cette page : Documentation plantuml

1. Installation

Les étapes dérites ci-dessous vous permettront d'installer plantuml et de le faire fonctionner avec éclipse

Étape 1 : récupérer les exécutables

  • Télécharger graphviz à l'adresse suivante : graphviz
  • Décompresser graphviz et le mettre dans un répertoire du système d'exploitation (noté REP_GRAPHVIZ)
  • Télécharger plantuml à l'adresse suivante : Plantuml
  • Décompresser plantuml et le mettre dans un répertoire du système d'exploitation (noté REP_PLANTUML)
Il est déspormais possible de compiler des diagrammes plantuml
:: Dossier dans lequel seront générés les diagrammes
set dossier_sortie=D:\sortie

:: Chemin ver le jar plantuml : REP_PLANTUML\plantuml.jar
set jar_puml=D:\plantuml.jar

:: Chemin vers dot.exe à l'intérieur du répertoire REP_GRAPHVIZ
set graphviz_dot="D:\graphviz-2.38\bin\dot.exe"

:: Fichier à convertir
set entree=diagramme.puml

java -jar "%jar_puml%"  -graphvizdot "%graphviz_dot%" "%entree%" -o "%dossier_sortie%" -charset UTF-8

Étape 2 : intégration à éclipse

  • Ouvrir l'assistant d'installationd d'éclipse : Help > Install New Software...
  • Ajouter un repository Name : plantuml, Location : http://files.idi.ntnu.no/publish/plantuml/repository/ et installer l'utilitaire
  • Paramétrer l'utilitaire pour lui donner le chemin vers dot.exe dans REP_GRAPHVIZ : Window > Preferences > PlantUML
  • Ouvrir la vue plantuml : Window > Show View > Other > PlantUML > PlantUML

2. La syntaxe plantuml

La syntaxe de plantuml est décrite sur le site de référence d'une manière admirable, je n'en dis donc pas plus et vous laisse explorer le site en fonction de vos besoins : Documentation plantuml

3. Utiliser plantuml dans un site maven

Une fois arrivé à ce stade, nous pouvons utiliser plantuml mais il n'est en revanche pas possible d'intégrer des diagrammes plantuml dans un maven site. Il existe un plugin de maven permettant d'écrire directement du plantuml dans les pages doxia mais ce n'est pas une bonne idée : l'outil de visualisation doxia et l'outil de visualisation plantuml ne fonctionneraient plus.

Je vous propose donc une solution peu satisfaisante puisque reposant sur le lancement d'un fichier bat mais très efficace.

  • Créer un dossier src/site/plantuml qui contiendra tous les diagramme plantuml du site et éventuellement des sous dossiers
  • Créer un dossier src/site/resources/images qui contiendra les images utilisées pour la création du site
  • Récuperer le .bat suivant et le placer dans le dossier src/site/plantuml
  • Le lancement du bat permet de générer des images qu'il suffiera d'utiliser dans les pages apt
set dossier_sortie=..\resources\images

:: Chemin ver le jar plantuml : REP_PLANTUML\plantuml.jar
set jar_puml=D:\plantuml.jar

:: Chemin vers dot.exe à l'intérieur du répertoire REP_GRAPHVIZ
set graphviz_dot="D:\graphviz-2.38\bin\dot.exe"

:: Génération des images du dossier courant
java -jar "%jar_puml%" -graphvizdot "%graphviz_dot%" "*.puml" -o "%dossier_sortie%" -charset UTF-8

:: Génération des images des sous dossiers
for /d %%i in (*) do (  
	mkdir %%i 2> NUL
	java -jar "%jar_puml%" "%%i\*.puml" -o "..\%dossier_sortie%\%%i" -charset UTF-8
)