Render and include figures in Pandoc documents using your plotting toolkit of choice
GPL-2.0 License
Bot releases are visible (Hide)
Published by LaurentRDC almost 4 years ago
pandoc-plot
in strict mode. By default, pandoc-plot
leaves code blocks unchanged if a figure fails to be rendered. In strict mode, pandoc-plot
will immediately halt if it encounters a problem, such as a missing toolkit. You can activate strict mode via configuration:strict: true
# Possible parameters for the Matplotlib toolkit
matplotlib:
executable: python
command_line_arguments: -Wa
Or if you want julia
to use more than one thread:
# Possible parameters for the Plotsjl toolkit
plotsjl:
executable: julia
command_line_arguments: --threads auto --optimize=0
pandoc-plot
executables are now built with Github Actions.plotsjl
toolkit on Windows would sometimes fail with the error: Unknown system error 50.Published by LaurentRDC almost 4 years ago
This release brings the following additions:
as well as the following bugfix:
Published by LaurentRDC about 4 years ago
This release only brings minor changes:
pandoc-plot
has stabilized. The Haskell library API will not change until version 2+ (if that ever happens).Published by LaurentRDC about 4 years ago
This is a bug fix release with the following change:
Published by LaurentRDC about 4 years ago
This release brings a few changes:
pandoc-plot
has been moved to the Text.Pandoc.Filter.Plot.Internal
module, where there is no guarantee of backwards-compatibility after 1.0.0.makePlot
function, which could not take advantage of multithreading and other key features of pandoc-plot
.Published by LaurentRDC about 4 years ago
This release fixes a few issues.
pandoc-plot
.Published by LaurentRDC about 4 years ago
This release brings one major addition:
file
parameter, which allows the user to read figure content from a file instead of using the code block content in documents. This is especially useful for complex figures, where you might want to have the help of your tooling in an IDE, for instance. Here's an example:
```{.matplotlib file=myplot.py}
```
Additional bug fixes and improvements:
pandoc-plot clean
now follows configuration values for logging.Published by LaurentRDC about 4 years ago
This release sees a few major improvements:
pandoc-plot
via conda on Linux.bokeh
toolkit now supports exporting plots as SVGs (#8).dependencies
argument, which tells pandoc-plot
what files/directories are important to a particular figure (#10). If a file/directory listed in dependencies
changes (for example, a data file), pandoc-plot
will re-render the associated figure.Other small improvements:
bokeh
plot to save. This allows the user to export plots like the bokeh.layouts
module.dpi
parameter in graphviz
and mathematica
.exportgraphics
function introduced in MATLAB 2020a. Older versions fallback to using saveas
.Published by LaurentRDC about 4 years ago
This release sees one major change:
as well as minor changes:
Text.Pandoc.Filter.Plot.Internal
is no longer exposed; instead, everything relevant is exposed by the Text.Pandoc.Filter.Plot
module.Published by LaurentRDC over 4 years ago
This release brings two new toolkits:
bokeh
. This toolkit can take advantage of the new HTML interactive output.plotsjl
.One MAJOR addition: interactive plots!
```{.plotly_python format=html}
import plotly.express as px
df = px.data.election()
fig = px.scatter_ternary(df, a="Joly", b="Coderre", c="Bergeron")
```
Other small changes:
README.md
and into a proper MANUAL.md
. This is now the information which will be shown with pandoc-plot --manual
.pandoc-plot
version via Text.Pandoc.Filter.Plot.pandocPlotVersion
.Published by LaurentRDC over 4 years ago
This is a simple bug-fix release:
pandoc
version was not parsed properly, giving rise to errors when running pandoc-plot
.Published by LaurentRDC over 4 years ago
This release involves the following changes:
pandoc
2.8 and 2.9 are no longer supported due to a breaking API change in pandoc
2.10.open-browser
package.Published by LaurentRDC over 4 years ago
This release sees the following change:
Published by LaurentRDC over 4 years ago
This release sees a lot of refactoring, but few user-facing changes.
pandoc-plot
with LaTeX documents as well.logging:
# Possible verbosity values: debug, error, warning, info, silent
# debug level shows all messages
# error level shows all but debug messages, etc.
verbosity: info
# OPTIONAL: log to file
# Remove line below to log to stderr
filepath: log.txt
turtle
, temporary
, deepseq
, and data-default-class
, resulting in improved build times by ~10%, and makes the executable smaller by 15-20%!Published by LaurentRDC over 4 years ago
This minor release sees few changes:
availableToolkits
and unavailableToolkits
public.Published by LaurentRDC over 4 years ago
This release brings the following changes:
New toolkits:
Other changes:
The determination of which figures to re-render or not has been improved. For example, changing the caption will not trigger a re-render of a figure anymore.
pandoc-plot
will look for executables more thoroughly.
pandoc-plot toolkits
will now show the exact executable that is being used, if possible.
Added a check when running the filter that the Pandoc version is at least 2.8. This is easier to understand that the default Pandoc warning on API incompatibility.
Added the ability to write the example configuration to an arbitrary file using pandoc-plot write-example-config
.
Added the possibility to specify the configuration file via metadata. For example, in Markdown:
---
title: My document
author: John Doe
plot-configuration: /path/to/file.yml
---
or on the command line:
pandoc --filter pandoc-plot -M plot-configuration=/path/to/file.yml ...
pandoc-plot clean
and pandoc-plot toolkits
commands.Published by LaurentRDC over 4 years ago
This release sees one large change:
pandoc-plot
executable will now process documents in parallel. This should dramatically speed up processing of large documents with lots of figures. This happens automatically through the function plotTransform
.Other small changes:
defaultConfiguration
so that people don't have to install the data-default
package to get access to default configuration values.matplotlib
toolkit, preventing users from using matplotlib.pyplot.show
in figures. This would halt pandoc-plot
.Published by LaurentRDC over 4 years ago
This release fixes a critical bug:
pandoc-plot
executable could not be built outside of its git repository.This mainly affects installs from Hackage.
Published by LaurentRDC over 4 years ago
Release 0.4.0.0 sees a few changes:
--full-version
flag to the executable, which includes which version of pandoc/pandoc-types was used, as well as the git revision.clean
command to the executable. This can be used to clean-up output files produced by pandoc-plot.cleanOutputDir
to clean output of pandoc-plot. This is only accessible if pandoc-plot
is used as a library.There is one small breaking change:
--write-example-config
to the command write-example-config
. This creates a distinction between commands (which can perform IO operations), and command-line flags, which cannot.Less important changes:
pandoc-plot
will give better error messages in the latter case.Published by LaurentRDC over 4 years ago
This release sees one major change: caption formatting can now be specified in configuration files .pandoc-plot.yml
. Parsing captions based on source file was not working. This unfortunately changes the type signature of a few high-level functions.
The default caption format is "markdown+tex_math_dollars".