Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    Recent changes    View page history    Add new chapter    Reorder page    Raw


Procédure d'installation

WARNING
 This translation need to be updated. 
WARNING

Local Installation notes

Diagramme de séquence

Pour commencer, vous devez faire fonctionner les diagrammes de séquence. Même si ceux-ci ne vous intéressent pas particulièrement, il est plus facile de commencer avec eux, parce qu'ils n'ont pas besoin de Graphviz pour être générés. Et si les diagrammes de séquence ne fonctionnent pas, les autres diagrammes ne fonctionneront probablement pas non plus.

Il s'agit donc de tester les diagrammes de séquence avec la ligne de commande (et non pas avec un autre outil que vous auriez l'intention d'utiliser - Eclipse, Word, Mediawiki...):

java -jar plantuml.jar -verbose sequenceDiagram.txt

Le fichier sequenceDiagram.txt doit contenir un test très simple:

@startuml
Alice -> Bob: test
@enduml

L'option -verbose permet de générer des traces supplémentaires qui nous seront utiles si d'aventure aucune image n'était générée par la commande précédente.

Sous Unix, vous devez avoir les librairies X11 installées (ce qui est généralement le cas). Si ce n'est pas le cas, vous risquez d'avoir une erreur HeadlessException. Dans ce cas, vous pourriez avoir à rajouter l'option -Djava.awt.headless=true dans la ligne de commande.

Si l'image est bien générée, mais que cela ne fonctionne pas dans votre outil intégrant PlantUML, il s'agit probablement d'une erreur spécifique à votre outil.

Sous MediaWiki et Windows, vous devez donner les droits de lecture et d'exécution à C:\Windows\system32\cmd.exe pour le compte qui fait tourner le Service Web PHP. PHP a besoin de ces permissions pour lancer d'autres processus.

WARNING
 This translation need to be updated. 
WARNING

Sequence Diagram

Once installation is complete you should first try creating some Sequence Diagrams. Since these work without Graphviz this is the fastest way to check that the installation worked. If they do not work, other diagrams will probably not work.

You should make sure to test Sequence Diagrams using the command line and not in the target tool you want to install (Eclipse, Word, Mediawiki...) :

java -jar plantuml.jar -verbose sequenceDiagram.txt

In the sequenceDiagram.txt file, you can have a very simple test:

@startuml
Alice -> Bob: test
@enduml

The -verbose flag is used to generated some logs that you can send to us, if no image is generated.

Under Unix, you must have X11 librairies installed (which is done by default). Otherwise, you will have some HeadlessException. You may have to add a flag -Djava.awt.headless=true in the command line.

If this is working, but not in your tool, it is probably due to a specific tool issue:

On MediaWiki & Windows, you must set the read & execute permissions on C:\Windows\system32\cmd.exe for the account the PHP web service extension is running under. PHP needs those permissions to "fork" other processes.

Autres type de diagrammes

Une fois que les diagrammes de séquence fonctionnent correctement, vous pouvez vous intéresser aux autres types de diagrammes.

Si Graphviz n'est pas disponible sur votre système, vous devez commencer par l'installer.

Sous Linux, essayer de lancer la commande dot dans une ligne de commande shell. Il est possible que vous ayez à finaliser l'installation en tapant dot -c.

Vous devriez aussi peut-être régler la variable GRAPHVIZ_DOT si Graphviz n'est pas installé dans son répertoire par défaut.

Pour tester l'installation de Graphviz, vous pouvez utiliser la ligne de commande suivante:

java -jar plantuml.jar -testdot

Vous pouvez aussi utiliser le diagramme spécial suivant:

@startuml
testdot
@enduml

Là encore, vous pouvez utiliser l'option -verbose dans la ligne de commande:

java -jar plantuml.jar -verbose classDiagram.txt

Le fichier classDiagram.txt peut être très simple:

@startuml
A <|-- B
@enduml

Si cela ne fonctionne toujours pas, vous pouvez nous envoyer un email.

Other Diagrams

Once sequence diagrams are working fine, you can focus on other diagrams.

If Graphviz is not installed on your system, you have to install it first.

Under Linux, try to launch dot command into a command shell. You may have to finalize the installation by typing dot -C.

You may have to set GRAPHVIZ_DOT variables if you have not chosen the default installation directory of Graphviz.

To test the installation of Graphviz, you can use the command line:

java -jar plantuml.jar -testdot

You can also use this special diagram description:

@startuml
testdot
@enduml

Once again, you should test using the command line and the -verbose flag:

java -jar plantuml.jar -verbose classDiagram.txt

The classDiagram.txt file can be very simple:

@startuml
A <|-- B
@enduml

If you still have issues, then you can send us a mail.


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.