plantuml

<a id="x-2840ANTS-PLANTUML-DOCS-2FINDEX-3A-40README-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

# 40ants-plantuml - Wrapper around PlantUML jar library

<a id="40-ants-plantuml-asdf-system-details"></a>

## 40ANTS-PLANTUML ASDF System Details

* Description: Wrapper around Plant`UML` jar library
* Licence: Unlicense
* Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
* Homepage: [https://40ants.com/plantuml][577d]
* Bug tracker: [https://github.com/40ants/plantuml/issues][d36f]
* Source control: [GIT][aa24]
* Depends on: [alexandria][8236], [serapeum][c41d]

[![](https://github-actions.40ants.com/40ants/plantuml/matrix.svg?only=ci.run-tests)][727f]

![](http://quickdocs.org/badge/40ants-plantuml.svg)

<a id="x-2840ANTS-PLANTUML-DOCS-2FINDEX-3A-3A-40INSTALLATION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## Installation

You can install this library from Quicklisp, but you want to receive updates quickly, then install it from Ultralisp.org:

```
(ql-dist:install-dist "http://dist.ultralisp.org/"
                      :prompt nil)
(ql:quickload :40ants-plantuml)
```
<a id="x-2840ANTS-PLANTUML-DOCS-2FINDEX-3A-3A-40USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## Usage

To make a diagram, first you need to download `JAR` file with
Java program `PlantUML` from official site https://plantuml.com/.

Then you'll have to set a path to this `JAR` file like this:

```
CL-USER> (setf 40ants-plantuml:*path-to-jar*
               "~/plantuml-mit-1.2024.8.jar")
```
And of cause you will need some Java implementation suitable
for running this `JAR` file.

Here is how to render a sequence diagram to `PNG` file:

```
CL-USER> (40ants-plantuml:render "
  @startuml
  CommoLisp -> PlantUML : render
  activate PlantUML
  return PNG file
  @enduml
  "

#P"/tmp/diagram.png")
; No values
```
It will render an image like this:

![](/home/runner/work/plantuml/plantuml/docs/images/diagram.png)

<a id="x-2840ANTS-PLANTUML-DOCS-2FINDEX-3A-3A-40API-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## API

<a id="x-2840ANTS-PLANTUML-DOCS-2FINDEX-3A-3A-4040ANTS-PLANTUML-3FPACKAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

### 40ANTS-PLANTUML

<a id="x-28-23A-28-2815-29-20BASE-CHAR-20-2E-20-2240ANTS-PLANTUML-22-29-20PACKAGE-29"></a>

#### [package](5fb9) `40ants-plantuml`

<a id="x-2840ANTS-PLANTUML-DOCS-2FINDEX-3A-3A-7C-4040ANTS-PLANTUML-3FFunctions-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

#### Functions

<a id="x-2840ANTS-PLANTUML-3ARENDER-20FUNCTION-29"></a>

##### [function](29dc) `40ants-plantuml:render` diagram-code output-filename

<a id="x-2840ANTS-PLANTUML-DOCS-2FINDEX-3A-3A-7C-4040ANTS-PLANTUML-3FVariables-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

#### Variables

<a id="x-2840ANTS-PLANTUML-3A-2APATH-TO-GRAPHVIZ-2A-20-28VARIABLE-29-29"></a>

##### [variable](4912) `40ants-plantuml:*path-to-graphviz*` nil

If given, should be a path to `dot` binary of Graphviz. Will be passed as -graphvizdot option to the `PlantUML`.

<a id="x-2840ANTS-PLANTUML-3A-2APATH-TO-JAR-2A-20-28VARIABLE-29-29"></a>

##### [variable](2c0c) `40ants-plantuml:*path-to-jar*` nil

Set this variable to a path to the plantuml.jar. Note, there are different builds of plantuml with different licensing.

If this variable is `NIL`, then /usr/share/plantuml/plantuml.jar will be used if it is exists. On Ubuntu this file
is created when use do `apt install plantuml`. Note, the version of the `PlantUML` in the Ubuntu package could be outdated
and missing some important features.


[577d]: https://40ants.com/plantuml
[aa24]: https://github.com/40ants/plantuml
[727f]: https://github.com/40ants/plantuml/actions
[5fb9]: https://github.com/40ants/plantuml/blob/edd9c276a09236d82a39c085ddd134d44dda349b/src/core.lisp#L1
[2c0c]: https://github.com/40ants/plantuml/blob/edd9c276a09236d82a39c085ddd134d44dda349b/src/core.lisp#L17
[4912]: https://github.com/40ants/plantuml/blob/edd9c276a09236d82a39c085ddd134d44dda349b/src/core.lisp#L26
[29dc]: https://github.com/40ants/plantuml/blob/edd9c276a09236d82a39c085ddd134d44dda349b/src/core.lisp#L50
[d36f]: https://github.com/40ants/plantuml/issues
[8236]: https://quickdocs.org/alexandria
[c41d]: https://quickdocs.org/serapeum

* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]


40ants-asdf-system

40ants-plantuml/core

40ants-plantuml

40ants-ci

40ants-plantuml-ci/ci

Provides CI settings for 40ants-plantuml.

40ants-plantuml-ci

40ants-ci/jobs/docs

40ants-ci/jobs/linter

40ants-ci/jobs/run-tests

40ants-ci/workflow

alexandria

serapeum

40ants-plantuml-docs/index

Provides documentation for 40ants-plantuml.

40ants-plantuml-docs

40ants-doc/changelog

40ants-plantuml-docs/changelog

40ants-doc

40ants-doc/autodoc

docs-config

named-readtables

pythonic-string-reader

quicklisp

40ants-plantuml-tests/core

40ants-plantuml-tests

rove

plantuml

Upstream URL

Author

License

40ants-plantuml

License:

Authors:

Defsystem Dependencies:

Dependencies:

40ants-plantuml-ci

License:

Authors:

Dependencies:

40ants-plantuml-ci/ci

Dependencies:

40ants-plantuml/core

Dependencies:

40ants-plantuml-docs

License:

Authors:

Dependencies:

40ants-plantuml-docs/changelog

Dependencies:

40ants-plantuml-docs/index

Dependencies:

40ants-plantuml-tests

License:

Authors:

Dependencies:

40ants-plantuml-tests/core

Dependencies:

Dependencies (9)

Dependents (1)