File: ob-ditaa.el.html
Org-Babel support for evaluating ditaa source code.
Source code blocks of type ditaa have some special features:
- there is no such thing as a "session"
- :export results is the default
- only results of type "file" are returned
- there are no variables
- three different variants of "ditaa" exist: a ditaa executable
(shell script), ditaa.jar Java archive and DitaaEPS.jar Java
archive; the third one is a fork generating eps output, and is
also a prerequisite for producing pdf output; ob-ditaa supports
all three of these; if ditaa.jar or DitaaEPS.jar is used, paths
to file(s) must be set; the following table summarizes which
variant is used in which case; column mode refers to
org-ditaa-default-exec-mode
| mode | output | command |
|----------------+----------+-----------------------------------------------------|
| ditaa | png, svg | org-ditaa-exec |
| jar | png, svg | org-ditaa-java-exec -jar org-ditaa-jar-path |
| ditaa, jar | eps | org-ditaa-java-exec -jar org-ditaa-eps-jar-path |
| ditaa, jar | pdf | org-ditaa-java-exec -jar org-ditaa-eps-jar-path |
- standard header argument "cmdline" controls command line parameters passed to ditaa
- the following header arguments are added:
"java" : additional parameters passed to java if ditaa run via a jar
Defined variables (7)
org-babel-default-header-args:ditaa | Default arguments for evaluating a ditaa source block. |
org-babel-ditaa-java-cmd | Java executable to use when evaluating ditaa blocks using a JAR. |
org-ditaa-default-exec-mode | Method to use for ditaa diagram generation when generating png or svg output. |
org-ditaa-eps-jar-path | Path to the DitaaEps.jar executable. |
org-ditaa-exec | File name of the ditaa executable. |
org-ditaa-jar-path | Path to the ditaa.jar file. |
org-ditaa-java-exec | Java executable to use when evaluating ditaa blocks using a JAR. |
Defined functions (3)
ob-ditaa--ensure-jar-file | (FILE) |
org-babel-execute:ditaa | (BODY PARAMS) |
org-babel-prep-session:ditaa | (SESSION PARAMS) |