search

the-ted / org-mind-map

This is an emacs package that creates graphviz directed graphs.
GNU General Public License v3.0
542 stars 53 forks source link

readme

org-mind-map

This is an emacs package that creates graphviz directed graphs from org-mode files. This project is currently unmaintained! If anyone would like to take this over an fix up my (very messy) code, please let me know.

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")

or if you're using use-package:

;; This is an Emacs package that creates graphviz directed graphs from
;; the headings of an org file
(use-package org-mind-map
  :init
  (require 'ox-org)
  :ensure t
  ;; Uncomment the below if 'ensure-system-packages` is installed
  ;;:ensure-system-package (gvgen . graphviz)
  :config
  (setq org-mind-map-engine "dot")       ; Default. Directed Graph
  ;; (setq org-mind-map-engine "neato")  ; Undirected Spring Graph
  ;; (setq org-mind-map-engine "twopi")  ; Radial Layout
  ;; (setq org-mind-map-engine "fdp")    ; Undirected Spring Force-Directed
  ;; (setq org-mind-map-engine "sfdp")   ; Multiscale version of fdp for the layout of large graphs
  ;; (setq org-mind-map-engine "twopi")  ; Radial layouts
  ;; (setq org-mind-map-engine "circo")  ; Circular Layout
  )

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:

examples/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:

examples/example-2.org.pdf

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:

examples/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:

examples/example-5.org.png

Including text

You can also control the display of text within each heading with the org-mind-map-include-text option. When set to t, this displays all of the paragraph text underneath a given headline.

For example,

* Branch One
** Branch Two
   Here is some interesting text...

** Branch Three
*** Example
    - Plain lists show up as additional paragraphs

    [[http://www.google.com/][But links don't show up at all]]

    #+BEGIN_SRC
    Nor do source code blocks.
    #+END_SRC

this results in this file:

examples/example-7.png

Including images BETA

You can also now include PNG files. These will be included as sub-headings. The images are currently scaled to a rectangle of 100px by 100px. This may be updated in the future.

For example,

* Node A

** Node B

   Example paragraph

   [[Node C]]

   [[./Lena.png]]

** Node C

   More details

** Node D

   [[Node A]]

Results in this file:

examples/example-8.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-current-tree to just create a map from the current tree.