当前位置： 文江博客文章教程详情

GNU Emacs 介绍和使用

发布于 2024-05-10 12:38:29 字数 37990 浏览 18 评论 0

1. Introduction

EN
GNU Emacs is the most popular and most ported Emacs text editor. It was created by GNU Project founder Richard Stallman. In common with other varieties of Emacs, GNU Emacs is extensible using a Turing complete programming language.

CN
EMACS，即 Editor MACroS（编辑器宏）的缩写，最初由 Richard Stallman(理查德·马修·斯托曼) 于 1975 年在 MIT 协同 Guy Steele 共同完成。这一创意的灵感来源于 TECMAC 和 TMACS，它们是由 Guy Steele、Dave Moon、Richard Greenblatt、Charles Frankston 等人编写的宏文本编辑器。
Emacs 使用 Emacs Lisp，这种有着极强扩展性的编程语言，从而实现了包括编程、编译乃至网络浏览等等功能的扩展。

2. Emacs Keyboard

2.1. Open Emacs on terminal

$ emacs -nw filename

2.2. Don't know how to use emacs?

2.2.1. Default Prefix

Table 1: Prefix

PrefixDescription
CCtrl
MAlt
SShift
RETEnter
up/down/left/right上/下/左/右 方向键
C-c当前编辑模式特有的命令
C-x文件和缓冲区命令
C-h获取帮助命令
M-x键入函数名称前缀快捷键

2.2.2. General Keyboard

Table 2: general shotkeys

KeyboardDescriptionKeyboardDescription
C-x C-cExitC-gExit the command being excuted
C-v查看下一屏M-v查看上一屏
C-l重绘屏幕，并将光标所在行置于屏幕的中央  
C-f向右移（forward,前进）C-b向左移（backward，回退）
C-pPrevious lineC-nNext line
M-f向右移（以单词为一个单位）M-b向左移（以单词为一个单位）
M-<移动到所有文字最开头M->移动到所有文字的最末尾
C-aMove custor to line headC-eMove custor to line tail
M-aMove custor to sentence headM-eMove custor to sentence tail
C-kDelete content after custorC-yPaste
C-/CancelC-x uCancel
C-dDelete character after custorM-wCopy
C-dDelete character after custorM-wCopy
C-SPACESelect content modelC-wCut
C-x C-fOpen/New fileC-x C-sSave
C-x 2分屏C-x 0Switch to window 1
C-x oSwitch windowC-h tHelp

2.2.3. File

Table 3: File

KeyboardDescription
C-x C-fOpen/New file
C-x C-sSave
C-x C-wSave as
C-x C-vClose the current buffer file, and open file
C-x iInsert file at current position
C-x bNew/Switch buffer
C-x C-bShow buffer lists
C-x kClose buffer
C-x C-cExit emacs

2.2.4. Custor Move

Table 4: Move

KeyboardDescription
C-f光标向后移动
C-b光标向前移动
C-pPrevious line
C-nNext line
M-f光标移动到单词尾部
M-b光标移动到单词头部
C-aHead of line
C-eEnd of line
C-v向下翻页
M-v向上翻页
M-<到文件开头
M->到文件结尾

2.2.5. Text Edit

Table 5: Text Edit

KeyboardDescription
M-n/C-u n重复执行后一个命令 n 次
C-d删除后一个字符
M-d删除前一个字符
Del删除前一个字符
M-Del删除前一个单词
C-k移除一行
C-@设定标志位（主要是为了粘贴剪切以及删除使用)
C-w移除标记区域的内容（剪切）
M-w复制标记区域的内容（复制）
C-y粘贴
M-y召回更早的内容 (在 kill 缓冲区内循环)
C-t交换两个字符的位置
M-t交换两个单词的位置
C-x C-t交换两行的位置
M-u使从光标位置到单词结尾处的字母变成大写
M-l与 M-u 相反
M-c使从光标位置开始的单词的首字母变为大写
M-x mark-whole-buffer or C-x h, M-x indent-region or C-M-\选中整个文件，然后格式化
M-x mark-defun or C-M-h, M-x indent-region or C-M-\选中函数，格式化

2.2.6. Search

Table 6: Search

KeyboardDescription
C-s向前搜索
C-r向前搜索
M-%查找及替换:首先按下快捷键，输入要替换的词，RET，然后输入要替换的词，RET

2.2.7. Window

Table 7: Window

KeyboardDescription
C-x 2水平分割窗格
C-x 3垂直分割窗格
C-x o切换至其他窗格
C-x 0关闭窗格
C-x 1关闭除了光标所在窗格外所有窗格

2.2.8. Help

Table 8: Help

