Literate programming tool using Markdown (since version 0.1) or LaTeX (since version 0.4) as markup languages and Tcl, or tools like GraphViz, PlantUML or R as the programming language. Tcl code can be embedded directly in the text using single backticks or as code blocks using triple backticks. A good example is the extensive tutorial for the tmdoc::tmdoc package at http://htmlpreview.github.io/?https://github.com/mittelmark/tmdoc/blob/master/modules/tmdoc/tmdoc-tutorial.html
Usage: Intermixed Markdown or LaTeX markup and Tcl, GraphViz, PlantUML or R code in a tmd or .tnw file that can converted to Markdown/LaTeX using the tmdoc command line application. Afterwards the Markdown document can converted to other documentation formats like HTML, PDF or Unix manual pages for instance using the mkdoc::mkdoc or pandoc or pdflatex/xelatex command line tools.
tmdoc docu.tmd docu.md # afterwards Markdown can be converted to HTML or PDF for instance using pandoc pandoc -i doc.md -s --highlight-style pygments -c dgw.css -o docu.html # processing a LaTeX command with backticked embedded Tcl code tmdoc docu.tnw --outfile docu.tex pdflatex docu.tex
Code chunks:
tmdoc supports three type of code chunks, Tcl code chunks, generic command line tool code chunks or kroki code chunks using the https://kroki.io web service.
Are starting after three backticks and a {tcl} indication of the programming language. Here an example:
```{tcl echo=false}
set x 1
puts $x
```Further short Tcl code can be embedded directly within the text using single backticks:
The current date and time is: `tcl clock format [clock seconds] -format "%Y-%m-%d %H:%M"`
Should embed the current date and time in the text.
The manual states as well support for images created from Tcl for instance using commands from gdtcl or the canvas widget. For more information have a look at the tutorial http://htmlpreview.github.io/?https://github.com/mittelmark/tmdoc/blob/master/modules/tmdoc/tmdoc-tutorial.html and the manual pages for the package http://htmlpreview.github.io/?https://github.com/mittelmark/tmdoc/blob/master/modules/tmdoc/tmdoc.html and the tmdoc application http://htmlpreview.github.io/?https://github.com/mittelmark/tmdoc/blob/master/apps/tmdoc.html
You can as well embed other programming languages like R if you use the knitr tool:
So this is possible:
Here some R code:
```{r}
print("Hello R World!")
```
Now same document Tcl code:
```{tcl}
puts "Hello Tcl World";
```If you mix R and Tcl you must first run tmdoc and afterwards knitr . My Makefile for another tutorial looks like this:
default:
tmdoc ../t3-tut.tmd > t3-tut.rmd
echo "library(knitr);knitr::knit('t3-tut.rmd',output='t3-tut.md');" | R --slave
pandoc -i t3-tut.md -s --highlight-style pygments -c ../dgw.css -o t3-tut.html
You can not start knitr first, as it can't handle Tcl commands.
Since Version 0.8.0 you can embed as well command line applications like this:
```{.cmd cmd="dot -Tpng -o%o %i" echo=false}
digraph g {
rankdir="LR"
node[shape=box,style=filled]
A->B->C
}
```The code above will embed the GraphViz image within your documentation but will hide the diagram code. Obviously you need to have GraphViz dot to be installed on your system.
This syntax can be as well used to embed R (or Python, or Octave code) to perform statistical analysis. Here an example from the tutorial for using R:
```{.shell cmd="Rscript %i %o"}
### outfile is the argument %o
outfile=commandArgs(trailingOnly=TRUE)[1]
png(outfile)
par(mai=rep(0.1,4))
pie(rep(1,20),col=rainbow(20))
dev.off()
```More examples can be seen in the tutorial .
Changes:
See also:
Discussion:
Please discuss here ...
DDG 2020-02-19: Please note, that this is a work in progress. I am open for suggestions. But tmdoc should basically have a reasonable subset of the functionality of R's Sweave https://stat.ethz.ch/R-manual/R-devel/library/utils/doc/Sweave.pdf and R markdown https://rmarkdown.rstudio.com/
DDG 2020-11-09: With version 0.4 LaTeX support was added. Project now as well on Github.
DDG 2025-01-19: Tcl 9 aware version as well with support for results=asis code chunk option and include and listmdtab functions