diff options
| author | albert-github <albert.tests@gmail.com> | 2021-04-04 16:55:21 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2021-04-04 16:55:21 (GMT) |
| commit | afa248d63e73886a6f0dc0cdb285d18959a0a963 (patch) | |
| tree | 7e071ac6d5a1b386b87c13442b566e90ada9b34d /doc | |
| parent | 97415f7b4504d2be65338464731d7bbb4aa4d993 (diff) | |
| download | Doxygen-afa248d63e73886a6f0dc0cdb285d18959a0a963.zip Doxygen-afa248d63e73886a6f0dc0cdb285d18959a0a963.tar.gz Doxygen-afa248d63e73886a6f0dc0cdb285d18959a0a963.tar.bz2 | |
Extending startuml with extra figure types
Not all diagrams can be created with the PlantUML `@startuml` command but need another
PlantUML `@start...` command. This wil look like `@start<engine>` where currently supported are
the following `<engine>`'s: `uml`, `bpm`, `wire`, `dot`, `ditaa`, `salt`, `math`, `latex`,
`gantt`, `mindmap`, `wbs`, `yaml`, `creole`, `json` and `flow`. By default the `<engine>` is
`uml`. The `<engine>` can be specified as an option.
Explicitly the option variant has been chosen so we won't get an explosion of extra commands.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 1465a1e..afbc786 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2907,19 +2907,31 @@ class Receiver \sa section \ref cmdmscfile "\\mscfile". <hr> -\section cmdstartuml \\startuml [{file}] ["caption"] [<sizeindication>=<size>] +\section cmdstartuml \\startuml ['{'option[,option]'}'] ["caption"] [<sizeindication>=<size>] \addindex \\startuml + Starts a text fragment which should contain a valid description of a PlantUML diagram. See https://plantuml.com/ for examples. The text fragment ends with \ref cmdenduml "\\enduml". \note You need to install Java and the PlantUML's jar file, - if you want to use this command. The location of the jar file should be specified - using \ref cfg_plantuml_jar_path "PLANTUML_JAR_PATH". + if you want to use this command. When using PlantUML in \LaTeX you have to download + some more `jar` files, for details see the PlantUML documentation. + The location of the jar file should be specified using + \ref cfg_plantuml_jar_path "PLANTUML_JAR_PATH". + + Not all diagrams can be created with the PlantUML `@startuml` command but need another + PlantUML `@start...` command. This wil look like `@start<engine>` where currently supported are + the following `<engine>`'s: `uml`, `bpm`, `wire`, `dot`, `ditaa`, `salt`, `math`, `latex`, + `gantt`, `mindmap`, `wbs`, `yaml`, `creole`, `json` and `flow`. By default the `<engine>` is + `uml`. The `<engine>` can be specified as an option. + Also the file to write the resulting image to can be specified by means of an option, see the + description of the first (optional) argument for details. + Of course only one `<engine>` can be specified and also the filename can only be specified once. The first argument is optional and is for compatibility with running PlantUML as a preprocessing - step before running doxygen, you can also add the name of the image file after \c \\startuml - and inside curly brackets, i.e. + step before running doxygen, you can also add the name of the image file after `\startuml` + and inside curly brackets as option, i.e. \verbatim @startuml{myimage.png} "Image Caption" width=5cm Alice -> Bob : Hello |