summaryrefslogtreecommitdiff
path: root/readme.md
blob: 5aee0857059b08c875f9313b5646d0b5e0935ab4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
pandoc-filter-plantuml
======================

A Pandoc AST filter rendering PlantUML code blocks into vector diagrams.

This filter produces TikZ code that can be rendered as vector diagrams in PDF documents,
or as raster graphics by using another filter such as [tikz.py][tikz].


Example
-------

A PlantUML diagram in an example Pandoc Markdown file `example.md`:

    ---
    header-includes: \usepackage{tikz}
    ---
    
    ```{.puml .centered caption="Courtesy protocol" width=\columnwidth}
    @startuml
    Bob->Alice : hello
    Alice->Bob : hi
    @enduml
    ```

Using the helper scripts `pandoc-filter-plantuml.sh`:

    #/bin/sh
    java -jar pandoc-filter-plantuml.jar <&0

Can be rendered as a vector resource in a PDF by running:

    % pandoc --filter=pandoc-filter-plantuml.sh \
             --output=example.pdf \
             example.md

Or as a raster image using [tikz.py][tikz] in an HTML document with the following command:

    % pandoc --filter=pandoc-filter-plantuml.sh \
             --filter=tikz.py \
             --output=example.html \
             example.md


Options
-------

The following rendering options can be supplied as [fenced code attributes][fenced_code_attribute]:

* `.centered`: centers the diagram horizontally on the page
* `caption="Some caption"`: adds a figure caption below the diagram
* `label="somelabel"`: adds a label to the figure
* `width=\columnwidth` and `height=100pt`: resize the diagram using the `\resizebox` command,
  keeping the aspect ration of only one of the two is given


Build
-----

The project can be built using the Gradle `build` task.

An autonomous jar file can be generated using the `jar` task.


License
-------

Copyright (C) 2018 Pacien TRAN-GIRARD

_pandoc-filter-plantmul_ is distributed under the terms of GNU Affero General Public License v3.0,
as detailed in the attached `license.md` file.

Builds of this software embed and make use of the following Libraries:

* Kotlin Standard Library, licensed under the Apache 2.0 License
* Jackson JSON processor streaming parser/generator, licensed under the Apache 2.0 License
* PlantUML, licensed under the GNU General Public License


[tikz]: https://github.com/jgm/pandocfilters/blob/master/examples/tikz.py
[fenced_code_attribute]: http://pandoc.org/MANUAL.html#fenced-code-blocks