📐 PlantUML
===========

We're running a `PlantUML Server <https://plantuml.confirm.ch/>`_ to create our own `PlantUML <https://plantuml.com/>`_ diagrams.

.. hint:: 

    The PlantUML server is deployed in the `PlantUML Server GitLab project <https://gitlab.confirm.ch/confirm/plantuml>`_ and is only available from within private networks.

Use PlantUML
------------

You can either use the Web UI of the `PlantUML Server`_ or you can use our :ref:`tools:plantuml-client` CLI script.

PlantUML documentation
----------------------

Since the official docs are quite "adventurous" to understand, you might want to have a look at :doc:`plantuml:index`. 
Some interesting chapters are:

- :doc:`plantuml:diagrams/index`
- :doc:`plantuml:formatting/index`
- :doc:`plantuml:formatting/color-names`
- :doc:`plantuml:formatting/creole`
- :doc:`plantuml:formatting/all-skin-params`

The official documentation for PlantUML can be found here:

- `PDF Guide <http://plantuml.com/guide>`_ (*good for starting*)
- `PlantUML`_ website
- `Standard Library <https://plantuml.com/stdlib>`_
- `Language specification <https://plantuml.com/sitemap-language-specification>`_
- `The Hitchhiker’s Guide to PlantUML <https://crashedmind.github.io/PlantUMLHitchhikersGuide/>`_

Sphinx
------

You can also build `PlantUML`_ diagrams in your docs. Just have a look at the :ref:`Documentation` chapter.