texlive[47089] Master/texmf-dist: plantuml (23mar18)

commits+karl at tug.org commits+karl at tug.org
Fri Mar 23 22:43:21 CET 2018 

Revision: 47089
          http://tug.org/svn/texlive?view=revision&revision=47089
Author:   karl
Date:     2018-03-23 22:43:20 +0100 (Fri, 23 Mar 2018)
Log Message:
-----------
plantuml (23mar18)

Modified Paths:
--------------
    trunk/Master/texmf-dist/doc/lualatex/plantuml/CHANGELOG.md
    trunk/Master/texmf-dist/doc/lualatex/plantuml/README.md
    trunk/Master/texmf-dist/doc/lualatex/plantuml/plantuml.pdf
    trunk/Master/texmf-dist/tex/lualatex/plantuml/plantuml.sty

Added Paths:
-----------
    trunk/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations--svg.png
    trunk/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png

Modified: trunk/Master/texmf-dist/doc/lualatex/plantuml/CHANGELOG.md
===================================================================
--- trunk/Master/texmf-dist/doc/lualatex/plantuml/CHANGELOG.md	2018-03-23 21:43:01 UTC (rev 47088)
+++ trunk/Master/texmf-dist/doc/lualatex/plantuml/CHANGELOG.md	2018-03-23 21:43:20 UTC (rev 47089)
@@ -4,6 +4,13 @@
 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 @@
 
 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

Modified: trunk/Master/texmf-dist/doc/lualatex/plantuml/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/lualatex/plantuml/README.md	2018-03-23 21:43:01 UTC (rev 47088)
+++ trunk/Master/texmf-dist/doc/lualatex/plantuml/README.md	2018-03-23 21:43:20 UTC (rev 47089)
@@ -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 @@
 
 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}
+ at startuml
+class Car
+
+Driver - Car : drives >
+Car *- Wheel : have 4 >
+Car -- Person : < owns
+ at 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+`

Added: trunk/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations--svg.png
===================================================================
(Binary files differ)

Index: trunk/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations--svg.png
===================================================================
--- trunk/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations--svg.png	2018-03-23 21:43:01 UTC (rev 47088)
+++ trunk/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations--svg.png	2018-03-23 21:43:20 UTC (rev 47089)

Property changes on: trunk/Master/texmf-dist/doc/lualatex/plantuml/example-class-relations--svg.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png
===================================================================
(Binary files differ)

Index: trunk/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png
===================================================================
--- trunk/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png	2018-03-23 21:43:01 UTC (rev 47088)
+++ trunk/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png	2018-03-23 21:43:20 UTC (rev 47089)

Property changes on: trunk/Master/texmf-dist/doc/lualatex/plantuml/example-minimal.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Modified: trunk/Master/texmf-dist/doc/lualatex/plantuml/plantuml.pdf
===================================================================
(Binary files differ)

Modified: trunk/Master/texmf-dist/tex/lualatex/plantuml/plantuml.sty
===================================================================
--- trunk/Master/texmf-dist/tex/lualatex/plantuml/plantuml.sty	2018-03-23 21:43:01 UTC (rev 47088)
+++ trunk/Master/texmf-dist/tex/lualatex/plantuml/plantuml.sty	2018-03-23 21:43:20 UTC (rev 47089)
@@ -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

More information about the tex-live-commits mailing list