Plantuml Emacs

This tool is an Emacs plugin for Plantuml . But it will not implement plantuml’ all function. The purpose of this tool is using plantuml to generate a preview image to the frequently-used file.

Generate the relevant Mindmap or structure diagram without having to deliberately modify the current file.

Currently:

• you can generate a corresponding Mindmap and Work Breakdown Structure image based on the org mode file.
• you can generate a corresponding data struct image based on the json file or yaml file.

Prerequisites

plantuml

This Emacs tool use plantuml to generate images for org, json, yaml files.

Install

• clone the project in your own emacs configuration files directory, like:

git clone git@github.com:ginqi7/plantuml-emacs.git ~/.emacs.d/lisp/plantuml-emacs

• add the path to ‘load-path’

(add-to-list 'load-path (expand-file-name "~/.emacs.d/lisp/d/lisp/plantuml-emacs"))

Configuration

Here are a few variables that can be used for configuration:

(require 'plantuml)
(setq plantuml-jar-path "/some/path/plantuml.jar"
      plantuml-output-type "svg"
      plantuml-relative-path "./images/"
      plantuml-theme "plain"
      plantuml-font "somefont"
      plantuml-add-index-number t
      plantuml-log-command t
      plantuml-mindmap-contains-org-content t
      plantuml-org-headline-bold t)

Features

• `plantuml–parse-headlines’ Parse all headlines in current buffer (of org mode).
• `plantuml-org-to-mindmap’ Convert org file to mindmap image.
• `plantuml-display-json’ Convert json buffer to image.
• `plantuml-display-yaml’ Convert yaml buffer to image.
• `plantuml-org-to-mindmap-open’ Convert org file to mindmap image and open it.
• `plantuml-display-json-open’ Convert json buffer to image and open it.
• `plantuml-display-yaml-open’ Convert yaml buffer to image and open it.
• `plantuml-org-to-wbs’ Convert org file to Work Breakdown Structure image.
• `plantuml-org-to-wbs-open’ Convert org file to Work Breakdown Structure image and open it.
• `plantuml-auto-convert-open’ Dependen current buffer major mode convert image.

Example

Org Mode

You can find example org mode file in here.

You can generate a mindmap just contains headlines:

You can generate a mindmap contains headlines and first paragraph.

You can generate a Work Breakdown Structure image:

JSON

You can find example json file in here.

You can generate a data structure image:

YAML

You can find example json file in here

You can generate a data structure image: