Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    Recent changes    View page history    Add new chapter    Reorder page    Raw


言語

PlantUML言語のシンタックスハイライトを実装したエディタが存在します(こちらを参照)。

しかし、PlantUML言語の定義は今もなお変更され続けているので、言語に新しいキーワードが追加されると、既存のプロダクトにとっては問題です。

コマンドラインの隠しオプションを使って、この問題を回避できます:

java -jar plantuml.jar -language

このコマンドは、標準出力に、PlantUML言語に関する簡単にパースできる記述を出力します:

;type
;10
abstract
actor
class
component
enum
interface
object
participant
state
usecase

;keyword
;43
@enduml
@startuml
activate
alt
[..]
up

;preprocessor
;6
!define
!endif
!ifdef
!ifndef
!include
!undef

;skinparameter
;145
ActivityArrowFontColor
ActivityArrowFontName
[..]
UsecaseStereotypeFontSize
UsecaseStereotypeFontStyle

;color
;140
AliceBlue
AntiqueWhite
Aqua
[..]
WhiteSmoke
Yellow
YellowGreen

;EOF

PlantUML言語を使って何かをする必要がある場合は、この出力を、その都度パースしてください。plantuml.jarの新しいバージョンがアップロードされるたびに、プロダクトを最新の状態にすることができます。

Language

Some editors integrate PlantUML Language highlighting for text files (See here).

Since the PlantUML Language definition is still in progress, when new keywords are added in the language, it could be an issue for existing products.

An hidden option in the command line allows to turn around this:

java -jar plantuml.jar -language

This command will output to the standard output a description of the PlantUML Language, quite easy to parse:

;type
;10
abstract
actor
class
component
enum
interface
object
participant
state
usecase

;keyword
;43
@enduml
@startuml
activate
alt
[..]
up

;preprocessor
;6
!define
!endif
!ifdef
!ifndef
!include
!undef

;skinparameter
;145
ActivityArrowFontColor
ActivityArrowFontName
[..]
UsecaseStereotypeFontSize
UsecaseStereotypeFontStyle

;color
;140
AliceBlue
AntiqueWhite
Aqua
[..]
WhiteSmoke
Yellow
YellowGreen

;EOF

So, if you need to do something related to the PlantUML Language, you can parse on the fly this output: your product will always be up-to-date when people will upload the last plantuml.jar version.

文法チェック

テキストが有効なPlantUMLの記述かどうかを確認したい場合、次のコマンドを使うことができます:

type mytext.txt | java -jar plantuml.jar -syntax

標準出力に、基本的な情報が出力されます。1行目には次のいずれかの単語が書かれています:SEQUENCESTATECLASSOBJECTACTIVITYUSECASECOMPONENTOTHERERROR

: (この場合、@startumlは省略可能です)

次のテキストを与えると、

Bob -> Alice : hello

出力は次のようになります:

SEQUENCE
(2 participants)

テキスト中にエラーが存在する場合、行番号とエラーの内容が表示されます:

actor Bob
actor Bob
Bob -> Alice : hello

出力は次のようになります:

ERROR
2
Duplicate participant : Bob

Syntax check

If you have a text, and if you want to know if this text is a valid PlantUML description, you can use the following command:

type mytext.txt | java -jar plantuml.jar -syntax

This prints basic information to the standard output. The first line contains one of the following words :SEQUENCE, STATE, CLASS, OBJECT, ACTIVITY, USECASE, COMPONENT, OTHER or ERROR

Examples: (@startuml are optional in that usage)

The following text:

Bob -> Alice : hello

will output:

SEQUENCE
(2 participants)

If there is an error in the text, the line number and the description of the error is printed:

actor Bob
actor Bob
Bob -> Alice : hello

will output:

ERROR
2
Duplicate participant : Bob


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.