Pandoc-mm
Generate a mindmap from an org-mode file. Complete with annotations.
Foreword
This is just a tiny wrapper built on the shoulders of a giant.
Example
Generate this:
from this:
#+TITLE: Category Theory
#+AUTHOR: Vittorio Zaccaria
#+COLUMNS: %20ITEM %10color %10placement
#+FONT: Fira Sans
#+MONOFONT: Inconsolata
# #+HELPLINES: [show grid integer coordinates, thin] (-8,-8) grid (8,8)
* Category
:PROPERTIES:
:color: blue!30
:placement: 18,0
:END:
A triple $\mathcal{C}(O, M, \bullet)$ where
- $\forall o \in O, \exists id_o \in M$
- $\bullet$ is defined for all connected objects
- $\bullet(A \rightarrow B, B \rightarrow C) = A \rightarrow C$
- $(f \bullet g) \bullet h == f \bullet (h \bullet g)$
- $id_x \bullet f = f \bullet id_y$
** Monoid
:PROPERTIES:
:END:
*** Free Monoid
:PROPERTIES:
:END:
A free monoid of M is just a monoid $\mathcal{M}(List[M], [], ++)$.
*** Free Monoid
:PROPERTIES:
:placement: 15, -5
:END:
A free monoid of M is just a monoid $\mathcal{M}(List[M], [], ++)$.
*** Action
:PROPERTIES:
:END:
An action of a $\mathcal{M}(M, id_0, \star)$ over a set $S$ of states is a
function \[ M \times S \rightarrow S \]
It is equivalent to an automata
* Functors
** Bi-functors
* Natural Transformations
Installation
I'd strongly suggest to install it through Stack:
git clone https://github.com/vzaccaria/pandoc-mm.git
cd pandoc-mm
stack install .
This should compile the binary and put it into something reachable in your path. In my case this is ~/.local/bin.
Usage
pandoc-mm FILE [ -x ]
pandoc-mm --help | -h
pandoc-mm --version
Options:
-x, --latex Output raw latex
-h, --help Show help
--version Show version.
Arguments
FILE Org file containing the mindmap
Without the -x option, it generates a pdf with xelatex and pdfcrop. Otherwise, it generates standalone latex you can compile with your own toolchain.
Supported syntax
:PROPERTIES: can be the following:
-
:color:is any color in a syntax understandable by Tikz. -
:placement:absolute coordinates of the annotation. If not present, i) it is assumed to be placed below the previous annotation or ii) if it is the first annotation then it is assumed to becurrent page.south east. Use propertyHELPLINES(see commented text in the example above) to show a help grid in the pdf.
Warning: it turns out that the official org-mode grammar does not accept spaces between properties, or between properties and headings. These are thus invalid headings:
* Category
:PROPERTIES:
:color: blue!30
:END:
or:
* Category
:PROPERTIES:
:color: blue!30
:END:
Faq
- Why? Just for fun.
- What about markdown? PR welcome!
