/plantuml-server.el

Communicate with the plantuml server to generate uml diagrams

Primary LanguageEmacs Lisp

plantuml-server.el

This is a tool used to evaluate code written in the plantuml scripting language, and create diagrams from it. The resulting diagrams are created on the plantuml server. This is especially useful for quickly looking at sections of plantuml code.

The first function plantuml-eval-to-other-window is used to evaluate a region to a separate buffer window to view the resulting diagram in ascii. Currently it is very buggy, due to several restrictions on how certain arguments are handled.

The function plantuml-eval-to-browser evaluates the region on the screen, and opens your browser to display the resulting SVG for the given evaluated region.

As an example, evaluating this given snippet of code:

@startuml
participant Bob
actor Alice

Bob -> Alice : hello
Alice -> Bob : Is it ok?
@enduml

with plantuml-eval-to-other-window will produce a separate buffer called PlantUML-Ascii containing the text

                 ,-.  
                 `-'  
                 /|\  
,---.             |   
|Bob|            / \  
`-+-'           Alice 
  |    hello      |   
  |-------------->|   
  |               |   
  |  Is it ok?    |   
  |<--------------|   
,-+-.           Alice 
|Bob|            ,-.  
`---'            `-'  
                 /|\  
                  |   
                 / \   

If I instead were to use the command plantuml-eval-to-browser, it would open the default web browser, and display this

installation

Installation requires you to place plantuml-server.el somewhere on your emacs path, and call:

(require 'plantuml-server)