KeyboardDescription
C-h mShow current mode
C-h c显示快捷键绑定的命令
C-h k显示快捷键绑定的命令和它的作用
C-h fShow feature of function
C-h b显示当前缓冲区所有可用的快捷键
C-h tOpen emacs tutorial
M-x quitExit help
M-x org-entities-helpOrg mode entities 特殊字符参考

3. Common commands

Emacs 快速设置生效命令: 
M-x eval-buffer

不小心按了 ctrl + Z 挂起后，恢复命令
$ fg

4. Emacs Org-mode

4.1. ORG Features

Org mode is for keeping notes, maintaining TODO lists, planning projects, and authoring documents with a fast and effective plain-text system.
ORG 是一个快速高效的纯文本系统，可用于记日记、维护待办事项列表、计划项目以及撰写和发布文档。

  • 写作 (Editing)
    • ORG 支持大纲结构，可以快速容易的在不同标题之间导航
    • 支持折叠标题内容
    • 内置便捷的快捷键绑定和很多高效编辑设施。
  • 计划 (Planning)
    • 可以用于管理待办事项 (TODO) 列表和计划
    • 每个标题可以被当作一个任务
    • 可配置待办事项关键字及通过 C-c C-t 或者 S-<left/right> 快捷键切换关键字
    • 支持计划元数据，如：排期 (scheduled)、截止日期 (deadline)、标签、属性等。
  • 捕获 (Capturing)
    • 将一个代办事项添加到 .org 文件的过程称之为 capturing
    • 您可以从任意地方 capture，既可以在 Emacs 中，也可以通过其他应用程序（如浏览器、PDF 阅读器等）
    • Capture 模版允许您定义想 capture 的上下文信息
  • 计时 (Clocking)
    • 启动任务计时 C-c C-x C-i
    • 结束任务计时 C-c C-x C-o
    • 计时日志记录在抽屉里 (drawer)
    • 支持可定制的格式报告
  • 日程表 (Agendas)
    • ORG 模块帮助您聚焦于任务，可以轻松管理很大的 .org 文件和数千任务
    • 内置日程表视图按周显示任务排期计划和截止日期、待办事项列表以及停滞的项目
    • 日程表视图支持根据需要进行定制：支持按天/按周/按月；支持以标签和待办事项列表关键字定制
    • 日程表是 ORG 的关键模块
  • 列表 (Tables)
    • ORG 是一个优秀的纯文本表格编辑器
    • 可以通过 .csv 和 .tsv 文件，或者直接从当前缓冲区导入列表
    • 支持导出多种格式
    • ORG 也可以被用作一个电子表格 (spreadsheet) 系统
    • 您可以使用 Calc Emacs 包或者 Emacs lisp 代码为表格添加计算公式
  • 发布 (Exporting)
    • ORG 是一个出版发布工具
    • 可以使用直观的标记将 ORG 文档转换为 HTML, LaTeX, ODT 等格式文档
    • 开发者可以很容易的创建新的后端以支持特定格式
    • 您可以为一个或者多个 .org 文件定义发布项目，并可以定义一个或者多个发布后端
  • 嵌入代码 (Working with source code)
    • ORG 以便捷和自然的方式支持文学编程 (literate programming)
    • 支持插入代码片段、在 ORG 缓冲区执行代码片段并输出计算结果；支持从 Org 文件抽取源代码文件

4.2. Installation

read more: https://orgmode.org/

4.3. Org-mode Keyboard

Table 9: org-mode keyboard

KeyboardDescription
TAB (org-cycle)Cycle visibility. 循环切换光标所在大纲的状态
RETenter,Select this location.
C-c C-n (org-next-visible-heading)Next heading.
C-c C-p (org-previous-visible-heading)Previous heading.
C-c C-f (org-forward-same-level)Next heading same level.
C-c C-b (org-backward-same-level)Previous heading same level.
C-c C-u (outline-up-heading)Backward to higher level heading.
C-c C-j切换到大纲浏览状态
C-c C-'源码编辑或源码编辑完成退出
M-RET (org-meta-return)Insert a new heading, item or row. 插入一个同级标题
C-RET (org-insert-heading-respect-content)Insert a new heading at the end of the current subtree.
M-LEFT/RIGHT将当前标题升/降级
M-S-LEFT/RIGHT将子树升/降级
M-S-UP/DOWN将子树上/下移

4.4. 基本语法

4.4.1. Title

#+TITLE: GNU Emacs

4.4.2. Font

*粗体*
/斜体/
+删除线+
_下划线_
下标：H_2 O(这里必须留一个空格要不然 2 和 O 都成为小标，目前还不知道怎么去掉空格)
上标：E=mc^2
等宽字： =git=，~code~

4.4.3. 段落(paragraph)

使用 \\ 换行
空一行代表重新起段落

