From b8e8ec55085b8cae47c13224fdd739f7fd742928 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 23 Mar 2018 21:43:20 +0000 Subject: plantuml (23mar18) git-svn-id: svn://tug.org/texlive/trunk@47089 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/lualatex/plantuml/CHANGELOG.md | 10 ++- Master/texmf-dist/doc/lualatex/plantuml/README.md | 95 +++++++++++++++++++++ .../plantuml/example-class-relations--svg.png | Bin 0 -> 13997 bytes .../doc/lualatex/plantuml/example-minimal.png | Bin 0 -> 4829 bytes .../texmf-dist/doc/lualatex/plantuml/plantuml.pdf | Bin 45918 -> 47133 bytes .../texmf-dist/tex/lualatex/plantuml/plantuml.sty | 2 +- 6 files changed, 105 insertions(+), 2 deletions(-) create mode 100644 Master/texmf-dist/doc/lualatex/plantuml/example-class-relations--svg.png create mode 100644 Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png (limited to 'Master') diff --git a/Master/texmf-dist/doc/lualatex/plantuml/CHANGELOG.md b/Master/texmf-dist/doc/lualatex/plantuml/CHANGELOG.md index 14230fdd7cf..84d71627bbc 100644 --- a/Master/texmf-dist/doc/lualatex/plantuml/CHANGELOG.md +++ b/Master/texmf-dist/doc/lualatex/plantuml/CHANGELOG.md @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). +## [0.2.2] - 2017-03-22 + +## Changed + +- Added version number in generated plantuml.pdf. +- Do not strip down `README.md` for CTAN anymore and provide "*.png" for generation of `plantuml.pdf`. + ## [0.2.1] - 2017-03-21 ### Fixed @@ -26,6 +33,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). Initial public release -[Unreleased]: https://github.com/latextemplates/plantuml/compare/0.2.1...HEAD +[Unreleased]: https://github.com/latextemplates/plantuml/compare/0.2.2...HEAD +[0.2.2]: https://github.com/latextemplates/plantuml/compare/0.2.1...0.2.2 [0.2.1]: https://github.com/latextemplates/plantuml/compare/0.2.0...0.2.1 [0.2.0]: https://github.com/latextemplates/plantuml/compare/0.1.0...0.2.0 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 . +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+` diff --git a/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations--svg.png b/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations--svg.png new file mode 100644 index 00000000000..2461e00812f Binary files /dev/null and b/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations--svg.png differ 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/plantuml.pdf b/Master/texmf-dist/doc/lualatex/plantuml/plantuml.pdf index 3c3fa134fc9..2a1ba480cb4 100644 Binary files a/Master/texmf-dist/doc/lualatex/plantuml/plantuml.pdf and b/Master/texmf-dist/doc/lualatex/plantuml/plantuml.pdf differ diff --git a/Master/texmf-dist/tex/lualatex/plantuml/plantuml.sty b/Master/texmf-dist/tex/lualatex/plantuml/plantuml.sty index 2fb13e34644..46be759cfe5 100644 --- a/Master/texmf-dist/tex/lualatex/plantuml/plantuml.sty +++ b/Master/texmf-dist/tex/lualatex/plantuml/plantuml.sty @@ -3,7 +3,7 @@ %% SPDX-License-Identifier: LPPL-1.3c+ \NeedsTeXFormat{LaTeX2e}\relax \ProvidesPackage{plantuml} - [2018/03/21 v0.2.1 + [2018/03/22 v0.2.2 Embed PlantUML diagrams in latex documents.] % Required by PlantUML LaTeX output -- cgit v1.2.3