VNote配置PlantUML和Graphviz

Posted 2021-04-17 VNote笔记

1. 什么是PlantUML和Graphviz

PlantUML 是一个通过简单的脚本来绘制UML图表的一个工具，比如说：

```puml
@startuml
Bob -> Alice : hello
@enduml
```

可以绘制出这样的漂亮图表：

Graphviz 是一个更为通用的图表绘制语言，PlantUML中的部分图表需要调用Graphviz来绘制。

下面我们以Windows为例介绍如何在VNote中使用这两个神器。

2. Graphviz

为了在VNote中使用Graphviz，你需要访问Graphviz的官网下载Graphviz并安装，安装完后，你需要找到dot.exe所在位置，如C:Program Files(x86)graphvizdot.exe。

打开VNote的设置对话框，启用Graphviz并填写上面的路径：

重新打开所以标签页，就可以在VNote中使用Graphviz了：

```dot
balabalabala
```

3. PlantUML

3.1. 在线PlantUML

使用在线PlantUML的好处是不用安装任何东西，但是有可能会泄露隐私，而且无法使用原地预览。

3.2. 本地PlantUML

首先，请按照上面的步骤安装Graphviz，并测试能成功使用。

访问PlantUML官网下载plantuml.jar，将其放到一个全英文的路径中，如C:plantuml.jar。

请安装Java运行时。

配置VNote如下：

请重新打开所以标签页，这时候应该就能正常使用PlantUML了。

3.3. 高级配置

如果上面的配置仍然无法使用PlantUML，而且确认本地命令行能正确执行PlantUML，则你可能需要改动VNote的配置文件vnote.ini。

文件，打开配置文件夹，使用记事本编辑vnote.ini。

找到[web]这一行，在下面新建一行，输入：

plantuml_cmd=cmd.exe /c "java -jar C:\plantuml.jar -charset UTF-8 -nbthread 4 -pipe -t%0"

重启VNote即可。

关于plantuml_cmd的具体含义，参考如下：

; Custom PlantUML command to execute to convert a PlantUML diagram in local PlantUML
; Read data definition from stdin and output diagram result to stdout
; When set, other local PlantUML related settings are ignored
; %0 will be replaced with the format string like svg or png
; plantuml_cmd=/bin/sh -c "cat | java -jar /opt/plantuml/plantuml.jar -charset UTF-8 -nbthread 4 -pipe -t%0"
plantuml_cmd=

4. Live Preview

在编辑窗口，右键打开图表实时预览，即可实时预览光标所在处的图表。