「seqdiag」- 时序图绘制工具 @20210313

该部分笔记将整理 seqdiag 使用方法。本文内容对官方文档进行梳理与摘要。

如何使用

通过，向seqdiag中输入“描述文件”，它会输出时序图。使用seqdiag的步骤：
1）编写.diag文件；
2）将编写好的.diag文件输入seqdiag中，它就会生成类似的序列图；

接下来就介绍如何使用安装并使用seqdiag工具。

安装工具

#!/bin/sh


# 在Debian中，可以安装python-seqdiag软件包：
apt-get install python-seqdiag

# 或者更通用的办法是通过pip安装：
pip install seqdiag

在安装成功后，就可以使用seqdiag(1)命令。

第一步、创建描述文件

创建 simple.diag 文件，内容如下：

seqdiag {
  browser  -> webserver [label = "GET /index.html"];
  browser <-- webserver;
  browser  -> webserver [label = "POST /blog/comment"];
              webserver  -> database [label = "INSERT comment"];
              webserver <-- database;
  browser <-- webserver;
}

第二步、生成序列图

执行 seqdiag simple.diag 命令，该命令会成一张PNG图片，图片的内容为：

快速入门与相关文档

有关特点、安装要求、安装方法、简单示例、字体设置等等内容，参考官方「Introduction of seqdiag」手册。

修改字体
（1）命令行使用-f选项。或者（2）使用配置文件（$HOME/.blockdiagrc）自定字体：

[seqdiag]
fontpath = /usr/share/fonts/truetype/ttf-dejavu/DejaVuSerif.ttf

字体大小

seqdiag {
  // Set fontsize.
  default_fontsize = 16;  // default value is 11
}

图形宽度

seqdiag {
  edge_length = 300;  // 两个列之间的宽度，default value is 192
  span_height = 80;   // 行高（非整个图形高度），default value is 40
}

分隔线

seqdiag {
  A -> B;

  // Separator
  === Separator line ===

  A -> B;

  // Delay separator
  ... Separator line ...

  A -> B;
}

参考文献

访问seqdiag的主页
blockdiag 1.0 documentation » seqdiag - simple sequence-diagram image generator » Sample diagrams