Each diagram description begins with the keyword @startuml
then ends with the keyword @enduml.
You can refer to the PlantUML Language Reference Guide.
Thoses descriptions may be included into :
- Text files (.txt),
- Html files (.html or .htm),
- Java sources files (.java), C/C++ source files (.c, .h, .cpp)
- LaTeX sources files (.tex),
- APT files(.apt)
- Word files(.doc)
- URL
Of course, if you use Html, LaTeX, APT or Java/C/C++ files, you should put diagram descriptions into comments.
File naming
By default, .png file have the same name as the
source file used to generated them (only the extension changes).
An automatic sequence is added if a source file contains several
occurences of @startuml.
It is possible to use a different file name for the .png
file. For example:
@startuml image.pngAlice->Bob: Authentication RequestBob-->Alice: Authentication Response@endumlIn this example, the .png file will be named image.png.
(Please note that you should not use this feature with Word integration.)
