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    View page history    Add new chapter    Reorder page    Raw


PlantUML Server

PlantUML Server

オンザフライでイメージを生成するのに、オンラインの Web サービスとして PlantUML を使うことができます。オンラインのデモンストレーションは http://www.plantuml.com/plantuml から試すことができます。また、手元の JEE Web アプリケーションサーバに PlantUML を インストール することもできます。

JEEアプリケーションサーバをインストールしたくない場合は、PlantUML PicoWeb Serverをローカルで実行することもできます。

You can use PlantUML using the online web service to generate images on-the-fly. A online demonstration is available at http://www.plantuml.com/plantuml, but you can also install it on your own JEE web application server.

If you don't want to install a full JEE application server, you may also choose to run PlantUML PicoWeb Server locally.

対話型インターフェース

Interactive interface

大きな入力フィールドはダイアグラムを記述するためのものです。任意のダイアグラムを入力してからsubmitボタンを押すと、下部に図が表示されます。 ダイアグラムは@startxxxキーワードで開始するように習慣づけると良いでしょう。

ダイアグラムを検証すると、そのダイアグラムをエンコードしたURLにリダイレクトされます。エンコード形式は複数行からなるダイアグラムよりも短くなるため、共有するのに適した形式です。また、ブラウザを使ってオンラインのPlantUMLサーバ上で簡単に表示することができます。

例えば、SyfFKj2rKt3CoKnELR1Io4ZDoSa70000は次のダイアグラムをエンコードしたものです:

@startuml
Bob -> Alice : hello
@enduml

The big input field is used to enter your diagram description. You can type in any diagram description, then press the submit button and the diagram will be displayed below. It's a good practice to start your diagram by the @startxxx keyword.

When you validate the diagram, you are redirected to an encoded URL encoding your diagram. The encoded form is a convenient way to share your diagrams with others because it's shorter than the many lines of a diagram and it can be easily displayed in a browser using the online PlantUML Server.

For example, SyfFKj2rKt3CoKnELR1Io4ZDoSa70000 is the encoded form of:

@startuml
Bob -> Alice : hello
@enduml

初期表示するダイアグラム

Specify an initial diagram

デフォルトでは、PlantUMLサーバはBob -> Aliceのシーケンス図をサンプルとして表示します。しかし、ダイアグラムのエンコード形式を使用して他のダイアグラムを初期表示することもできます。 URLに/uml/ENCODEDを追加してください。

例えば、次のリンクhttp://www.plantuml.com/plantuml/uml/Aov9B2hXil98pSd9LoZFByf9iUOgBial0000では、シンプルなHello Worldのアクティビティ図を表示したPlantUMLサーバが開かれます。

By default, the PlantUML Server shows the well-known Bob -> Alice sample but it's easy to invoke it with an other diagram using its encoded form. Just append /uml/ENCODED to the URL.

For example, this link http://www.plantuml.com/plantuml/uml/Aov9B2hXil98pSd9LoZFByf9iUOgBial0000 opens the PlantUML Server with a simple Hello World activity diagram.

メタデータ

Metadata

PlantUMLは生成したPNGのメタデータに、ダイアグラムのソースコードをエンコードテキスト形式で保存します。そのため、画像のURLをクエリパラメータのmetadataとして与えることで、ソースコードを取り出すことが可能になっています。

例えば、http://i.stack.imgur.com/HJvKF.pngの画像からダイアグラムのソースコードを取り出したい場合、次のサーバリクエストを使います: http://www.plantuml.com/plantuml/?metadata=http://i.stack.imgur.com/HJvKF.png.

まるで魔法のようですが、これは非常に優れたエンジニアリングです :-)

PlantUML saves the diagram's source code in the generated PNG Metadata in the form of encoded text. So it is possible to retrieve this source by using the query parameter metadata, giving it some image URL.

For example, if you want to retrieve the diagram source of the image http://i.stack.imgur.com/HJvKF.png use the following server request: http://www.plantuml.com/plantuml/?metadata=http://i.stack.imgur.com/HJvKF.png.

Sounds like magic! No, merely clever engineering :-)

ウェブサービスモード

Web service mode

PlantUMLサーバのウェブサービスインターフェースは開発者向けに用意されています。

The web service interface of the PlantUML Server is dedicated to developers.

PNGサービス

PNG service

ダイアグラムをPNGファイルとして取得するには、次のURLスキームを使用します: /plantuml/png/ENCODED

To get a PNG file of a diagram, use the following URL scheme: /plantuml/png/ENCODED

SVGサービス

SVG service

ダイアグラムをSVG XMLファイルとして取得するには、次のURLスキームを使用します: /plantuml/svg/ENCODED

すべてのダイアグラムがSVGとして出力できるわけではありません。例えば、ditaaはPNG形式のみ利用可能です。

To get a SVG XML file of a diagram, use the following URL scheme: /plantuml/svg/ENCODED

Note that not all diagrams can be produced in SVG. For example, ditaa diagrams are only available in PNG format.

アスキーアートサービス

ASCII Art service

