工具先生

使用方法

PlantUML 预览的使用方法

用于在同一工作区中编写 PlantUML 语法并检查预览的工具,适合确认时序图或类图等 UML 图结构。支持主题切换和多页面管理,也适合比较不同图版本。

PlantUML 预览 缩略图PlantUML 预览 缩略图

适用场景

适合在这些时候使用

  • 以语法形式起草 UML 图
  • 在写入文档前确认图的结构
  • 通过标签切换多个图版本进行比较
  • 以语法形式快速确认类图或状态图
  • 在与团队共享前整理 UML 图结构
  • 在写入规格说明前确认图表外观

可实现内容

这个工具可以做什么

  • 并排查看 PlantUML 语法与预览
  • 切换主题
  • 管理多个源码页面
  • 将图表保存或复制为 SVG 或 PNG
  • 通过多页面分别管理不同图表
  • 支持时序图、类图、状态图等主要 UML 类型

指南

各画面区域的使用方法

按画面区域说明设置、输入、预览、结果和保存等操作方法。

01 HOWTO

语法输入区域

在左侧输入 PlantUML 语法。可以先选择图表模板,再根据当前图表类型插入补全候选,并在右侧预览中确认结构。

显示 PlantUML 预览 的 语法输入区域 的画面显示 PlantUML 预览 的 语法输入区域 的画面

这个区域可以做什么

  • 可以直接输入 PlantUML 语法
  • 可以从模板插入图表基础结构
  • 可以追加符合当前图表类型的补全候选
  • 可以根据错误显示修正输入

操作位置

01
语法输入

可以输入时序图、类图、状态图等 PlantUML 语法。

显示在 PlantUML 预览 中使用 语法输入 的位置的画面显示在 PlantUML 预览 中使用 语法输入 的位置的画面
02
模板选择

输入为空时,可以选择图表类型并插入从 @startuml 到 @enduml 的基础结构。

显示在 PlantUML 预览 中使用 模板选择 的位置的画面显示在 PlantUML 预览 中使用 模板选择 的位置的画面
03
输入补全候选

可以在光标位置插入参与者、消息、类、关系等符合当前图表类型的候选。

显示在 PlantUML 预览 中使用 输入补全候选 的位置的画面显示在 PlantUML 预览 中使用 输入补全候选 的位置的画面
04
错误确认

语法有问题时,可以查看预览侧的显示并修正输入。

显示在 PlantUML 预览 中使用 错误确认 的位置的画面显示在 PlantUML 预览 中使用 错误确认 的位置的画面

02 HOWTO

输入补全和编辑辅助区域

使用输入框上方的模板和补全候选、顶部的历史记录,以及输入框右上角的清空和复制操作来编辑图表。这里用于创建基础结构、追加部件和复用草稿。

显示 PlantUML 预览 的 输入补全和编辑辅助区域 的画面显示 PlantUML 预览 的 输入补全和编辑辅助区域 的画面

这个区域可以做什么

  • 可以插入符合图表类型的模板
  • 可以追加符合当前图表的部件
  • 可以从历史记录恢复最近的编辑状态
  • 可以清空或复制当前语法

操作位置

01
模板

可以选择时序图、类图、状态图等基础结构并插入输入框。

显示在 PlantUML 预览 中使用 模板 的位置的画面显示在 PlantUML 预览 中使用 模板 的位置的画面
02
补全候选

可以追加参与者、消息、类、关系等符合当前语法的部件。

显示在 PlantUML 预览 中使用 补全候选 的位置的画面显示在 PlantUML 预览 中使用 补全候选 的位置的画面
03
历史记录和草稿

当前输入会作为草稿保存在浏览器中,也可以从历史记录回到最近的编辑状态。

显示在 PlantUML 预览 中使用 历史记录和草稿 的位置的画面显示在 PlantUML 预览 中使用 历史记录和草稿 的位置的画面
04
清空输入

可以删除当前语法并重新创建图表。

显示在 PlantUML 预览 中使用 清空输入 的位置的画面显示在 PlantUML 预览 中使用 清空输入 的位置的画面
05
复制语法

可以将编辑中的语法复制到 README 或规格文档。

显示在 PlantUML 预览 中使用 复制语法 的位置的画面显示在 PlantUML 预览 中使用 复制语法 的位置的画面

03 HOWTO

预览和主题区域

在右侧预览栏确认 PlantUML 的绘制结果,并在分享前切换主题。无法绘制时,错误内容也会显示在这里。

