plantuml使用教程【转】

图跪了，请看原文：http://archive.3zso.com/archives/plantuml-quickstart.html

Table of Contents

• 前言
• 什么是PlantUML
• 在Emacs里配置PlantUML（参考：Run it from Emacs）
• 其他软件里的PlantUML下载和安装
• 如何使用
  • 顺序图（Sequence Diagram）
    • 简单示例
    • 注释语句
    • 申明参与者
    • 使用非字母的参与者名称（Use non-letters in participants）
    • 发送消息给自己（Message to Self）
    • 改变箭头的样式（Change arrow style）
    • 改变箭头的颜色（Change arrow color）
    • 消息序号（Message sequence numbering）
    • 标题（Title）
    • 图形图例（Legend the diagram）
    • 分割图形（Splitting diagrams）
    • 消息分组（Grouping message）
    • 消息注解（Notes on messages）
    • 一些其他的注解方式（Some other notes）
    • 使用HTML进行格式化（Formatting using HTML）
  • 用例图（Use Case Diagram）
    • 用例（Usecase）
    • 参与者（Actors）
    • 示例
  • 类图（Class Diagram）
    • 示例1
  • 活动图（Activity Diagram）
    • 简单活动（Simple Activity）
    • 带标注的箭头（Label on arrows）
    • 改变箭头的方向（Changing arrow direction）
    • 分支（Branches）
    • 多分支（More on Branches）
    • 同步块（Synchronization）
    • 长文本的活动描述（Long activity description）
    • 注释（Notes）
    • 分区（Partition）
    • 图形标题（Title the diagram）
    • 皮肤（Skinparam）
    • 完整示例（Complete Example）
  • 活动图Beta
    • 简单活动（Simple Activity）
    • 条件符号（Conditional）
    • 重复循环（Repeat Loop）
    • 条件循环（While Loop）
    • 并行处理（Parallel Processing）
    • 注解的文本样式（Notes）
    • 颜色（Color）
    • 完整示例（Complete Example）

 

前言

本文多数内容引用自官网文档，并非本人原创，也谈不上翻译，只是把自己 理解的东西用中文写出来。

编写本文的目的旨在记录个人在学习PlantUML时对官网上一些内容的理解，以 及总结学习过程中遇到的问题，并将其分享。文章中如有不对之处欢迎大家直 言指正，以免造成误导。

版权：本文可自由转载，但不能商用，不能衍生，保持署名。转载请注明作者及出处.

Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

什么是PlantUML

PlantUML是一个快速创建UML图形的组件，官网上之所以称它是一个组件，我 想主要是因为多数情况下我们都是在Eclipse、NetBenas、Intellijidea、 Emacs、Word等软件里来使用PlantUML（参看各软件相关配置）。

• PlantUML支持的图形有：
  • sequence diagram,
  • use case diagram,
  • class diagram,
  • activity diagram (here is the new syntax),
  • component diagram,
  • state diagram,
  • object diagram,
  • wireframe graphical interface

• PlantUML通过简单和直观的语言来定义图形，它可以生成PNG、SVG和二进制 图片。下面是一个简单的示例：

  #+BEGIN_SRC plantuml :file ../img/orgmode-babel-sequenceuml.png
    Alice -> Bob: synchronous call
    Alice ->> Bob: asynchronous call
  #+END_SRC
  

  

  在官网上有一个简单的在线Demo服务， 有兴趣的朋友可以上去看下。

在Emacs里配置PlantUML（参考：Run it from Emacs）

1. 下载 plantuml.jar 到你的硬盘上（官网下载页面）

2. 安装生成图片用的软件Graphviz

   ## 如果是Ubuntu系统，可以直接运行下面的命令安装
   sudo apt-get install graphviz
   

3. 在 .emacs 里添加配置，把 plantuml 添加到 org-babel-load-languages 加载语言列表里。

   ;; active Org-babel languages
   (org-babel-do-load-languages
    'org-babel-load-languages
    '(;; other Babel languages
      (plantuml . t)))
   

   然后把刚下载到的 plantuml.jar 文件的存放路径也添加到 .emacs 文件中，以方便Emacs调用。

   (setq org-plantuml-jar-path
         (expand-file-name "~/path/to/plantuml.jar"))
   

重启Emacs，复制上面的示例代码试一下吧！

其他软件里的PlantUML下载和安装

• PlantUML官网首页
• PlantUML各版本的下载页面 (英文）
• 在各种软件里运行PlantUML的相关配置 （英文）