97 lines
4.1 KiB
Org Mode
97 lines
4.1 KiB
Org Mode
#+TITLE: plantuml layer
|
|
|
|
#+TAGS: dsl|layer|markup|programming
|
|
|
|
[[file:img/logo.png]]
|
|
|
|
* Table of Contents :TOC_5_gh:noexport:
|
|
- [[#description][Description]]
|
|
- [[#features][Features:]]
|
|
- [[#install][Install]]
|
|
- [[#execution-modes][Execution modes]]
|
|
- [[#org-babel-integration][Org-Babel Integration]]
|
|
- [[#key-bindings][Key bindings]]
|
|
|
|
* Description
|
|
This layer enables support for [[https://github.com/skuro/plantuml-mode][plantuml-mode]], which provides
|
|
a major-mode for [[http://plantuml.com][plantuml]]. PlantUML is a tool to generate [[https://en.wikipedia.org/wiki/Unified_Modeling_Language][UML diagrams]] from plain-text.
|
|
|
|
For help with how to use plantuml, see the [[http://plantuml.com][plantuml website]] and the [[http://plantuml.com/guide][reference guide]].
|
|
|
|
The official file extension supported by this layer is =.pum=. and =.puml=. If you want something else,
|
|
set it in your =user-config= function of your =~/.spacemacs= file.
|
|
|
|
For example, the following diagram can be defined as follows:
|
|
|
|
#+BEGIN_SRC plantuml
|
|
@startuml
|
|
JAremko->robbyoconnor : I think the docs can benefit from some kind of illustration
|
|
JAremko<-robbyoconnor : I'm too lazy -- I have actual work to do. I link to the docs. If you can write me a diagram in plantuml, I'll gladly compile and add it.
|
|
JAremko->robbyoconnor : *gives ths diagram*
|
|
robbyoconnor<-JAremko : *robbyoconnor adds it and JAremko is happy*
|
|
...
|
|
robbyoconnor->theOtherPerson : And they thinks it's funny? Yup, they definitely finds it funny. Right?
|
|
@enduml
|
|
#+END_SRC
|
|
|
|
[[file:img/dia.png]]
|
|
|
|
** Features:
|
|
- Syntax highlighting
|
|
- Diagram preview in various output formats
|
|
- Embedding into org documents
|
|
- Controlling the =Plantuml= compiler directly from emacs
|
|
|
|
* Install
|
|
To use this contribution, add it to your =~/.spacemacs=
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
(setq-default dotspacemacs-configuration-layers '(plantuml))
|
|
#+END_SRC
|
|
|
|
** Execution modes
|
|
Configure plantuml-mode to either make use of a =Plantuml= library, executable or server (experimental).
|
|
|
|
If you want to call your local Plantuml library, set =plantuml-jar-path= and =plantuml-default-exec-mode= as follows:
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
(setq-default dotspacemacs-configuration-layers '((plantuml :variables
|
|
plantuml-jar-path "~/plantUml.jar"
|
|
plantuml-default-exec-mode 'library)))
|
|
#+END_SRC
|
|
|
|
For this to work, you need to execute =plantuml-download-jar= to download the most recent =Plantuml= library jar to your home directory.
|
|
|
|
If instead you want to call your local Plantuml executable (f.e. as installed to path =/usr/bin/plantuml= by your package manager), set =plantuml-executable-path= and =plantuml-default-exec-mode= as follows:
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
(setq-default dotspacemacs-configuration-layers '((plantuml :variables
|
|
plantuml-executable-path "/usr/bin/plantuml"
|
|
plantuml-default-exec-mode 'executable)))
|
|
#+END_SRC
|
|
|
|
If instead you don't want to compile locally, you can set =plantuml-exec-mode= to =server=.
|
|
This will make plantuml try to use an online compile server. Be warned that this feature is experimental.
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
(setq-default dotspacemacs-configuration-layers '((plantuml :variables plantuml-default-exec-mode 'server)))
|
|
#+END_SRC
|
|
|
|
Either way, to get the full range of =Plantuml= compilations working, you will also need
|
|
the native package [[http://graphviz.org/][graphviz]] installed on your system.
|
|
|
|
* Org-Babel Integration
|
|
To enable the execution of embedded plantuml code blocks within [[http://orgmode.org/][Org-Mode]]
|
|
documents, define a value for =org-plantuml-jar-path= in your =~/.spacemacs=:
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
(setq-default dotspacemacs-configuration-layers '((plantuml :variables plantuml-jar-path "~/plantUml.jar" org-plantuml-jar-path "~/plantUml.jar")))
|
|
#+END_SRC
|
|
|
|
* Key bindings
|
|
|
|
| Key binding | Description |
|
|
|--------------------------+-------------------------------------------------------|
|
|
| ~SPC m c c~ or ~C-c C-c~ | Build diagram from the text in the current buffer |
|
|
| ~SPC m c o~ | Set the output type (=unicode text=, =svg=, or =png=) |
|