From da48a65f7e454f173c138f38ac4cc5661f4c1cea Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 8 Mar 2018 22:56:58 +0000 Subject: plantuml (8mar18) git-svn-id: svn://tug.org/texlive/trunk@46892 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/lualatex/plantuml/README.md | 94 +++++++++++++++++++++ .../lualatex/plantuml/example-class-relations.png | Bin 0 -> 13997 bytes .../lualatex/plantuml/example-class-relations.tex | 29 +++++++ .../doc/lualatex/plantuml/example-minimal.png | Bin 0 -> 4829 bytes .../doc/lualatex/plantuml/example-minimal.tex | 9 ++ 5 files changed, 132 insertions(+) create mode 100644 Master/texmf-dist/doc/lualatex/plantuml/README.md create mode 100644 Master/texmf-dist/doc/lualatex/plantuml/example-class-relations.png create mode 100644 Master/texmf-dist/doc/lualatex/plantuml/example-class-relations.tex create mode 100644 Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png create mode 100644 Master/texmf-dist/doc/lualatex/plantuml/example-minimal.tex (limited to 'Master/texmf-dist/doc/lualatex') diff --git a/Master/texmf-dist/doc/lualatex/plantuml/README.md b/Master/texmf-dist/doc/lualatex/plantuml/README.md new file mode 100644 index 00000000000..195ec4d06be --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/plantuml/README.md @@ -0,0 +1,94 @@ +# 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+` diff --git a/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations.png b/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations.png new file mode 100644 index 00000000000..2461e00812f Binary files /dev/null and b/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations.png differ diff --git a/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations.tex b/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations.tex new file mode 100644 index 00000000000..e5c131104db --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations.tex @@ -0,0 +1,29 @@ +\documentclass{scrartcl} + +\usepackage{graphics} + +% Enables inclusion of SVG graphics - 1:1 approach +% This is NOT the approach of http://www.ctan.org/tex-archive/info/svg-inkscape, +% which allows text in SVG to be typeset using LaTeX +% We just include the SVG as is +\usepackage{epstopdf} +\epstopdfDeclareGraphicsRule{.svg}{pdf}{.pdf}{% + inkscape -z -D --file=#1 --export-pdf=\jobname-plantuml-svg.pdf && + %due to https://bugs.launchpad.net/inkscape/+bug/1754167 we need to use pdfcrop + pdfcrop \jobname-plantuml-svg.pdf \OutputFile +} + +\usepackage[output=svg]{plantuml} +%\usepackage[output=latex]{plantuml} + +\begin{document} +\begin{plantuml} +@startuml +class Car + +Driver - Car : drives > +Car *- Wheel : have 4 > +Car -- Person : < owns +@enduml +\end{plantuml} +\end{document} diff --git a/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png b/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png new file mode 100644 index 00000000000..7699a8b1850 Binary files /dev/null and b/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png differ diff --git a/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.tex b/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.tex new file mode 100644 index 00000000000..36c0dac0143 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.tex @@ -0,0 +1,9 @@ +\documentclass{scrartcl} +\usepackage{plantuml} +\begin{document} +\begin{plantuml} +@startuml +Alice -> Bob: test +@enduml +\end{plantuml} +\end{document} -- cgit v1.2.3