template.markdown.plantuml.plantuml-core.README.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of credible-doc-generator Show documentation

This module generates documentation for the https://github.com/credibledoc/credible-doc repository projects. See description on the https://github.com/credibledoc/credible-doc page.

There is a newer version: 1.0.51

Show newest version

# Module plantuml-core

This module contains services for generating [plantUml](http://plantuml.com) diagrams
from plantUml notations.

For launching the generator, the Graphviz tool should be installed,
see the [http://plantuml.com/graphviz-dot](http://plantuml.com/graphviz-dot) documentation.
Graphviz is optional if you only need sequence diagrams and activity (beta) diagrams.

## Downloading
This module can be downloaded from the
[Maven Central Repository plantuml-core](https://mvnrepository.com/artifact/com.credibledoc/plantuml-core)

Maven dependency:

    
        com.credibledoc
        plantuml-core
        &&beginPlaceholder {
                "className": "com.credibledoc.substitution.content.generator.pom.JarNameContentGenerator",
                "description": "Latest version of the plantuml-core artifact in Maven Central Repository",
                "parameters": {
                    "url": "https://repo1.maven.org/maven2/com/credibledoc/plantuml-core/maven-metadata.xml",
                    "versionOnly": "true"
                }
         } &&endPlaceholder
    

## Example of usage
    String svg = SvgGeneratorService.getInstance().generateSvgFromPlantUml(plantUml);

Where the _**plantUml**_ parameter can be, for example,

    Bob -> Alice : hello
    Alice -> Bob : hi

Then the returned _**String svg**_ in this case will be

    

And generated svg file then looks like the next example

![An UML diagram that describes, how the generated content looks like](doc/img/example.svg?sanitize=true)

## Parent module
See the [plantuml-parent README.md](../README.md) file.