設定

このツールには何種類かの設定があります。これらの設定はすべて、ひとつの設定ダイアログの中の、何枚かのタブですべて変更できるようになっています。

• Global preferences(グローバル設定): これらの設定は一般的な動作と、アプリケーションの見た目についての変更を行うためのものです。これらの設定はユーザフォルダ(Unixであれば$HOME、WindowsであればApplication Data以下)の.sdedit.confというファイルに格納されます。もしもアプリケーションインストール時のデフォルトの設定にもどしたい場合には、"Restore defaults"ボタンを使用すると戻すことができます。

• Initial diagram preferences(初期図面設定): これらの設定は新規作成された図や、プレーンな(sd)ファイルをロードした時に適用されます。この設定も.sdedit.confの中に格納されます。また、“Save as inital”ボタンを使用すると、現在の図の設定を、初期図面設定として保存して使用することができます。もしもアプリケーションインストール時のデフォルトの設定にもどしたい場合には、"Restore defaults"ボタンを使用すると戻すことができます。

• Current diagram preferences(現在の図面設定): これらの設定は現在表示されている図にだけ適用されます。これらの設定は、図がsdxファイルとして保存されるときに一緒に保存されます。もしも、図をsdファイルとして保存される時には、これらの設定は失われます。

フィルタ機能

テキストエリアの中の内容を置換する機能があります。フィルタアイコンをクリックしたあとに、入力したコマンドの出力で置き換えます。もしもテキストが選択されていなければ、テキスト全体がコマンドの入力として使用され、そのコマンドの出力で置換されます。そうでない場合には、選択されたテキストのみが置換対象になります。

コマンドが入力されるフィールドが表示されたときには、ESCキーを押すと抜けることができます。また、ESCキーを押すと、入力されたが終わってないコマンドを終了させることもできます。この機能で入力されたコマンドのヒストリーを保持する機能もあります。これはカーソルの上下キーを使用することで見ることができます。

この機能は、ファイルをロードするためのファイルダイアログを開くのすら面倒な人がファイルを開くのに使用することもできます。例えば以下のように入力すると、テキストエリアにロードできます。

cat ~/my_diagram.sd

また、以下のサンプルは、テキストの単語を一括で置換するためのものです。

sed s/foo/bar/g

コメント行を削除するには、以下のようにします。

grep -v #

もちろん、ユーザの使用しているシステムで、cat, sed, grepが使用できるようになっている必要があります。

HTMLマップファイル

もしもシーケンス図の画像をウェブサイトで使用する場合には、ライフラインの頭をクリックすることで、特定のターゲットへのナビゲーションをしたりすることができます。このために、現在表示されている図からHTMLマップファイルを作成する機能が、Extrasメニューの中にあります。

マップファイルは<map>タグだけを持っています。<map>タグは図のそれぞれのオブジェクトをあらわす<area>タグを含んでいます。<area>タグのhref属性は、オブジェクトの名前同じになります。あるいは、オブジェクト宣言の後ろに'#!href="<url>"'が付加されるのであれば、自由に選択したURLを使用することができます:

object:Class #!href="../foo.html#bar"

Javadocタグレット

Quick Sequence Diagram Editorは、Javaのプログラムのドキュメント(javadoc)にシーケンス図を追加するのにも使用することができます。以下の二つのパラメータをjavadocのツールのコマンドで追加します:

-tagletpath <CLASSPATH> -taglet net.sf.sdedit.taglet.SequenceTaglet

<CLASSPATH>はQuick Sequence Editorのクラスファイルのパスを指定します。jarファイルもしくはbinディレクトリを指定することができます。もしもexeファイルを使用している場合には、申し訳ないですが指定することができません(訳注: jar版をダウンロードしてください)。

オプションを指定すると、@sequence.diagramタグを解釈できるようになり、シーケンス図を表現するテキストを読み込むことができるようになります。このタグからPNG画像ファイルが作成され、標準のdocletを使って生成されたHTMLのページの中に表示されます。画像ファイルは、javadocの出力先ディレクトリの中に保存されます。

@sequence.diagramの後ろにはクオーテーションでくくられた文字列が続きます。この文字列はシーケンス図の表題として使用されます。@sequence.diagramタグはパッケージの記述でも、クラス定義でも、どこに書くこともできます:

/**
  EnigmaDecoderの説明です。.
  ...

  @author アラン＝チューリング
  @sequence.diagram "EnigmaDecoderのインスタンス作成"
  a:A
  /decoder:EnigmaDecoder

  a:decoder.new
  @deprecated
    */

Javadocコメントにラインを付加するコードフォーマッターに注意してください。これによって、シーケンス図のテキストのフォーマットとしては文法を間違ったものが生成される可能性があります。

コマンドライン

sdeditはコマンドラインの中からも起動することができます。<起動コマンド>はjava -jar sdedit-3.0.jar, sdedit-3.0.exe, sdedit.bat, sdedit.shなどに置き換えて読んでください。Javaに詳しく、zip形式の配布物を利用している人は、java -classpath bin:lib/...とタイプして起動するかもしれません。ant run and startは<起動コマンド>としては動作しません。

シェルからsdeditを実行するポイントは、図のファイルからドキュメントか画像を自動的に作成できるというところにあります。

この機能を使用するためには、<起動コマンド>の後ろに、出力するファイル名を指定する、-oオプションを使用してください。PDF, PS, SVG, PNGなど、生成するファイルのタイプは、-tオプションで指定します。紙のフォーマットや向きは、-f, -rオプションを使用することで設定を行うことができます。図の設定を行うのに使用される、長いオプションのリストを見るには、-hオプションを追加して実行します

> <起動コマンド> -h
> <起動コマンド> -o /tmp/bfs.pdf -t pdf /tmp/examples/bfs.sd
> <起動コマンド> -o /tmp/ssh.ps -t ps -f A0 -r Landscape --threaded=false /tmp/examples/ssh.sd

オプションが設定されている場合には、入力ファイルはひとつだけしか指定することができません。オプションが使用されていない場合には、任意の数の入力ファイルを指定することができます。それぞれのファイルは別々のタブにロードされます。

RTダイアグラムサーバ

図の仕様をTCPのソケットから受信してリアルタイムに表示できる機能があります。一行受信すると、そのたびに図が更新されます。

この機能を使用するためには、Extrasメニューから"Start/stop RT server"を選択して、ポート番号を入力します。ポートにつなぐプロセスは、以下のような、非常にシンプルな単方向のプロトコルで通信しなければなりません。

• 最初の行は、新規に開かれる新しいタブ名として解釈されます
• 残りの行は新規に開かれたタブのテキストエリアに書き込まれていきます。
• "end"という単語が含まれる行が来たら、ソケットをクローズします。その行はテキストエリアには入力されません。

The server is started automatically if the “Autostart RT diagram server” flag is set to 1 in the configuration dialog.

設定ダイアログで"Autostart RT diagram server"のフラグが1に設定されると、起動時に自動的にサーバ機能がスタートします。