UTF-8でエンコードされたダイアグラムをアスキーアート形式で取得するには、次のURLスキームを使用します: /plantuml/txt/ENCODED

アスキーアートを生成できるダイアグラムはシーケンス図のみです。

To get an ASCII Art representation of a diagram, encoded in UTF-8, use the following URL scheme: /plantuml/txt/ENCODED

Note that only sequence diagrams can be produced in ASCII Art.

イメージマップサービス

Image Map service

前述のサービスで生成したPNG画像に対する、クライアントイメージマップを取得するには、次のURLスキームを使用します: /plantuml/map/ENCODED

<area>タグのリストが出力されます。各行が図の定義中に含まれるリンクに対応しています。

例えば次の:

@startuml
participant Bob [[http://plantuml.com]]
Bob -> Alice : [[http://forum.plantuml.net]] hello
@enduml

これにより、次の結果が得られます:

<map id="plantuml_map" name="plantuml_map">
<area shape="rect" id="id1" href="http://forum.plantuml.net" title="http://forum.plantuml.net" alt="" coords="38,50,199,65"/>
<area shape="rect" id="id2" href="http://plantuml.com" title="http://plantuml.com" alt="" coords="8,3,50,116"/>
</map>

完全なイメージマップを作るには、<area...タグを<map...タグの中に含める必要があることに注意してください。

To get the client image map related to a previously generated PNG image, use the following URL scheme: /plantuml/map/ENCODED

The output is a list of <area> tags, each line matching a link present in the diagram description.

For example, the following diagram:

@startuml
participant Bob [[http://plantuml.com]]
Bob -> Alice : [[http://forum.plantuml.net]] hello
@enduml

produces the following output:

<map id="plantuml_map" name="plantuml_map">
<area shape="rect" id="id1" href="http://forum.plantuml.net" title="http://forum.plantuml.net" alt="" coords="38,50,199,65"/>
<area shape="rect" id="id2" href="http://plantuml.com" title="http://plantuml.com" alt="" coords="8,3,50,116"/>
</map>

Note that you need to include these <area... tags inside a <map... html tag to make the complete image map.

プロキシサービス

Proxy service

プロキシサービスを使用すると、PlantUMLは、ダイアグラムのソースを別のサーバーにあるドキュメントから取ってくることができます。

プロキシサービスは、次のURLスキームを使用します: /plantuml/proxy?src=RESOURCE&idx=INDEX&fmt=FORMAT

  • RESOURCEは、@startxxx@endxxxタグを含むダイアグラムの記述の書かれたドキュメントのURLです。.htmlまたは.txtファイルのURLを指定します。
  • INDEX(任意項目)は、リモートのドキュメントに複数のダイアグラムが記述されている場合に、何番目のダイアグラムかを指定します。数値は0始まりで、デフォルト値は0です。
  • FORMAT(任意項目)は、出力形式を指定します。pngsvgepsepstexttxtの値を指定できます。デフォルトはpngです。

次の例を試してください: http://www.plantuml.com/plantuml/proxy?src=https://raw.github.com/plantuml/plantuml-server/master/src/main/webapp/resource/test2diagrams.txt

リモートドキュメントのURLはパラメータとして指定するので、そのURL自体をURLエンコードする必要はありません。

WARNING
 This translation need to be updated. 
WARNING

With the proxy service, the source description of the diagram can be fetched by the PlantUML Server from a remote document.

The proxy service uses the following URL scheme: /plantuml/proxy?src=RESOURCE&idx=INDEX&fmt=FORMAT

  • RESOURCE is the complete URL of the document which contains the diagram description (with the @startxxx and @endxxx tags), it could be a .html or a .txt file.
  • INDEX is optional, it specifies the occurrence (starting at 0) of the diagram description that will be parsed when there are more than one diagram descriptions in the remote document. It defaults to zero.
  • FORMAT is optional, it specifies the format to return. Supported values are: png, svg, eps, epstext and txt. Default is png,

For example, try this link: http://www.plantuml.com/plantuml/proxy?src=https://raw.github.com/plantuml/plantuml-server/master/src/main/webapp/resource/test2diagrams.txt

Note that the address of the remote document is specified as a parameter, so it is not necessary to URL encode the URL.

PlantUMLサーバのインストール

Installation of the PlantUML Server

PlantUMLサーバをJEE 5ウェブサーバにインストールするには、plantuml.warをダウンロードし、そのファイルをwebappフォルダにコピーします。

PlantUMLサーバはTomcat 6、7、Jetty 8、9で正常に動作することがテストされています。

To install PlantUML Server on your own JEE 5 web server, download the plantuml.war file and copy it on the webapp folder of your server.

PlantUML Server have been successfully tested on Tomcat 6 and 7 and Jetty 8 and 9.

ソースコード

Source code

PlantUMLサーバはオープンソースです。ソースコードはhttps://github.com/plantuml/plantuml-serverにあります。

(メインソースはhttps://github.com/plantuml/plantumlにあります。)

PlantUML Server is open source, the code is available at https://github.com/plantuml/plantuml-server.

(The main source is at https://github.com/plantuml/plantuml)


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