From 0313b09e5ee252d30752be0b3f096e1f626ec05d Mon Sep 17 00:00:00 2001 From: Carlo Sciolla Date: Fri, 31 May 2019 09:02:22 +0200 Subject: [PATCH] Some docs + SSL - added relnotes - added README docs - switched to HTTPS for the default server --- README.md | 22 ++++++++++++++++++++++ plantuml-mode.el | 3 ++- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bf2ae91..65ec16f 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ You can also download the latest version of PlantUML straight into `plantuml-jar - Syntax highlight - Autocompletion - Preview of buffer or region +- [EXPERIMENTAL] Use either local JAR or remote server for preview # Enable the major mode @@ -88,6 +89,27 @@ Then you can edit a `plantuml` code block with `plantuml-mode` by hitting `C-'` When in the `plantuml-mode` buffer you can then hit again `C-'` to return to the original `org-mode` document. +# Execution modes + +**EXPERIMENTAL** + +As of `v1.3.0` support is added for switching execution mode. The following two modes are available: + +- `jar` (default) to run PlantUML as a local JAR file. This is the traditional system used by `plantuml-mode` +- `server` (experimental) to let an instance of [`plantuml-server`](https://github.com/plantuml/plantuml-server) render the preview + +You can customize `plantuml-default-exec-mode` or run `plantuml-set-exec-mode` from a `plantuml-mode` buffer to switch modes. + +## Configure server rendering + +When selecting `server` execution modes, you can customize the following variable to set the server to use for rendering: + +``` +plantuml-server-url +``` + +It defaults to `"https://www.plantuml.com/plantuml"`. + # Migration from `puml-mode` If you were previously using `puml-mode`, you should change any reference to a `puml-..` variable or function to its `plantuml-..` counterpart. Most notably, `puml-plantuml-jar-path` is now just `plantuml-jar-path`. diff --git a/plantuml-mode.el b/plantuml-mode.el index 5c26ffe..607b5a8 100644 --- a/plantuml-mode.el +++ b/plantuml-mode.el @@ -37,6 +37,7 @@ ;;; Change log: ;; +;; version 1.3.0, 2019-05-31 Added experimental support for multiple rendering modes and, specifically, preview using a PlantUML server ;; version 1.2.11, 2019-04-09 Added `plantuml-download-jar' ;; version 1.2.10, 2019-04-03 Avoid messing with window layouts and buffers -- courtesy of https://github.com/wailo ;; version 1.2.9, Revamped indentation support, now working with a greater number of keywords @@ -111,7 +112,7 @@ :type '(repeat string) :group 'plantuml) -(defcustom plantuml-server-url "http://www.plantuml.com/plantuml" +(defcustom plantuml-server-url "https://www.plantuml.com/plantuml" "The base URL of the PlantUML server." :type 'string :group 'plantuml)