Skip to content

Commit c5330de

Browse files
Update README.org (syl20bnr#15657)
1 parent c8c7c85 commit c5330de

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

layers/+lang/plantuml/README.org

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,31 +42,41 @@ For example, the following diagram can be defined as follows:
4242
- Controlling the =Plantuml= compiler directly from emacs
4343

4444
* Install
45-
To use this contribution add it to your =~/.spacemacs=
45+
To use this contribution, add it to your =~/.spacemacs=
4646

4747
#+BEGIN_SRC emacs-lisp
4848
(setq-default dotspacemacs-configuration-layers '(plantuml))
4949
#+END_SRC
5050

51-
To control the =Plantuml= compiler you also need to download the [[http://plantuml.com/download][Plantuml jar]]
52-
and configure the =plantuml-jar-path= respectively:
51+
** Execution modes
5352

53+
Configure plantuml-mode to either make use of a =Plantuml= library, executable or server (experimental).
54+
55+
If you want to call your local Plantuml library, set =plantuml-jar-path= and =plantuml-default-exec-mode= as follows:
5456
#+BEGIN_SRC emacs-lisp
55-
(setq-default dotspacemacs-configuration-layers '((plantuml :variables plantuml-jar-path "~/plantUml.jar")))
57+
(setq-default dotspacemacs-configuration-layers '((plantuml :variables
58+
plantuml-jar-path "~/plantUml.jar"
59+
plantuml-default-exec-mode 'library)))
5660
#+END_SRC
61+
For this to work, you need to execute =plantuml-download-jar= to download the most recent =Plantuml= library jar to your home directory.
5762

58-
To get the full range of =Plantuml= compilations working, you will also need
59-
the native package [[http://graphviz.org/][graphviz]] installed on your system.
63+
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:
64+
#+BEGIN_SRC emacs-lisp
65+
(setq-default dotspacemacs-configuration-layers '((plantuml :variables
66+
plantuml-executable-path "/usr/bin/plantuml"
67+
plantuml-default-exec-mode 'executable)))
68+
#+END_SRC
6069

61-
If you don't want to compile locally you can set =plantuml-exec-mode= to =server=.
62-
This will make plantuml try to use an online compile server. Be warned these resources
63-
change often and plantuml-mode is not always up-to-date. For a stable user experience
64-
we recommend using the default jar option instead.
70+
If instead you don't want to compile locally, you can set =plantuml-exec-mode= to =server=.
71+
This will make plantuml try to use an online compile server. Be warned that this feature is experimental.
6572

6673
#+BEGIN_SRC emacs-lisp
6774
(setq-default dotspacemacs-configuration-layers '((plantuml :variables plantuml-default-exec-mode 'server)))
6875
#+END_SRC
6976

77+
Either way, to get the full range of =Plantuml= compilations working, you will also need
78+
the native package [[http://graphviz.org/][graphviz]] installed on your system.
79+
7080
* Org-Babel Integration
7181
To enable the execution of embedded plantuml code blocks within [[http://orgmode.org/][Org-Mode]]
7282
documents, define a value for =org-plantuml-jar-path= in your =~/.spacemacs=:

0 commit comments

Comments
 (0)