4.4.4. List

  1. 有序列表
    • 无序列表以'-'、'+'或者'*'开头
    • 有序列表以'1.'或者'1)'开头
    • 描述列表用'::'
  2. 列表相关快捷键 Table 10: 折叠
    快捷键说明
    S-TAB循环切换整个文档的大纲状态（折叠、打开下一级、打开全部）
    TAB循环切换光标所在的大纲状态
    Table 11: 大纲或者列表之间移动
    快捷键说明
    C-c C-n/p移动到下上一个标题（不断标题是哪一级）
    C-c C-f/b移动到同一级别的下/上标题
    C-c C-u跳到上一级标题
    C-c C-j切换到大纲预览状态
    Table 12: 基于大纲/标题的编辑
    快捷键说明
    M-RET插入一个同级别的标题
    M-S-RET插入一个同级别的 TODO 标题
    M-LEFT/RIGHT将当前标题升/降级
    M-S-LEFT/RIGHT将子树升/降级
    M-S-UP/DOWN将子树上/下移动
    C-c *将本行设为标题或者正文
    C-c C-w将子树或者区域移动到另一个标题处（跨缓冲区）
    C-c C-x b在新缓冲区显示当前分支
    C-c /只列出包含搜索结果的大纲，并高亮，支持多种搜索方式

4.4.5. 嵌入元数据

  1. 内容元数据
    • 代码
      #+begin_src c -n -t -h 7 -w 40
...
#+end_src
c 为所添加的语言
-n 显示行号
-t 清除格式
-h 7 设置高度为 7
-w 40 设置宽度为 40
    • 注释
      #+BEGIN_COMMENT
块注释
...
#+END_COMMENT
    • 表格与图片
      #+CAPTION: This is the caption for the next table (or link)
则在需要的地方可以通过 \ref{table1} 来引用该表格。
    • 嵌入 HTML
      #+BEGIN_EXPORT html
All lines between these markers are exported literally
#+END_EXPORT
    • 包含文件
      #+INCLUDE: "~/.emacs" src emacs-lisp
  2. 文档元数据 Table 13: 文档元数据
    H:标题层数
    num:章节（标题) 是否自动编号
    toc:是否生成索引
    creator:是否生成 "creat by emacs…"
    LINKUP:UP: 链接
    LINKHOME:HEME: 链接

4.4.6. Table

  1. 快捷键
    Table 14: 整体区域
    操作说明
    C-c 竖线创建或者转化成表格
    C-c C-c调整表格，不移动光标
    TAB移动到下一区域，必要时新建一行
    S-TAB移动到上一区域
    RET移动到下一行，必要时新建一行
    Table 15: 编辑行和列
    快捷键说明
    M-LEFT/RIGHT移动列
    M-UP/DOWN移动行
    M-S-LEFT/RIGHT删除/插入列
    M-S-UP/DOWN删除/插入行
    C-m移动到下一行，或新建一行
    C-c -添加水平分割线
    C-c RET添加水平分割线并跳到下一行
    C-c ^根据当前列排序，可以选择排序方式
    C-c `编辑当前单元格
    C-c C-x C-w剪切某个区域的表格内容
    C-c C-x C-y拷贝复制的内容到表格
  2. 表格计算 Table 16: 一张价格表，要求算出总额
    数量单价总额
    23.456.9
    44.3417.36
    53.4417.2
    55.628.
    C-u C-c C-c 强制 org-mode 为整个表格进行设计。只希望在某一特定项上进行计算，输入：':=$1*$2′, 即在等号前再加一个冒号。
<5> 表示指定列的宽度，超出宽度的部分会用=>表示，如果想要编辑，需要按下 C-c ` ，会打开另一个 buffer 让你编辑, 用 C-c C-c 提交编辑内容。
<l> 表示左对齐，r,c,l 字符分别表示右、中和左对齐。

4.4.7. Link

在一个链接上按 C-c C-o 即可访问。

  1. 自动链接 对于符合链接规则的内容，org-mode 会自动将其视为链接，包括括文件、网页、邮箱、新闻组、BBDB 数据库项、 IRC 会话和记录等。
  2. 手动链接
    [[link][description]]
[[link]]
  3. 内部链接
    #<<target>>
设置到 target 的链接：[[target]] 或 [[target][猛击锚点]]

4.4.8. 注脚

注脚的格式有两种，一是方括号+数字，二是方括号+fn+名字。插入脚注：C-c C-x f ，接下俩你可以写一些其他东西，然后在文章的末尾写上下面两句话（注意：必须要顶格写）：

[1] The link is:     http://orgmode.org    
[fn:orghome] The link is:     http://orgmode.org

4.4.9. 分割线

五条短线或以上

4.4.10. 标签

  1. 标记 tags
    #+FILETAGS: :Peter:Boss:Secret:

    更方便的做法是在正文部分用 C-c C-q 或直接在标题上用 C-c C-c 创建标签

  2. 预定义 tags
    • 预定义的方式有两种：
      • 在当前文件头部定义这种方式预定义的标签只能在当前文件中使用。
        使用#+TAGS 元数据进行标记， #+TAGS: { 桌面(d) 服务器(s) }  编辑器(e) 浏览器(f) 多媒体(m) 压缩(z)
