PlantUML est un outil robuste utilisé pour
créer des diagrammes UML par le biais d'une description textuelle simple et facilement interprétable. Cependant, il est essentiel de noter qu'il ne limite pas la création de diagrammes incohérents - tels que l'héritage mutuel entre deux classes. Par conséquent, il fonctionne plus comme un outil de
dessin que comme un outil de
modélisation.
Explication des raisons pour lesquelles PlantUML pourrait être votre outil de référence pour la création de diagrammes :
- Création basée sur le texte: PlantUML fonctionne sur un principe de texte, permettant la création de diagrammes par le biais de phrases simples et lisibles par l'homme. Cela facilite la compréhension et la modification des structures de vos diagrammes, même sans expertise dans les outils de création de diagrammes.
- Open-Source et gratuit: Le fait d'être open-source et gratuit signifie que vous pouvez utiliser PlantUML sans encourir de frais de licence ou d'abonnement.
- Smart Layout Algorithms: L'outil utilise des algorithmes de mise en page intelligents, assurant un arrangement cohérent et visuellement agréable des éléments de votre diagramme, éliminant les tracas de l'alignement manuel.
- Génération automatisée de diagrammes: PlantUML est un générateur qui crée de manière autonome des diagrammes basés sur le texte fourni. Cette caractéristique simplifie non seulement la création et la mise à jour rapides des diagrammes, mais vous permet également de vous concentrer sur la délimitation de la structure et des relations plutôt que sur l'esthétique.
- Haute personnalisation: Offrant un haut degré de personnalisation, il vous permet d'adapter l'apparence de vos diagrammes à vos préférences. De* plus, vous pouvez puiser dans les riches ressources de la communauté PlantUML pour trouver des solutions aux problèmes de mise en page les plus courants.
En substance, PlantUML apparaît comme un outil puissant et adaptable, facilitant la création rapide et sans effort de diagrammes professionnels. Il s'adresse en particulier aux personnes qui privilégient une méthodologie basée sur le texte pour la création de diagrammes, en offrant une assistance automatisée dans la gestion de la mise en page et de la visualisation des diagrammes.
PlantUML permet l'utilisation de
thèmes pour personnaliser l'apparence de vos diagrammes. Non seulement il offre une variété de thèmes intégrés pour une sélection rapide, mais il vous permet également de concocter vos propres thèmes uniques à travers la définition de
couleurs et de styles personnalisés.
- Ajustements automatiques de la mise en page
Dites adieu à la tâche fastidieuse d'aligner manuellement les éléments individuels dans votre diagramme. Les algorithmes de mise en page intelligents de PlantUML prennent en charge la lourde tâche d'organiser les éléments de votre diagramme de manière claire et logique. Cela garantit que vous restez concentré sur l'illustration des relations et structures vitales, facilitant la création de diagrammes professionnels sans effort et rapidement.
- Comprendre PlantUML en tant que générateur
Se différenciant de beaucoup de ses homologues, PlantUML fonctionne principalement comme un générateur, fabriquant des diagrammes de manière autonome sur la base du texte d'entrée. Cela favorise non seulement la création rapide et sans tracas de diagrammes, mais rationalise également le processus de mise à jour - une simple modification du texte d'entrée se reflète instantanément dans le diagramme.
Cependant, cette commodité se fait au prix d'un contrôle limité sur la mise en page précise, une contrainte par rapport aux outils qui permettent le positionnement manuel des éléments. Malgré cela, nombreux sont ceux qui trouvent que l'efficacité et le gain de temps d'un générateur l'emportent sur ce défaut.
Pour ceux qui recherchent des conseils ou des solutions à des problèmes courants de mise en page, le
forum de la communauté PlantUML constitue une plate-forme dynamique pour échanger des conseils et obtenir des réponses à vos dilemmes, améliorant ainsi votre maîtrise de la personnalisation de vos diagrammes.
Les liens (png ou svg) générés par le
serveur PlantUML sont valides indéfiniment (c'est à dire tant que le service est disponible).
Toutefois, nous
ne stockons aucune image sur nos serveurs.
Cela peut paraître contradictoire. Ça ne l'est pas : la totalité du diagramme est
compressé dans l'URL elle-même. Quand le serveur reçoit une URL, il la décompresse pour retrouver le texte du diagramme correspondant et générer l'image. Il n'y a pas besoin de stocker quoi que ce soit. D'ailleurs, même si le serveur est hors-service, vous pouvez récupérer le diagramme en utilisant l'option
-decodeurl de la
ligne de commande. Enfin, le texte du diagramme est aussi stocké dans les métadonnées du fichier PNG, donc vous pouvez le récupérer depuis une image.
Parfois, nous sommes amenés à activer des traces HTTP sur notre server. Nous faisons ceci pour analyser les requêtes que nous recevons lorsque nous avons des problèmes de performance (ce qui n'arrive pas très souvent). Une fois le problème résolu, nous désactivons les traces HTTP et nous supprimons les fichiers de log.
À propos de la confidentialité des données, même si nous ne stockons pas les diagrammes générés, il faut savoir que comme le protocole HTTP n'est pas sécurisé, il est assez facile d'intercepter les diagrammes.
Vous devriez donc probablement installer
un serveur local sur votre propre réseau si vous prévoyez de générer des diagrammes contenant des informations sensibles. Vous pouvez le faire sans aucune connaissance de Java/J2EE puisqu'il y a un
petit serveur web inclus dans PlantUML.jar
PlantUML a été installé sur de nombreux systèmes. Toutefois, certains utilisateurs ont parfois rencontré des difficultés en l'installant.
Vous pouvez
consulter cette page qui donne des conseils spécifiques à l'installation si vous avez des problèmes.
Vous trouverez plus d'informations sur GraphViz
ici.
Les versions suivantes ont été testées et sont connues pour fonctionner :
- 2.26.3
- 2.28
- 2.30.1
- 2.34
- 2.36
- 2.38
- 2.44
- 9.0.0
- 10.0.1
Notez que les versions 2.39 à 2.42 ne
fonctionnent pas très bien avec PlantUML.
Avec la version 2.44, sous Windows, vous devrez peut-être exécuter
dot -c en ligne de commande pour finaliser l'installation. Il se peut que vous deviez exécuter
dot -c avec les
droits d'administrateur.
Si vous compilez Graphviz vous-même, vous devez le construire avec
libexpat pour qu'il fonctionne avec PlantUML.
Les
tendances Google sont très positives. Et il y a même
quelques livres qui mentionnent PlantUML. Donc oui, le logiciel est mature.
Il faut dire que
PlantUML est développé en
integration continue. Cela signifie qu'il y a régulièrement de nouvelles versions, avec (on l'espère!) une compatibilité ascendante. Donc le fichier
PlantUML.jar évolue avec le temps tout en conservant le même nom.
Si vous voulez avoir des détails sur la version que vous utilisez, vous pouvez lancer la ligne de commande suivante:
java -jar plantuml.jar -version
ou utiliser le diagramme spécial suivant :
@startuml
version
@enduml
Pour vérifier si une nouvelle version est disponible, vous pouvez aller sur
la page de téléchargement.
Vous pouvez aussi consulter les flux rss suivants:
Ou alors vous pouvez lancer la commande suivante:
java -jar plantuml.jar -version
Ou alors utiliser le diagramme spécial suivant:
@startuml
version
@enduml
PlantUML limite la taille des images à 4096 pixels en largeur et en hauteur. Vous pouvez modifier cette limite grâce à une variable d'environnement:
PLANTUML_LIMIT_SIZE. Vous devez régler cette variable avant de lancer PlantUML, de la façon suivante:
set PLANTUML_LIMIT_SIZE=8192
ou bien
setenv PLANTUML_LIMIT_SIZE 8192
Une autre façon est de mettre une option sur la ligne de commande:
java -DPLANTUML_LIMIT_SIZE=8192 -jar /path/to/plantuml.jar ...
Notez que si vous générez de
très grands diagrammes, (par exemple, comme 20 000 x 10 000 pixels), vous risquez d'avoir des problèmes d'allocation mémoire. La solution est de rajouter le paramètre suivant à la JVM:
-Xmx1024m.
L'encodage des caractères est quelquechose de subtil... Par défaut, PlantUML utilise le codage par défaut de votre plateforme, qui peut être ou ne pas être de l'UTF-8. Si vous voulez savoir quel encodage vous utilisez, vous pouvez utiliser la commande suivante:
java -jar plantuml.jar -help
...
-charset xxx To use a specific charset (default is windows-1252)
...
Si vous voulez utiliser un autre encodage, par exemple de l'UTF-8, vous pouvez utiliser l'option
-charset:
java -jar plantuml.jar -charset UTF-8 ...
Vous trouverez
ici des informations sur l'unicode . Notez que même si Java
ne supporte pas le caractère B.O.M. (Byte Order Mark) dans un fichier UTF-8, un contournement a été implémenté dans PlantUML, donc ces caractères ne devraient pas poser de problèmes.
Des utilisateurs japonais ont précisé qu'ils avaient besoin de régler la variable
LANG à la valeur
ja_JP.UTF-8 dans leur console avant de lancer PlantUML.
export LANG = ja_JP.UTF-8
Depuis
la nouvelle architecture, tout devrait fonctionner directement et nativement parce que Java gère directement les caractères asiatiques.
Vous pouvez utiliser l'option
-teps sur la ligne de commande ou bien
format="eps" avec
la tâche ANT.
PlantUML est distribué sous la
licence GPL.
Vous pouvez visualiser la licence en utilisant la ligne de commande suivante:
java -jar plantuml.jar -license
Ou vous pouvez utiliser le diagramme spécial:
@startuml
license
@enduml
Vous pouvez aussi utiliser :
Certaines fonctionnalités ne sont pas incluses dans ces versions (
DITAA par exemple).
Vous pouvez visualiser les licences de ces versions à l'aide de la ligne de commande suivante:
java -jar plantuml.jar -license
Ou vous pouvez utiliser le diagramme spécial suivant:
@startuml
license
@enduml
Non, elles ne sont pas couvertes par ces licences.
Les images (quelquesoit leur format : PNG, SVG...) générées par l'
exécution de PlantUML sont la propriété de l'auteur du texte source du diagramme correspondant (exprimé en langage PlantUML).
Les images générées par l'
exécution de PlantUML
ne sont pas considérée comme des
créations régies par la licence (en anglais
covered work). Vous pouvez faire ce que vous voulez avec ces images.
Les images générées peuvent être utilisées sans aucune référence à la licence GPL/LGPL/ASL/EPL/MIT. Il n'est même pas nécessaire de notifier que vous avez créé ces images avec PlantUML, bien que si vous le faites, cela sera grandement apprécié par l'équipe PlantUML.
Il y a une exception : si la description textuelle en langage PlantUML est elle-même soumise à une licence quelconque (comme la GPL/LGPL/ASL/EPL/MIT), alors les images générées sont logiquement elles aussi soumises à cette même licence.
Puis-je redistribuer la version LGPL du fichier binaire PlantUML.jar et y a-t-il des contraintes à ce sujet ?
Tant que vous ne modifiez pas les sources Java et le fichier jar, vous pouvez intégrer plantuml.jar dans votre propre logiciel, même s'il n'est pas Open Source.
La seule contrainte est que vous avez à stipuler quelquepart dans votre propre licence ou dans votre documentation que vous utilisez PlantUML est que PlantUML est distribué sous licence LGPL.
Vous pouvez même vendre votre logiciel et gagner de l'argent, sans aucune autre contrainte (dans ce cas, un
don serait apprécié :-)
Il n'y a pas de licence pour la syntaxe PlantUML en elle-même: cela signifie que tout le monde peut l'utiliser.
Si vous utilisez un diagramme PlantUML dans un commentaire de votre propre code,
ces commentaires vous appartiennent et ne sont pas considérés comme une
création régie par la licence (en anglais
covered work). Ces commentaires ne sont pas couverts par la licence GPL/LGPL/APL/EPL/MIT.
C'est seulement l'implémentation de PlantUML (c'est à dire le programme Java PlantUML) qui est couvert par la licence GPL, LGPL, ASL, EPL ou MIT. Notez par contre que la documentation publiée sur le site web PlantUML est sous copyright. Mais vous pouvez écrire votre propre documentation.
PlantUML utilise
Graphviz pour générer certains diagrammes. De ce fait PlantUML lance l'exécution du programme
dot et récupère les informations générées par
dot dans un flux SVG.
Cette exception signifie que PlantUML récupère un flux vide de la part de
dot et ne peut donc pas générer de diagrammes UML. Ceci peut être dû à plusieurs causes:
- Il y a un problème avec votre installation de Graphviz. Essayez avec un diagramme très simple contenant une seule classe par exemple.
- Votre version de Graphviz est trop ancienne et n'est pas compatible avec PlantUML. Testez votre version avec
testdot
- Votre diagramme est trop complexe.
- Il y a un bug dans PlantUML et/ou dot.
Si le message d'erreur
java.lang.NoClassDefFoundError: Could not initialize class net.sourceforge.plantuml.ugraphic.UFont s'affiche, cela signifie probablement qu'aucune police de caractères n'est installée sur votre serveur.
Vous pouvez résoudre ce problème en ajoutant
fontconfig sur votre système
sudo yum install fontconfig
or
sudo apt-get install fontconfig
Il peut être aussi nécessaire d'installer:
ttf-droid
Si vous exécutez PlantUML sur un serveur linux sans capacité d'affichage, il est possible que vous ayez les messages d'erreur suivants:
- Can't connect to X11 window
- X11 connection rejected because of wrong authentication.
- HeadlessException
Ceci est dû au fait que PlantUML a besoin d'accéder à certaines ressources graphiques (
plus d'information ici).
Vous pouvez essayer le mode
headless à l'aide de l'option
-Djava.awt.headless=true.
Par exemple :
/usr/bin/java -Djava.awt.headless=true -jar /data/PlantUml/plantuml.jar ...
If you see a similar message on MacOS Ventura after running
plantuml with no arguments, this is a
known issue but does not appear to indicate a problem since sub-commands (like
-gui) do work.
WARNING
This translation need to be updated. WARNING
Sous Mac OS X, si vous rencontrez un message d'erreur suivant:
Error java.lang.UnsatisfiedLinkError / liblwawt.dylib /libosxapp.dylib
Vous pouvez suivre les instructions expliquées ici
http://stackoverflow.com/questions/25914757/osx-yosemite-jvm-shared-library-does-not-contain-the-jni-createjavavm-symbol:
- Téléchargez et installer le package: JavaForOSX.
- Cherchez le fichier
AptanaStidio3.ini, qui est par défaut situé sous le répertoire suivant: /Applications/Aptana Studio 3/AptanaStudio3.app/Contents/MacOS
- Rajoutez l'option
-vm pour indiquer quelle machine Java utiliser pour le lancement de Aptana Studio: -vm /Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home/bin/java
Cela ne semble fonctionner que sous Java 6, donc vous pourriez aussi avoir à définir l'alias suivant pour vos scripts:
alias java6="export JAVA_HOME=$(/usr/libexec/java_home -v 1.6.0)"
En fonction de votre configuration, vous pouvez essayer l'option
-Djava.awt.headless=true.
Par exemple:
/usr/bin/java -Djava.awt.headless=true -jar /path/to/plantuml.jar ...
Réponse courte: Oui, il
faut mettre @startuml (ou alors @startditaa/@startjcckit...) au début d'un diagramme.
Réponse longue:
La ligne @startuml/@startditaa/@startjcckit est utilisée pour connaître le type de diagramme (UML, ditaa, jcckit...) et aussi parce qu'il est possible de mettre en option un nom de fichier après @startXXX. De plus, cette ligne permet aussi d'avoir plusieurs diagrammes dans un même fichier.
Les toutes premières version de PlantUML ne géraient qu'un seul type de diagramme (UML). De plus, quand vous utilisez l'option
-pipe, puisque le diagramme est écrit vers la sortie standard, il ne pouvait y avoir qu'un seul diagramme. Et pour finir, donner un nom de fichier n'avait aucun sens. Pour toutes ces raisons, @startuml n'était pas nécessaire pour l'option
-pipe à l'époque.
Plus tard, il a été décidé de normaliser tout ceci et d'imposer @startXXX partout, même dans le cas de l'option
-pipe, pour éviter les confusions. Malheureusement, certains scripts déjà écrits utilisaient le fait que @startuml n'était pas nécessaire avec l'option
-pipe, donc
nous avons gardé ce comportement de façon
temporaire, pour permettre à ces anciens scripts d'être encore opérationnels. En effet, nous sommes très attentif à la compatibilité ascendante.
Pour les nouveaux scripts, vous ne devez pas vous appuyer sur ce comportement et vous devez utiliser @startuml/@enduml avec l'option
-pipe.
Le travail
est en cours!
J'ai trouvé un problème, mais je ne peux pas fournir mon diagramme montrant le problème parce que mon diagramme contient des données confidentielles
Il y a une option
-cypher avec la ligne de commande qui génère un fichier
.preproc au lieu d'un fichier image normal.
Le fichier généré
.preproc ressemble au diagramme d'entrée sauf que tous les mots (sauf les mots clés du langage PlantUML) ont été remplacés par un ensemble aléatoire de lettres.
Vous pouvez vérifier cela en exécutant plusieurs fois l'option
-cypher (vous obtiendrez un texte différent à chaque fois).
Vous pouvez également regarder la classe
Cypher.java utilisée pour exécuter cette transformation pour être sûr qu'il n'y a pas de porte dérobée pour récupérer votre diagramme original.
S'il y a un problème dans votre diagramme original, il est probable que le même problème se produise avec le diagramme chiffré.
Puisque le texte chiffré est vraiment sans signification, vous pouvez le partager avec nous en toute sécurité : il n'y aura aucun moyen pour nous de deviner ce sur quoi vous travaillez réellement.
Mais nous serons en mesure de reproduire le problème et de le corriger pour que vous puissiez avoir votre diagramme original (et confidentiel) en état de marche.
Vous pouvez utiliser le
forum.
Quelqu'un aura peut-être une réponse.
Accueil
Nouveautés !
Démarrage rapide
Online Server
Utilisation
Questions/Réponses
Téléchargement
Forum
Theme
Préprocesseur
Librairie Standard
Hitchhiker's Guide
Documentation PDF
Edit in Dokuwiki
Edit in Asciidoc
Edit in Markdown