@startuml
then ends with the keyword @enduml
or (@startXYZ
and @endXYZ
, depending of the kind of diagram). You can refer to the PlantUML Language Reference Guide. Those descriptions may be included into: .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 instances of @startXXX
. It is possible to use a different file name for the generated file. For example: @startuml image.png
Alice->Bob: Authentication Request
Bob-->Alice: Authentication Response
@enduml
In this example, the .png
file will be named image.png
. (Please note that you should not use this feature with Word integration.) id=<identifier>
), as: Example with a file named file.pu
: @startuml(id=TAG1)
Alice->Bob : TAG1
@enduml
@startuml(id=TAG2)
Alice->Bob : TAG2
@enduml
Then you can include, on one another file, one id
part with !include <filemane>!<id>
command: @startuml
!include file.pu!TAG2
Alice->Bob : hello
@enduml
The corresponding generated output will be: 🎉 Copied! |
![]() |
def
) some part on a file with an identifier
between the tags @startdef(id=<identifier>)
and @enddef
. Then you can include, on the same file, only one definition part with !includedef <identifier>
command. Example on a file named file.pu
: 🎉 Copied! |
![]() |
file_001.png
, as: 🎉 Copied! |
![]() |
{
and }
. Only the first (<filename>
) is relevant for PlantUML, the others are just skipped, and can be use by other tools. @startuml{filename.png, This is my other caption text, width=16cm, option_for_other_tools=value}
@enduml
[Ref. QA-1466]pipe
modepipe
mode. To specify the output format (PNG
or SVG
), on pipe
mode, you can add this command on the input: @@@format png
or
@@@format svg
[Ref. QA-10808]