プロジェクト

全般

プロフィール

Redmine Mermaidマクロ

各種図の書き方

基本形

Redmine Wikiのマクロ記述で記述します。

{{mermaid
図の名称 オプション
 図のコンテンツ
}}

図の名称は、次を記述。

図法 図の名称 オプション
ER図 erDiagram
ガントチャート gantt
クラス図 classDiagram
シーケンス図 sequenceDiagram
Gitグラフ図 gitGraph
ジャーニーマップ journey
状態遷移図 stateDiagram-v2
タイムライン timeline
パイチャート pie title 題名
パケット図 packet
フローチャート flowchart 方向を指定(LR TD TB)
ブロック図 block
マインドマップ mindmap
要求図 requirementDiagram
4象限グラフ quadrantChart

ER図

IE記法のER図を記述することができます。

https://docs.mermaidchart.com/mermaid-oss/syntax/entityRelationshipDiagram.html

{{mermaid
erDiagram
  user ||--|{ item : userはitemを保持
  user {
    int id PK
    string name
  }
}}

erDiagram user ||--|{ item : userはitemを保持 user { int id PK string name } item { int id PK string name }

カーディナリティの Mermaid マクロで使用できる記述方法は次の通りです。

リレーションの左側 _. リレーションの右側 意味
|o
o|
0または1
||
1
}o
o{
0以上
}|
|{
1以上

関連線は、実線(--)、点線(..

ブロック図

簡単ガイド

デフォルトでは横並びにブロックが配置されます。

ブロックの配置(デフォルトの横並び)
mermaid記述
{{mermaid
block
  a b c["Charlie"] 
}}
block a b c["Charlie"]
  • ブロック図はマクロの最初にblockを指定
  • ブロックIDを空白区切りで列挙、デフォルトではIDがブロックの名称として適用、別名を指定する場合角括弧で記述
ブロック間を直線矢印
mermaid記述
{{mermaid
block
  a space b c["Charlie"] 
}}
block a space b c["Charlie"] a --> b
  • spcaeを入れないとブロック同士の隙間が小さすぎて矢印が表現しきれません
ブロック間の矢印に文字
mermaid記述
{{mermaid
block
  a space:2 b c["Charlie"] 
  a --"create"--> b
}}
block a space:2 b c["Charlie"] a --"create"--> b
  • 文字が矢印の長さに収まらない場合、space:2 のようにブロック間の空白を増やします
    :数値 で、何カラム分を占めるかを指定
矢印を図形で
mermaid記述
{{mermaid
block
  a blockArrow1<[" "]>(right) b c["Charlie"] 
}}
block a blockArrow1<[" "]>(right) b c["Charlie"]
  • ID名<["ラベル"]>(向き) でブロックの矢印を配置
ブロックの形状
mermaid記述
{{mermaid
block
  a("角が丸い") b(["両端が丸い"]) c[["両端が二重線"]]
}}
block columns 4 a("角が丸い") b(["両端が丸い"]) c[["両端が二重線"]] d[("円筒形")] e(("円形")) f>"左端三角えぐれ"] g{"菱形"} h{{"両端が三角飛出し"}} i[/"平行四辺形右斜"/] j[\"平行四辺形左斜"\] k[/"台形"\] l[\"逆台形"/] m((("二重丸")))


約2時間前に更新