Skip to content

tmdoc 0.19.1

Latest
Latest

Choose a tag to compare

View all tags
@mittelmark mittelmark released this 23 Feb 09:03
v0.19.1
a235981

tmdoc - Literate programming in Markdown, Typst, AsciiDoc, LaTeX using R, Python, Octave, Julia and Tcl

New in this release:

  • version 0.19.1 fixes issues with CSV file tables where the separator is embedded within quotes
  • version 0.19.0 adds support for simple chemical equations and adds support for a tmdoc-update command which is installed as well with the installer
  • version 0.18.3 fixes an infinite waiting bug for Julia, Python etc if the last print statement does not include a newline
  • version 0.18.2 allows include syntax with HTML tag surroundings like 'include filename pre', fixing greater and lower signs in included code chunks
  • version 0.18.1 fixes an issue with R figure inclusion, code chunk import support for Python, R, JUlia and Octave added, includes with html tags arguments
  • version 0.18.0 adds support for Guitar and Ukulele chord diagrams, chord song books, fig=TRUE for matplotlib code chunks, include support in code chunks, fixes for fig=TRUE in Tcl code chunks, spport for svg to pdf and png conversion with rsvg-convert in addition to cairosvg
  • version 0.17.2 fixes an issue with more complex inline R statements
  • version 0.17.1 makes the method `nfig label` and `ntab label` public for numbering of figures and tables, styling figure legend if lines start with **Figure...
  • version 0.17.0 adds support for true HTML comments, for include, menu and kbd commands to display shortcuts and menu entry selections
  • version 0.16.7 fixes encoding issues for non-utf8 encoded input files and an issues with fig=TRUE code chunk options in Octave mode, processing speedup by reducing waiting times for code chunk execution
  • version 0.16.6 fix for long lasting computations for R, Python, Octave and Julia which before stopped output, headers in tables now as well in bold
  • version 0.16.5 fix for empty code chunk outputs if eval=FALSE, tmdoc.sty improved for R and Python output on LaTeX and as well now embedded in the package, fixing empty code chunk lines at the end
  • version 0.16.4 fixes an issue with broken pipes for errors in R code chunks on Windows, and sows now errors in Python code chunks
  • version 0.16.3 fixes issues with inline R code chunks which now support more than single words or numbers
  • version 0.16.2 fixes code chunk options with spaces around = signs, fixing toc generation if header code is within code chunks or the YAML section
  • version 0.16.1 makes output chunks pandoc compatible, fixes issues for R mode if fig=TRUE but no width given, code chunk arguments with single quotes fixed
  • Version 0.16.0 adds support for --toc command line argument, initial Julia programming language support and fixing fig.width issues
  • Version 0.15.3 fixes an issue if triple backticks appear within a code chunk
  • Version 0.15.2 renames the Tcl slave interp try to itry to avoid possible name clash with try command
  • Version 0.15.1 fixes an issue if two different users install tmdoc on the same machine
  • Version 0.15.0 adds support for AsciiDoc and Typst documents, CSV tables, YAML based abbreviations
  • Version 0.14.2 uses local installations of GraphViz dot, plantuml and ditaa for the kroki filter as kroki is sometimes offline
  • Version 0.14.1 fixes and issue with Python if there is no python application, python3 is now the default, fixing issues with image sizes for png plots in R
  • Version 0.14.0 adds support for Statistical Reports in R, Python and Octave as well switches to latex.codecs.com for LaTeX equations, documentation updates
  • Version 0.13.0 (200kb) added support for embedding CSV data for tabular displays, defining abbreviations in YAML files and display of Markdown alerts
  • Version 0.12.0 (197kb) added support for embedding LaTeX equations, Youtube videos and offers as well handling BibTeX based references.
  • Version 0.11.0 (181kb) added support for %b as basename of the current file

The application and Tcl package tmdoc provides the possibility to evaluate embedded Diagram, such as PlantUML or GraphViz Dot, LaTeX, Shell and Tcl code or board game diagrams (Go, Chess etc) in code chunks within documents of Markup languages like Markdown and LaTeX and adds the resulting output to the document for creating dynamic documents, a technique as well known as literate programming. Further you can include other Markdown files for instance to provide standard header and footers. For more information see:

Installation

On Linux, MacOS and on Windows with installed Msys2 or Cygwin download the latest
tmdoc-VERSION.bin binary (approx 150-200kb in size), rename
it to tmdoc and copy the file to a folder belonging to your PATH variable.
Thereafter make the file executable and check that it is correctly installed like
this:

wget https://github.com/mittelmark/tmdoc/releases/download/v0.19.0/tmdoc-0.19.1.bin -O ~/.local/bin/tmdoc
chmod 755 ~/.local/bin/tmdoc
tmdoc --version
## 0.19.1

There is as well the possibility to install both tmdoc and mndoc the Markdown to HTML converter in one step like this:

bash -c "$(curl -fsSL https://github.com/mittelmark/tmdoc/releases/latest/download/install-tmdoc.sh)"

To install the Tcl package just download the latest Zip or Tar-Gz archive from the release page and
unpack these files, then you just copy the modules/tmdoc folder to a folder
belonging to your TCLLIBPATH variable. Thereafter you can as well execute the
command line application using the tclmain
utility like this:

tclmain -m tmdoc --help
Assets 6
Loading