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


インストールに関するメモ

WARNING
 This translation need to be updated. 
WARNING

Local Installation notes

シーケンス図

もし、シーケンス図自体に興味がないとしても、最初はシーケンス図に注目してください。シーケンス図はGraphvizがなくても使用できるのでセットアップが簡単です。そして、もしこれが動作しないなら、おそらく他の図も使えません

そして、シーケンス図を、実際に導入したいツール(Eclipse、Word、MediaWiki……)からではなく、コマンドラインからテストしてみましょう。:

java -jar plantuml.jar -verbose sequenceDiagram.txt

sequenceDiagram.txtには、シンプルなテストを記述しておきます:

@startuml
Alice -> Bob: test
@enduml

-verboseフラグを指定すると、ログが生成されます。もし画像が出力されないときは、ログの内容を添えて問い合わせてください。

Unixでは、X11ライブラリがインストールされている必要があります(デフォルトで入っているはずです)。インストールされていない場合は、HeadlessExceptionが発生します。 その場合、コマンドライン-Djava.awt.headless=trueフラグを追加します。

コマンドラインでは動作するけれど、他のツールで動作しない場合は、そのツールに特有の問題かもしれません:

MediaWikiとWindowsの環境では、PHP web service extensionを実行しているアカウントに対して、C:\Windows\system32\cmd.exeの読み込み権限と実行権限を付与する必要があります。PHPはプロセスをフォークするために、これらの権限を必要とします。
WARNING
 This translation need to be updated. 
WARNING

Sequence Diagram

Once installation is complete you should first try creating some Sequence Diagrams. Since these work without Graphviz this is the fastest way to check that the installation worked. If they do not work, other diagrams will probably not work.

You should make sure to test Sequence Diagrams using the command line and not in the target tool you want to install (Eclipse, Word, Mediawiki...) :

java -jar plantuml.jar -verbose sequenceDiagram.txt

In the sequenceDiagram.txt file, you can have a very simple test:

@startuml
Alice -> Bob: test
@enduml

The -verbose flag is used to generated some logs that you can send to us, if no image is generated.

Under Unix, you must have X11 librairies installed (which is done by default). Otherwise, you will have some HeadlessException. You may have to add a flag -Djava.awt.headless=true in the command line.

If this is working, but not in your tool, it is probably due to a specific tool issue:

On MediaWiki & Windows, you must set the read & execute permissions on C:\Windows\system32\cmd.exe for the account the PHP web service extension is running under. PHP needs those permissions to "fork" other processes.

その他のダイアグラム

シーケンス図が動作するようになったら他の図に移りましょう。

システムにGraphvizがインストールされていなければ、まずはインストールしてください

Linuxの場合、コマンドシェルでdotコマンドを実行してみてください。インストールを完了するにはdot -Cを実行する必要があるかもしれません。

Graphvizのデフォルトインストールディレクトリを選択しなかった場合、GRAPHVIZ_DOT変数を設定する必要があるかもしれません。

Graphvizのインストールをテストするには、次のコマンドを使用します:

java -jar plantuml.jar -testdot

次の特別はダイアグラムを使用することもできます:

@startuml
testdot
@enduml

繰り返しになりますが、テストはコマンドラインで行い、-verboseフラグを使用してください:

java -jar plantuml.jar -verbose classDiagram.txt

classDiagram.txtファイルはシンプルな内容で構いません:

@startuml
A <|-- B
@enduml

まだ問題があるようでしたら、メールで問い合わせることもできます。

Other Diagrams

Once sequence diagrams are working fine, you can focus on other diagrams.

If Graphviz is not installed on your system, you have to install it first.

Under Linux, try to launch dot command into a command shell. You may have to finalize the installation by typing dot -C.

You may have to set GRAPHVIZ_DOT variables if you have not chosen the default installation directory of Graphviz.

To test the installation of Graphviz, you can use the command line:

java -jar plantuml.jar -testdot

You can also use this special diagram description:

@startuml
testdot
@enduml

Once again, you should test using the command line and the -verbose flag:

java -jar plantuml.jar -verbose classDiagram.txt

The classDiagram.txt file can be very simple:

@startuml
A <|-- B
@enduml

If you still have issues, then you can send us a mail.


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