ノンミリ

こんにちは、これはnomnomlです。単純な構文に基づいて UML 図を描画するためのツールです。このツールは、ASCII 描画に頼ることなく、生成された UML 図に視覚的に可能な限り構文を近づけようとします。

Daniel Kallinによって作成され、Alexander Moosbruggerとkorrozによって寄稿されました。

Nomnoml was made possible by these cool projects

• ジソン
• ダグレ
• ロダッシュ
• タイピコン
• ゼプト
• コードミラー
• ソラライズされた

図書館

nomnomlスタンドアロン JavaScript ライブラリを使用して、独自の Web ページに図をレンダリングできます。唯一の依存関係は lodash と dagre です。npmまたは古き良きスクリプトインクルードを使用してインストールします。

SVG 出力での NodeJS の使用:

1
2
3
4
5
npm install nomnoml

var nomnoml = require('nomnoml');
var src = '[nomnoml] is -> [awesome]';
console.log(nomnoml.renderSvg(src));

Canvas レンダリング ターゲットでの HTML の使用:

1
2
3
4
5
6
7
8
9
10
<script src="lodash.js"></script>
<script src="dagre.js"></script>
<script src="nomnoml.js"></script>

<canvas id="target-canvas"></canvas>
<script>
    var canvas = document.getElementById('target-canvas');
    var source = '[nomnoml] is -> [awesome]';
    nomnoml.draw(canvas, source);
</script>

SVGのサポート

実験的な (完全な機能ではない) SVG レンダリング モードが機能として利用可能ですnomnoml.renderSvg。

コマンドラインインターフェース

dist/nomnoml-cli.jsコマンド ライン インターフェイスを使用して SVG レンダラーを公開します。このモードでは、#import: <filename>複雑な図を複数のファイルに分離できるディレクティブもサポートされています。

ウェブアプリケーション

nomnoml Web アプリケーションは、ライブ プレビューを備えたシンプルなエディターです。これは純粋にクライアント側であり、変更はブラウザーのlocalStorageに保存されるため、次回も図がここに表示されるはずです (ただし、保証はありません)。

Interaction

キャンバスの右側 3 分の 1 をドラッグしてスクロールすることで、キャンバスをパンしたりズームしたりできます。ダウンロードされた画像ファイルにはディレクティブでファイル名が付けられます#title。

Example

nomnoml 構文での Decorator パターンは次のようになります。

1
2
3
4
5
6
7
8
[<frame>Decorator pattern|
  [<abstract>Component||+ operation()]
  [Client] depends --> [Component]
  [Decorator|- next: Component]
  [Decorator] decorates -- [ConcreteComponent]
  [Component] <:- [Decorator]
  [Component] <:- [ConcreteComponent]
]

Association types

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
-    association
->   association
<->  association
-->  dependency
<--> dependency
-:>  generalization
<:-  generalization
--:> implementation
<:-- implementation
+-   composition
+->  composition
o-   aggregation
o->  aggregation
--   note
-/-  hidden

Classifier types

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[name]
[<abstract> name]
[<instance> name]
[<reference> name]
[<note> name]
[<package> name]
[<frame> name]
[<database> name]
[<start> name]
[<end> name]
[<state> name]
[<choice> name]
[<input> name]
[<sender> name]
[<receiver> name]
[<transceiver> name]
[<actor> name]
[<usecase> name]
[<label> name]
[<hidden> name]

Directives

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
#arrowSize: 1
#bendSize: 0.3
#direction: down | right
#gutter: 5
#edgeMargin: 0
#edges: hard | rounded
#fill: #eee8d5; #fdf6e3
#fillArrows: false
#font: Calibri
#fontSize: 12
#leading: 1.25
#lineWidth: 3
#padding: 8
#spacing: 40
#stroke: #33322E
#title: filename
#zoom: 1

ディレクティブはコマンド ライン インターフェイスを使用する場合にのみ使用できます。

1
#import: my-common-styles.nomnoml

Custom classifier styles

「.」で始まるディレクティブは分類子のスタイルを定義します。

1
2
3
4
#.box: fill=#88ff88
#.blob: fill=pink visual=ellipse italic bold dashed
[<box> GreenBox]
[<blob> HideousBlob]

利用可能なビジュアルは、

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
visual=actor
visual=class
visual=database
visual=ellipse
visual=end
visual=frame
visual=hidden
visual=input
visual=none
visual=note
visual=package
visual=receiver
visual=rhomb
visual=roundrect
visual=sender
visual=start
visual=transceiver

利用可能な修飾子は次のとおりです。

1
2
3
4
5
6
center
bold
underline
italic
dashed
empty

貢献する

プロジェクトに貢献したい場合は、詳細情報を参照してください。CONTRIBUTING.md。