每项之间必须用空格分隔，可以在括号中定义一个快捷键；
花括号里的为标签组，只能选择一个对标签定义进行修改后，要在标签定义的位置按 C-c C-c 刷新才能生效。
      • 在配置文件中定义
        (setq org-tag-alist '((:startgroup . nil)
                      ("@work . ?w) ("@home" . ?h)
    ("@tennisclub" . ?t)
    (:endgroup . nil)
    ("laptop" . ?l) ("pc" . ?p)))

        默认情况下，org 会动态维护一个 Tag 列表，即当前输入的标签若不在列表中，则自动加入列表以供下次补齐使用。为了使这几种情况（默认列表、文件预设 tags，全局预设 tags）同时生效，需要在文件中增加一个空的 TAGS 定义：'#+TAGS:'

  3. tags 查询 Table 17: tags 查询快捷键
    快捷键说明
    C-c \可以用来查找某个 tag 下的所有项目
    C-c / m搜索并按树状结构显示
    C-c a m从所有 agenda file 里建立符合某 tag 的全局性列表
    +   和      a+b   同时有这两个标签
-   排除    a-b   有 a 但没有 b
|   或      a|b   有 a 或者有 b
&   和      a&b   同时有 a 和 b，可以用“+”替代

4.4.11. org mode entities

M-x org-entities-help <RET>

4.4.12. Source Code

  1. Structure of Code Blocks
    #+NAME:<name>
#+BEGIN_SRC <language> <switches> <header arguments>
<body>
#+END_SRC
    '<switches>'
    Optional. Switches provide finer control of the code execution, export, and format(see the discussion of switches in Literal Examples ).
    '<header arguments>'
    Optional. Heading arguments control many aspects of evaluation, export and tangling of code blocks(see Using Header Arguments ).
    '<body>'
    Source code in the dialect of the specified language identifier.
    1.  

4.5. 一些 org 快捷操作

// 注意：9.2 版本后，需要在 emacs 初始化文件中，写入 (require 'org-tempo)

// 快速输入 #+BEGIN_SRC ... #+END_SRC
<s <TAB>

// 快速输入 #+BEGIN_EXAMPLE ... #+END_EXAMPLE
<e <TAB>

// 快速输入 #+BEGIN_EXPORT html ... #+END_EXPORT
输入<h <TAB>

// 快速输入 #+BEGIN_EXPORT latex ... #+END_EXPORT
<l <TAB>

<s      #+BEGIN_SRC … #+END_SRC
<e      #+BEGIN_EXAMPLE … #+END_EXAMPLE
<q      #+BEGIN_QUOTE … #+END_QUOTE
<v      #+BEGIN_VERSE … #+END_VERSE
<c      #+BEGIN_CENTER … #+END_CENTER
<l      #+BEGIN_LaTeX … #+END_LaTeX
<L      #+LaTeX:
<h      #+BEGIN_HTML … #+END_HTML
<H      #+HTML:
<a      #+BEGIN_ASCII … #+END_ASCII
<A      #+ASCII:
<i      #+INDEX: line
<I      #+INCLUDE: line

5. Emacs Customize

5.1. Plugins & Themes

5.1.1. 安装示例

示例：安装 plantuml 插件

M+x package-install <RET>
plantuml-mode <RET>

示例：安装 monokai-pro 主题（手动安装）