显示 PlantUML 预览 的预览和主题区域的画面显示 PlantUML 预览 的预览和主题区域的画面

这个区域可以做什么

  • 可以切换预览主题
  • 可以确认图形绘制结果
  • 可以查看绘制错误
  • 可以回到输入栏修正语法

操作位置

01
切换主题

可以改变背景和线条颜色,选择适合共享位置的显示效果。

显示 PlantUML 预览 中 切换主题 操作位置的画面显示 PlantUML 预览 中 切换主题 操作位置的画面
02
确认图形

可以确认输入的 PlantUML 语法是否绘制成预期图形。

显示 PlantUML 预览 中 确认图形 操作位置的画面显示 PlantUML 预览 中 确认图形 操作位置的画面
03
确认错误

无法绘制时,先查看错误消息再修正语法。

显示 PlantUML 预览 中 确认错误 操作位置的画面显示 PlantUML 预览 中 确认错误 操作位置的画面
04
修改输入

可以参考预览结果,回到编辑器调整语法。

显示 PlantUML 预览 中 修改输入 操作位置的画面显示 PlantUML 预览 中 修改输入 操作位置的画面

04 HOWTO

输出格式、复制和下载区域

使用预览上方的输出操作选择 SVG 或 PNG,并复制或下载绘制好的图。无法输出时,可查看错误并返回输入栏修正。

显示 PlantUML 预览 的 输出格式、复制和下载区域 的画面显示 PlantUML 预览 的 输出格式、复制和下载区域 的画面

这个区域可以做什么

  • 可以选择 SVG / PNG 输出格式
  • 可以将绘制好的图作为图片复制
  • 可以将绘制好的图下载为文件
  • 可以复制原始 PlantUML 语法
  • 无法输出时可以确认错误

操作位置

01
输出格式

可在 SVG 和 PNG 之间切换,选择适合共享或粘贴位置的格式。

显示在 PlantUML 预览 中使用 输出格式 的位置的画面显示在 PlantUML 预览 中使用 输出格式 的位置的画面
02
复制图片

可以按当前选择的格式复制绘制好的图,并粘贴到文档或聊天中。

显示在 PlantUML 预览 中使用 复制图片 的位置的画面显示在 PlantUML 预览 中使用 复制图片 的位置的画面
03
下载图片

可以将绘制好的图保存为 SVG 或 PNG 文件。

显示在 PlantUML 预览 中使用 下载图片 的位置的画面显示在 PlantUML 预览 中使用 下载图片 的位置的画面
04
复制语法

可以复制生成图形所用的 PlantUML 语法,并与图片一起共享。

显示在 PlantUML 预览 中使用 复制语法 的位置的画面显示在 PlantUML 预览 中使用 复制语法 的位置的画面
05
确认错误

无法输出图形时,可以查看错误并返回输入栏修正。

显示在 PlantUML 预览 中使用 确认错误 的位置的画面显示在 PlantUML 预览 中使用 确认错误 的位置的画面

注意事项

注意事项

将使用前应先判断的重要点按原因归纳整理。

检查事项

先从最小可显示语法开始

如果一开始就加入太多元素,就很难区分语法问题和关系问题。建议先从最小结构开始,再逐步补充。

检查事项

根据分享场景选择 SVG 或 PNG

需要继续编辑时优先 SVG,需要快速贴到聊天或演示文稿时优先 PNG。

注意

预览需要连接外部服务器

PlantUML 预览需要网络连接才能渲染图表。没有网络连接时预览无法显示。

FAQ

关于 PlantUML 预览 的常见问题

这里先整理能帮助使用前判断的常见问题。

它与 Mermaid 有什么不同?

它面向 PlantUML 语法和 UML 图场景。可以按文档切换不同记法工具。

可以立即保存为图片吗?

SVG 与 PNG 操作取决于预览 engine 的连接状态。未连接时会在预览面板显示错误。

可以绘制哪些图表类型?

支持时序图、类图、状态图、用例图、甘特图等 PlantUML 主要图表类型。

在哪里可以查看语法说明?

PlantUML 官方文档中有各类图表的语法说明。可以在本页边输入语法边确认效果。

如何将图表以图片形式分享?

可下载为 SVG 或 PNG,也可复制到剪贴板后分享。

可以离线使用吗?

PlantUML 预览需要连接外部服务器。没有网络连接时预览无法显示。

下一步指南

相关指南

这里整理了相关指南,便于继续操作时不迷失。