# plantuml > A LuaLaTeX package for PlantUML in LaTeX [PlantUML](http://plantuml.com/) is a program which transforms text into UML diagrams. This package allows for embedding PlantUML diagrams using the PlantUML source. Currently, this project runs with [lualatex](http://www.luatex.org/) only. Check [issue #1](https://github.com/latextemplates/plantuml/issues/1) for the current state of affairs for support pdflatex. ## Preconditions 1. Environment variable `PLANTUML_JAR` set to the location of `plantuml.jar`. You get it from . 2. Enviroment variable `GRAPHVIZ_DOT` set to the location of `dot.exe`. Example: `C:\Program Files (x86)\Graphviz2.38\bin\dot.exe`. You can install graphviz using `choco install graphviz`. 3. lualatex available with command line parameter `-shell-escape` included. 4. In case you want to have the images as PDFs (and not using TikZ or PNG), ensure that `inkscape.exe` and `pdfcrop` are in your path. You can get inkscape using `choco install inkscape`. `pdfcrop` should be part of your latex distribution. ## Examples ### Minimal Example **LaTeX source:** ```latex \documentclass{scrartcl} \usepackage{plantuml} \begin{document} \begin{plantuml} @startuml Alice -> Bob: test @enduml \end{plantuml} \end{document} ``` **Compilation:** `lualatex -shell-escape example-minimal` **Result:** ![example minimal](example-minimal.png) ### Example Class Relations Rendered using SVG **LaTeX source:** ```latex \documentclass{scrartcl} \usepackage{graphics} \usepackage{epstopdf} \epstopdfDeclareGraphicsRule{.svg}{pdf}{.pdf}{% inkscape -z -D --file=#1 --export-pdf=\jobname-plantuml-svg.pdf && pdfcrop \jobname-plantuml-svg.pdf \OutputFile } \usepackage[output=svg]{plantuml} \begin{document} \begin{plantuml} @startuml class Car Driver - Car : drives > Car *- Wheel : have 4 > Car -- Person : < owns @enduml \end{plantuml} \end{document} ``` **Compilation:** `lualatex -shell-escape example-class-relations` **Result:** ![example minimal](example-class-relations.png) ## Installation Your latex distribution should take care. For manual installation, copy `plantuml.*` to your local texmf folder in the subdirectoy `tex/latex/plantuml`. See [the discussion at tex.sx](https://tex.stackexchange.com/q/27982/9075) for the concrete location of the folder on your system. ## Development ### Releasing - `ctanify --notds plantuml.sty plantuml.lua README.md "*.png" "example-*.tex"` ## License `SPDX-License-Identifier: LPPL-1.3c+`