// 将添加到 ~/.emacs 或 ~/.emacs.d/init.el 文件
(add-to-list 'load-path "~/.emacs.d/lisp/")
(require 'plugin-name)

查看所有安装包
M+x list-packages <RET>

自动卸载无效的包
M+x package-autoremove <RET>

修改主题
M-x customize-themes <RET>

安装 MacTex 及相关工具包
ORG Mode 使用 MacTex 发布 PDF 以及 Tex 格式文档，可直接运行如下命令安装 MacTex ：

$ brew cask install mactex
  • 为了支持中文，还需要安装额外的包：
    sudo tlmgr install environ
sudo tlmgr install trimspaces
sudo tlmgr install zhnumber
sudo tlmgr install ctex
sudo tlmgr install needspace
sudo tlmgr install xecjk
  • 执行 sudo fmtutil-sys –all 命令，重新生成 FMT（Plain TeX、LaTeX、LuaTeX)。
  • 执行 sudo tlmgr update -all 可以更新 MacTex。
  • 运行命令 pdflatex texname.tex 测试输出 PDF。

    安装 pandoc
    ORG ox-pandoc 模块使用 pandoc 发布 (exporting) .org 文档至众多 pandoc 支持的格式。

    $ brew install pandoc

    安装 graphviz 和 PlantUML 包
    ORG 模块 ditaa 使用 Graphviz 和 PlantUML 包支持纯文本作图，特别是 UML 各类图的制作。

    $ brew install ditaa graphviz plantuml

5.1.2. Common Plugins

Table 18: General plugins

NameDescription
htmlizeexport to html.
org 
org-plus-contrib 
planuml-modePlanUML
emmet-modeEmmet plugin

5.2. PlantUML

5.2.1. 什么是 PlantUML?

PlantUML 是一个快速创建 UML 图形的组件。下面是一个简单的示例：

;; #+BEGIN_SRC plantuml :file {{site.url}}/assets/images/orgmode-babel-sequenceuml.png
;; Alice -> Bob: synchronous call
;; Alice ->> Bob: asynchronous call
;; #+END_SRC

orgmode-babel-sequenceuml.png

在线 Demo 服务

5.2.2. 配置 Emacs 支持 PlantUML

  1. 下载 plantuml.jar 到你的硬盘上 官网下载页面
  2. 安装生成图片用的软件：Graphviz
    $ sudo apt install graphviz
  3. 配置 Emacs 支持 PlantUML 首先，将下载的 plantuml.jar 文件放到 ~/.emacs.d/plantuml/ 目录下；
    其次，打开 ~/.emacs.d/init.el 文件，添加配置加载 PlantUML；
    1: ;; Load plantuml
2: (setq org-plantuml-jar-path
3:       (expand-file-name "~/.emacs.d/plantuml/plantuml.jar"))

    最后在 ~/.emacs 或 ~/.emacs.d/init.el 中，添加配置语言。

    1: ;; active Org-babel languages
2: (org-babel-do-load-languages
3:  'org-babel-load-languages
4:  '(;; other Babel languages
5:    (plantuml . t))) ;; add this line
  4. PlantUML mode for Emacs
    M-x package-install <RET>
plantuml-mode <RET>

    M-x customize-variable <RET>
plantuml-jar-path <RET>

5.2.3. 顺序图(Sequence Diagram)

简单示例
顺序图用 -> , –>, <-, <– 来绘制参与者（Participants）之 间的消息（Message）。

plantuml-quickstart-s1.png

应用举例 1
标题、参与者、别名、注释、箭头、图形图例位置、消息序号、颜色、分割图形

参与者
使用 participant 关键词，也可以使用下面的参与者分类关键词来申明参与者：

  • actor 参与者
  • boundary 边界
  • control 控制
  • entity 实体
  • database 数据库

箭头样式

  • 使用 \ 或 / 来替换 < 或 > 可以让箭头只显示上半部分或下半 部分。
  • 重复输入箭头或斜杠（ >> // ），用来绘制空心箭头。
  • 使用双横线 – 替代 - 可以用来绘制点线。
  • 在箭头后面加个 o 可以在箭头前绘制一个圆圈。
  • 使用 <-> 可用来绘制双向箭头。

图形图例(Legend the diagram)
使用 legend 和 end legend 关键词可以设置图例为左对齐、右对齐和居中对齐。

分割图形(Splitting diagrams)
关键词 newpage 是用来把图形分割成几个图片的。每一个被分割出来的 图片可以看作是一个新的页面（ new page ），如果要给新的页面添加一 个标题，可以紧跟在关键词 newpage 之后来设置。

' 要给图形加一个标题可以用 title 关键词来设置。
title Simple Comunication example
actor Bob
boundary Lily #red
control Linus #blue
entity Michael
database "Edward's"
' The only defference between actor and participant is the drawing
participant Alice
participant "I have a really\nlong name" as L #99ff99
/' You can also declare:
participant L as "I have a really\nlong name" #99ff99
'/

