Make mention of alternative exec modes
This commit is contained in:
parent
56346a6e3a
commit
43df82548a
37
README.md
37
README.md
|
@ -32,15 +32,18 @@ Alice <-- Bob: Another authentication Response
|
||||||
4. Preview diagrams with `C-c C-c` (`plantuml-preview`).
|
4. Preview diagrams with `C-c C-c` (`plantuml-preview`).
|
||||||
|
|
||||||
**WARNING:** This may send information to
|
**WARNING:** This may send information to
|
||||||
`"https://www.plantuml.com/plantuml"`!
|
`"https://www.plantuml.com/plantuml"`! Check that
|
||||||
|
`plantuml-default-exec-mode` is configured correctly for your use case
|
||||||
Before previewing any sensitive material, check that
|
before previewing any sensitive material.
|
||||||
`plantuml-jar-path` is correct for your use case and that
|
|
||||||
`plantuml-default-exec-mode` is set to `jar`.
|
|
||||||
|
|
||||||
```lisp
|
```lisp
|
||||||
(setq plantuml-jar-path "/path/to/your/copy/of/plantuml.jar")
|
;; Sample jar configuration
|
||||||
(setq plantuml-default-exec-mode 'jar)
|
(setq plantuml-jar-path "/path/to/your/copy/of/plantuml.jar")
|
||||||
|
(setq plantuml-default-exec-mode 'jar)
|
||||||
|
|
||||||
|
;; Sample executable configuration
|
||||||
|
(setq plantuml-executable-path "/path/to/your/copy/of/plantuml.bin")
|
||||||
|
(setq plantuml-default-exec-mode 'executable)
|
||||||
```
|
```
|
||||||
|
|
||||||
See [Execution modes](#execution-modes) for more information.
|
See [Execution modes](#execution-modes) for more information.
|
||||||
|
@ -49,17 +52,17 @@ See [Execution modes](#execution-modes) for more information.
|
||||||
|
|
||||||
Make sure you have [MELPA](http://melpa.org/) enabled in your ``emacs.d``. Then, you can just
|
Make sure you have [MELPA](http://melpa.org/) enabled in your ``emacs.d``. Then, you can just
|
||||||
|
|
||||||
M-x package-install<RET>
|
M-x package-install<RET>
|
||||||
plantuml-mode<RET>
|
plantuml-mode<RET>
|
||||||
|
|
||||||
Also, to enable preview you need to tell `plantuml-mode` where to locate the PlantUML JAR file. By default it will look for it in `~/plantuml.jar`, but you can specify any location with:
|
Also, to enable preview you need to tell `plantuml-mode` where to locate the PlantUML JAR file. By default it will look for it in `~/plantuml.jar`, but you can specify any location with:
|
||||||
|
|
||||||
M-x customize-variable<RET>
|
M-x customize-variable<RET>
|
||||||
plantuml-jar-path<RET>
|
plantuml-jar-path<RET>
|
||||||
|
|
||||||
You can also download the latest version of PlantUML straight into `plantuml-jar-path`:
|
You can also download the latest version of PlantUML straight into `plantuml-jar-path`:
|
||||||
|
|
||||||
M-x plantuml-download-jar<RET>
|
M-x plantuml-download-jar<RET>
|
||||||
|
|
||||||
# Features
|
# Features
|
||||||
|
|
||||||
|
@ -72,8 +75,8 @@ You can also download the latest version of PlantUML straight into `plantuml-jar
|
||||||
|
|
||||||
You can automatically enable `plantuml-mode` for files with extension `.plantuml` by adding the following to your `.emacsrc`:
|
You can automatically enable `plantuml-mode` for files with extension `.plantuml` by adding the following to your `.emacsrc`:
|
||||||
|
|
||||||
;; Enable plantuml-mode for PlantUML files
|
;; Enable plantuml-mode for PlantUML files
|
||||||
(add-to-list 'auto-mode-alist '("\\.plantuml\\'" . plantuml-mode))
|
(add-to-list 'auto-mode-alist '("\\.plantuml\\'" . plantuml-mode))
|
||||||
|
|
||||||
Of course, you can always enable manually the major mode by typing `M-x plantuml-mode` once in the desired PlantUML file buffer.
|
Of course, you can always enable manually the major mode by typing `M-x plantuml-mode` once in the desired PlantUML file buffer.
|
||||||
|
|
||||||
|
@ -95,11 +98,11 @@ If you want to force a specific output format, you can customize the variable `p
|
||||||
|
|
||||||
The following shortcuts are enabled by default:
|
The following shortcuts are enabled by default:
|
||||||
|
|
||||||
C-c C-c plantuml-preview: renders a PlantUML diagram from the current buffer in the best supported format
|
C-c C-c plantuml-preview: renders a PlantUML diagram from the current buffer in the best supported format
|
||||||
|
|
||||||
C-u C-c C-c plantuml-preview in other window
|
C-u C-c C-c plantuml-preview in other window
|
||||||
|
|
||||||
C-u C-u C-c C-c plantuml-preview in other frame
|
C-u C-u C-c C-c plantuml-preview in other frame
|
||||||
|
|
||||||
## Integration with `org-mode`
|
## Integration with `org-mode`
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue