summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/lualatex/plantuml/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/lualatex/plantuml/README.md')
-rw-r--r--Master/texmf-dist/doc/lualatex/plantuml/README.md95
1 files changed, 95 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/lualatex/plantuml/README.md b/Master/texmf-dist/doc/lualatex/plantuml/README.md
index ff607be7f9f..9559abfb23a 100644
--- a/Master/texmf-dist/doc/lualatex/plantuml/README.md
+++ b/Master/texmf-dist/doc/lualatex/plantuml/README.md
@@ -1,5 +1,7 @@
# plantuml
+Version 0.2.2
+
> A LuaLaTeX package for PlantUML in LaTeX
[PlantUML](http://plantuml.com/) is a program which transforms text into UML diagrams.
@@ -7,3 +9,96 @@ 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 <https://sourceforge.net/projects/plantuml/files/plantuml.jar/download>.
+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:**
+
+![Minimal example](example-minimal.png)
+
+### Example Class Relations Rendered Using SVG
+
+**LaTeX source:**
+
+```latex
+\documentclass{scrartcl}
+\usepackage{graphics}
+\usepackage{epstopdf}
+\epstopdfDeclareGraphicsRule{.svg}{pdf}{.pdf}{
+ inkscape -z --file=#1 --export-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:**
+
+![Class relations rendered using SVG](example-class-relations--svg.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
+
+The release is built at [CircleCI](http://circleci.com/) using `release.sh`.
+
+Release prepration:
+
+1. Adapt date and version number in `plantuml.sty`.
+1. Adapt `CHANGELOG.md`.
+1. Set a git tag and push.
+
+## Alternative Solutions
+
+[TikZ-UML](https://perso.ensta-paristech.fr/~kielbasi/tikzuml/) is a very powerful package based in [TikZ](https://www.ctan.org/pkg/pgf).
+More alternative solutions are collected at the [CTAN topic UML](https://www.ctan.org/topic/uml).
+
+## License
+
+`SPDX-License-Identifier: LPPL-1.3c+`