' 消息序号(Message sequence numbering)：
' 使用 autonumber 给消息添加序号
autonumber
' 如果需要指定一个起始号码，可以直接在 autonumber 后面加个数字就行 了，如果要设置自增量，再在后面加一个数字就行了(autonumber start increment)
' autonumber 15
' autonumber 40 10
' 也可以为序号指定数字格式，这个格式化的过程实际上是 Java 类 DecimalFormat 来执行的（ 0 表示数字， # 缺省补零位数）。同样的，也可以使用一些 HTML 标签来控制数字的样式。
' autonumber "<b>[000]"
' autonumber 15 "<b>(<u>##</u>)"
' autonumber 40 10 "<font color=red>Message 0  "
Bob -[#red]-> Lily : To boundary
Bob -[#0000FF]->> Linus : To control
Bob -\ Michael : To entity
Bob //-- Edward : To database
Bob \\- Alice
Bob ->o Alice
Linus -> Alice : Authentication Request
Alice -> Linus : Authentication Response
Linus -> Linus : This is a signal to self.\nIt also demonstrates\nmultiline \ntext
Bob \\-Alice
Bob <-> Alice
Bob <<-\\o Alice
newpage A title for the\nlast page
legend right
Short
legend
endlegend

plantuml-quickstart-s2.png

应用举例 2：消息(Message)

消息分组(Grouping)
可以使用下面的关键词来实现：

  • alt/else
  • opt
  • loop
  • par
  • break
  • critical
  • group, 这个关键词后面的文字会作为组名显示在图形上


上面的关键词后可以添加一些文本用来显示在头部（注： group 除外，因为它后面的文本用来显示在组名称的位置）。在组嵌套组的结构里可以用关键词 end 来关闭组或者说是表示一个组符号的结束符（类似 if/endif ）。

消息注解(Notes)
使用 note left 或 note right 关键词

其他的注解方式(Some other notes)
通过使用关键词 note left of ， note right of 或 note over，可以把注解放置在与之相关的参与者的左边或右边，或下方。如果要使用多行注解，可以使用关键词 end note 来表示注解的结束。

Alice -> Bob: Authentication Request
note left: this is a first note
alt successful case
Bob -> Alice: Authentication Accepted
else some kind of failure
Bob -> Alice: Atuhentication Failue
group My own label
Alice -> Log : Log attack start
loop 1000 times
Alice -> Bob: DNS Attack
end
Alice -> Log : Loag alice end
end
else Another type of failue
Bob -> Alice: Please repeat
note right of Alice: This is displayed right of Alice.
note over Bob, Alice
This is yet another
example of
a long note.
end note
end

Log -> Log
note right
a note
can also be defined
on several lines
end note

plantuml-quickstart-s14.png

应用举例 3：使用 HTML 进行格式化(Formatting using HTML)
可以使用少量的 HTML 标签来格式化文本：

  • <b> 加粗文本
  • <u> 或 <u:#AAAAAA> 或 <u:colorName> 用来加下划线
  • <i> 斜体
  • <s> 或 <s:#AAAAAA> 或 <s:colorName> 用来加删除线
  • <w> 或 <w:#AAAAAA> 或 <w:colorName> 用来加波浪线
  • <color:#AAAAAA> 或 <color:colorName> 用来设置文本颜色
  • <back:#AAAAAA> 或 <back:colorName> 用来设置背景色
  • <size:nn> 设置字体大小
  • <img src="file"> 或 <img:file> 用来添加图片，图片文件必须 是可以访问得到才行。
  • <img src="http://url"> 或 <img: http://url> 用来添加一个互 联网图片，同样的图片地址必须是可用的才行。
participant Alice
participant "The <b>Famous</b> Bob" as Bob

Alice -> Bob : A <i>well formated</i> message
note right of Alice
This is <back:cadetblue><size:18>displayed</size></back>
<u>left of</u> Alice.
end note
note left of Bob
<u:red>This</u> is <color #118888>displayed</color>
<b><color purple>left of</color> <s:red>Alice</strike> Bob</b>
end note
note over Alice, Bob
<w:#FF33FF>This is hosted</w> by <img ../img/code.png>
end note

plantuml-quickstart-s17.png

5.2.4. 用例图(Use Case Diagram)

用例
用例可以用一对小括号括起来表示，也可以使用 usecase 关键词来定义，用例也可以通过使用 as 关键词来设置别名。
参与者(Actors)
定义参与者时，可以把参与者的名称放在两个冒号的中间，也可以用 actor 关键词来定义参与者。同样参与着也可以使用别名。

plantuml-quickstart-u1.png

5.2.5. 类图(Class Diagram)

5.2.6. 活动图(Activity Diagram)

完整示例 1(Complete Example)

  • 使用 (*) 来表示活动开始点和结束点。使用 –> 来表示箭头。
  • 带标注的箭头(Label on arrows)，可以通过方括号 [labels] 来设置标注
  • 改变箭头的方向(Changing arrow direction)，可以使用 -> 创建一个水平箭头，也可以通过下面的方式来改变箭头 的方向：
    • -down-> 向下（这个是默认的，等同于 =–>=）
    • -right-> 向右
    • -left-> 向左
    • -up-> 向上
  • 分支(Branches)：可以使用 if/then/else 关键词来定义分支。
  • 同步块(Synchronization)，同步块可以用“=== code ===”来表示。
  • 长文本的活动描述(Long activity description)，在定义活动的时候，有时候需要用多行文字来描述这个活动，这时我们可以在描述里添加换行符，也可以使用少量的 HTML 标签。以下是可以使用的 HTML 标签：
    <b>
  <i>
    <font size="nn"> or <size:nn> to change font size
        <font color="#AAAAAA"> or <font color="colorName">
            <color:#AAAAAA> or <color:colorName>
                <img:file.png> to include an image
  • 注释(Notes)：可以通过在脚本里使用 note 来添加注释文本块。
  • 图形标题(Title the diagram)：标题关键词 title 用来设置一个图形的标题文本，我们可以在 title 和 end title 两个关键词之间放置比较长的标题文本。
  • 皮肤(Skinparam)
    皮肤命令 skinparam 可以改变图形的颜色和字体。这些命令可以在以下 的位置中使用：
    • 在图形定义里使用
    • 在包含的文件里使用
    • 在一个配置文件里使用，这个配置文件一般由命令行或 ANT 的 Task 来提供。
  • 分区(Partition)，通过分区关键词 partition 可以定义一个分区，并且可以使用 HTML 的 颜色码或颜色名来设置分区的背景色。在你申明一个活动时，PlantUML 会自动 的把这个活动对象放置到最后使用的分区中。当然，也可以使用 end partitio 关闭分区定义。
title Simple example\nof title
skinparam activityStartColor red
/'
skinparam backgroundColor #DDD
skinparam activityBarColor SaddleBrown
skinparam activityEndColor Silver
skinparam activityBackgroundColor Peru
skinparam activityBorderColor Peru
skinparam activityFontName Impact
skinparam activityShape octagon
'/

(*) --> [You can put also labels] "First Activity"
note right: This activity has to be defined
--> "this <size:20>activity</size>
       is <b>very</b> <color:red>long</color>
       and defined on serveral lines
       that contains many <i>text</i>" as A1
--> ===B1===     
if " Some Test" then
-->[ture] "Some Activity" as someAct
--> "Another Activity" as act1
partition checkActivity
act1 -> if "Activited" then
-down->"Access Home"
-right-> (*)
else
-left->"Activiting"
-->"waiting"
-->someAct
endif
act1 -> if "error" then
-->"throw"
-->(*)
else
--> "record log"
-->(*)
endif
end partition
else
->[false] "Something else"
-->[Ending process] (*)
endif

plantuml-quickstart-a1.png

完整示例 2

'http://click.sourceforge.net/images/activity-diagram-small.png    
title Servlet Container

(*) --> "ClickServlet.handleRequest()"
--> "new Page"

if "Page.onSecurityCheck" then
->[true] "Page.onInit()"
if "isForward?" then
->[no] "Process controls"
if "continue processing?" then
-->[yes] ===RENDERING===
else
-->[no] ===REDIRECT_CHECK===
endif
else
-->[yes] ===RENDERING===
endif
if "is Post?" then
-->[yes] "Page.onPost()"
--> "Page.onRender()" as render
--> ===REDIRECT_CHECK===
else
-->[no] "Page.onGet()"
--> render
endif

else
-->[false] ===REDIRECT_CHECK===
endif

if "Do redirect?" then
->[yes] "redirect request"
--> ==BEFORE_DESTORY===
else
if "Do Forward?" then
-left->[yes] "Forward request"
--> ==BEFORE_DESTORY===
else
-right->[no] "Render page template"
--> ==BEFORE_DESTORY===
endif
endif

--> "Page.onDestory()"
-->(*)

plantuml-quickstart-a13.png

5.2.7. 活动图 Beta 版本

完整示例 1
Beta 版本的活动图简化了活动图的符号定义，从 V7947 这个版本开始， PlantUML 就开始引入了一些简化写法，当然到目前（20140627）为止还不是 很完善，但这个版本里的一些简化写法已经是 PlantUML 后续版本的发展方向。在使用新的写法之前需要把 GraphViz 更新到最新版本。

开始结束
活动元素以 : 开始，然后以 ; 结束，也可以用 start 和 end 两个关键词来表示。之前版本的开始和结束符都是用同一个符号 (*) 来表示的。
条件符号(Conditional)
还是使用 if ， then 和 else 关键词，但分支条件的标签 Labels 可以直接写在关键词 then 和 else 的后面，并用小括号括起来就可以了。
在新版本里除了使用 else 外，还新加了一个 elseif 关键词。
重复循环(Repeat Loop)
通过 repeat 和 repeat while 关键词可以创建循环结构的图形。
先执行一次循环体里的内容，然后再执行断言条件，看是否重复执行循环体。
条件循环(While Loop)
使用 while 和 end while 两个关键词来实现，如果要给条件分支加上标注，可以在 while 条件后加上一 个 is 关键词，然后用小括号括上要标注的内容
先判断是否满足条件再执行循环体里的内容。
并行处理(Parallel Processing)
使用 fork ， fork again 和 end fork 三个关键词用来表示并行处理结构。
注解的文本样式(Notes)
注解里的文本样式是通过 Creole wiki syntax 来实现的。关于 Creole 引擎 , 大家可以参考维基百科上的介绍。
' : 开始
start
note left: This is start
if (graphviz installed?) then (yes)
#purple:process all\ndiagrams;
if (multiprocessor?) then (yes)
fork
:Treatment 1;
fork again
:Treatment 2;
end fork
else (monoproc)
:Treatment 1;
:Treatment 2;
endif
elseif (graphviz installed on linux?) then (yes)
:enable linux;
repeat
:read data;
:generate diagrams;
repeat while (more data?)
else (no)
:process only
__sequence__ and __activity__ diagrams;
while (data available?) is (not empty)
:read data;
:generate diagrams;
end while (empty)
endif
end

plantuml-quickstart-b1.png

完整示例 2

start
:ClickServlet.handleRequest();
:new page;
if (Page.onSecurityCheck) then (true)
:(Page.onInit();
             if (isForward?) then (no)
             :Process controls;
             if (continue processing?) then (no)
             stop
             endif

             if (isPost?) then (yes)
             :Page.onPost();
             else (no)
             :Page.onGet();
             endif
             :Page.onRender();
             endif
             else (false)
             endif

             if (do redirect?) then (yes)
             :redirect process;
             else
             if (do forward?) then (yes)
             :Forward request;
             else (no)
             :Render page template;
             endif
             endif

             stop

plantuml-quickstart-b2.png

5.2.8. 常用快捷键(Keyboard)

Table 19: Default key bindings

快捷键描述
C-c C-cplantuml-preview: renders a PlantUML diagram from the current buffer in the best supported format
C-u C-c C-cplantuml-preview in other window
C-u C-u C-c C-cplantuml-preview in other frame

5.2.9. Org 写作 PlantUML 组件绘图生成过程

注意：在通过 PlantUML 组件画图时，目前的解决办法只能是：先指定生成图片的地址，执行生成操作，然后改为站点访问地址，最后执行发布。具体操作如下：

先指定特定生成图片地址

#+BEING_SRC plantuml :file ../../_assets/example.png 
...
#+END_SRC

执行生成操作 https://github.com/skuro/plantuml-mode

改写为访问地址

#+BEGIN_SRC plantuml :file {{site.url}}/assets/images/example.png
... 
#+END_SRC

6. Problems

6.1. Don't input chinese character

$ vim ~/.bashrc

LC_CTYPE="zh_CN.utf8"

$ sudo vim /etc/environment

LC_CTYPE="zh_CN.utf8"

6.2. Warning (server): Unable to start the Emacs server

问题描述

Warning (server): Unable to start the Emacs server 
There is an existing Emacs server, named "server". 
To start the server in this Emacs process, stop the existing 
server or call ‘M-x server-force-delete’ to forcibly disconnect it.

问题解决

打开 init.el 或 .emacs 文件，注释以下代码：（这只是临时解决办法，肯定有更好的解决方式，暂时未找到）

(server-start)
(setq server-socket-dir "~/.emacs.d/server")


参考资料

6.3. font-lock-fontify-keywords-region: Error in syntax table logic for to-the-end intervals

问题描述

M-x org-publish <RET> jekyll-zhaorengui-github-io 
font-lock-fontify-keywords-region: Error in syntax table logic for to-the-end intervals

问题解决

#+BEGIN_SRC php
echo date('Y-m-d', strtotime(date('Y-m-01') . ' -1 month')); // 计算出本月第一天再减一个月
#+END_SRC

修改为

#+BEGIN_SRC php
// 计算出本月第一天再减一个月
echo date('Y-m-d', strtotime(date('Y-m-01') . ' -1 month'));
#+END_SRC

7. References

如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群
更多

你可能也喜欢

创建 Docker Swarm 集群

重建 CentOS 或 RHEL 上被损坏的 RPM 数据库

修复 passwd:Authentication token manipulation error 的步骤

如何退出无响应的 ssh 会话

Maven 中 optional 关键字

jQuery 实现页面内锚链接平滑滚动

Android 的系统架构

WordPress 中如何更改评论者链接为站内链接

上一篇：

下一篇：

发布评论

需要 登录 才能够评论， 你可以免费 注册 一个本站的账号。
列表为空，暂无数据

关于作者

别在捏我脸啦

暂无简介

0 文章
0 评论
22 人气
发私信
更多

热门标签

操作系统 程序设计 IT运维 Linux系统管理 JavaScript 服务器应用 solaris C/C++ PHP Shell BSD Vue.js aix Oracle Python HTML 系统管理 HTML5 CSS 前端
更多

推荐作者

玍銹的英雄夢

文章 0 评论 0

我不会写诗

文章 0 评论 0

十六岁半

文章 0 评论 0

浸婚纱

文章 0 评论 0

qq_kJ6XkX

文章 0 评论 0

旧伤还要旧人安

文章 0 评论 0

更多

友情链接

文江博客
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站，即表示您同意使用 Cookies 和您的相关数据。
    原文