This is an emacs package that creates graphviz directed graphs.
Emacs Lisp
Switch branches/tags
Nothing to show
Clone or download
theodorewiles Merge pull request #28 from whatacold/fix-dead-links
Fix dead links of graphviz documentation.
Latest commit c0578ee Jun 14, 2018

README.md

org-mind-map

This is an emacs package that creates graphviz directed graphs from org-mode files.

Requirements

This package relies on the Graphviz suite of graphical diagramming tools.

windows

(the default option), these tools are available via cygwin.

linux

these tools are available through any of the popular package managers.

mac

binarys are at the graphviz site, but for recent versions like El Capitan, Sierra and High Sierra, macports or homebrew are recommended.

brew install graphviz

This package also relies on the org-mode and dash libraries, available from melpa (M-x list-packages).

Installation and usage

To install, add this code to your .emacs:

(load "INSTALLPATH/org-mind-map.el")

Then, run M-x org-mind-map-write within the org-mode file you would like to make a mind-map for. If all works as expected, a PDF file will be generated in the same directory as the org file.

Examples

Basic concept

Here is an example org-mode tree that demonstrates the basic concept:

* This is an example org-mode tree
The content of the node doesn't matter.
** Branch A
*** Sub-Branch 1
*** Sub-Branch 2
*** Sub-Branch 3
** Branch B
** Branch C
** Branch D

and the result is shown below:

example-1.org.pdf

Tags

You can also add tags, as in this org-mode file:

* This is an org-mode tree with tags
** Branch A :TagA:
*** Sub-Branch 1 :TagA:
*** Sub-Branch 2 :TagA:
*** Sub-Branch 3 :TagA:TagB:
** Branch B :TagB:
** Branch C
** Branch D

These are randomly color-coded into pastel tags:

example-2.org.pdf

Interleaving Graphs

Finally, by naming headlines across your org-mode file, as shown below, you can interleave trees.

* This is an org-mode tree with tags
** Branch A :TagA:
*** Sub-Branch 1 :TagA:
*** Sub-Branch 2 :TagA:
*** Sub-Branch 3 :TagA:TagB:
** Branch B :TagB:
** Branch C
** Branch D
* This is an org-mode tree that interleaves
** Branch E
*** Sub-Branch 3
*** Sub-Branch 3 :TagA:TagB:
** Branch B

this results in this file:

example-3.org.pdf

Note that the interleaving is done based on the exact text of the headline, so these have to exactly match (including tags).

Selective Colors

If you would like a node to show up as a specific color, you can add the :OMM-COLOR: and :OMM-LEGEND: properties to a node. The node will be colored in, and a legend entry item will be added, as shown below:

* This is an org-mode tree with tags
:PROPERTIES:
:OMM-COLOR: GREEN
:OMM-LEGEND: Legend entry
:END:

** Branch A 
*** Sub-Branch 1 
*** Sub-Branch 2 
*** Sub-Branch 3 

** Branch B


** Branch C 
** Branch D 
* This is an org-mode tree that interleaves :TagOne:
** Branch E
*** Sub-Branch 3 :TagTwo:

*** Sub-Branch 3 :TagOne:
** Branch B
** Branch C

this results in this file:

example-4.org.png

Links

You can also draw edges between nodes by including links to headlines in your Org mode files. Links will be drawn from the parent heading to the heading of the destination link. This works as shown below:

* This is an org-mode tree with tags
:PROPERTIES:
:OMM-COLOR: GREEN
:OMM-LEGEND: Legend entry
:END:

** Branch A 
*** Sub-Branch 1 
*** Sub-Branch 2 
*** Sub-Branch 3 

** Branch B


** Branch C 
** Branch D 
* Here is another tree
** Branch One
** Branch Two
   [[Branch C]]
** Branch Three

   [[Branch One][Another link]]

   [[Sub-Branch 1][Yet Another Link]]

this results in this file:

example-5.org.png

Thanks!

http://pages.sachachua.com/evil-plans/

Other Options

Customize the org-mind-map-engine variable to specify additional layout options (e.g. radial layouts where root nodes are in the center of the graph), and customize org-mind-map-rankdir to specify if the chart is going up-and-down or left-to-right.

Selective Export

Use the command org-mind-map-write-tree to just create a map from the current tree.