Changelog for pandoc-plot-0.9.1.0
Change log
pandoc-plot uses Semantic Versioning
Release 0.9.1.0
- Added the
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}
```
- Better error messages when specifying logger verbosity.
- Cleaning output directories with
pandoc-plot clean
now follows configuration values for logging. - Fixed an issue where configuration in metadata did not get parsed properly.
Release 0.9.0.0
- The
bokeh
toolkit now supports exporting plots as SVGs (#8). - Interactive plots relying on javascript scripts will now defer loading the scripts (#9).
- Added the
dependencies
argument, which tellspandoc-plot
what files are important to a particular figure (#10). If a file listed independencies
changes (for example, a data file),pandoc-plot
will re-render the associated figure. - Better heuristic to determine what
bokeh
plot to save. This allows the user to export plots like thebokeh.layouts
module. - Added support for the
dpi
parameter ingraphviz
andmathematica
. - Added support for MATLAB's new
exportgraphics
function introduced in MATLAB 2020a. Older versions fallback to usingsaveas
.
Release 0.8.1.0
- The module
Text.Pandoc.Filter.Plot.Internal
is no longer exposed; instead, everything relevant is exposed by theText.Pandoc.Filter.Plot
module. - Fixed an issue where script errors would be logged as debug messages.
- Interactive plots are now embedded directly in output (#7).
Release 0.8.0.0
- Added a new output format, HTML, to produce interactive plots. Not all renderers support it. You can try with Plotly/Python and Plotly/R as follows:
```{.plotly_python format=html}
import plotly.express as px
df = px.data.election()
fig = px.scatter_ternary(df, a="Joly", b="Coderre", c="Bergeron")
```
- Added a new toolkit,
bokeh
. This toolkit can take advantage of the new HTML interactive output. - Added a new toolkit,
plotsjl
. - Separated the detailed information from
README.md
and into a properMANUAL.md
. This is now the information which will be shown withpandoc-plot --manual
. - Exposed the
pandoc-plot
version viaText.Pandoc.Filter.Plot.pandocPlotVersion
.
Release 0.7.2.1
- Fixed an issue where the
pandoc
version was not parsed properly, giving rise to errors when runningpandoc-plot
. - Fixed an issue where logging errors were not always displayed.
Release 0.7.2.0
- Removed dependency on
open-browser
package. - Starting with this version,
pandoc
2.8 and 2.9 are no longer supported due to a breaking API change inpandoc
2.10. - Executables are now built with GHC 8.10.1.
Release 0.7.1.0
- Better multi-threaded logging. Only one thread (the logging thread) performs IO on the log file. This prevents hang-ups when working on large documents.
Release 0.7.0.0
- Added documentation on using
pandoc-plot
with LaTeX documents as well. - Added preliminary support for logging to
pandoc-plot
. You can turn on this feature in the configuration as follows:
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
- Removed dependencies
turtle
,temporary
,deepseq
, anddata-default-class
, resulting in improved build times by ~10%, and makes the executable smaller by 15-20%!
Release 0.6.1.0
- Made the functions
availableToolkits
andunavailableToolkits
public. - Minor documentation fixes.
- Executables are now built with GHC 8.8.3.
Release 0.6.0.0
New toolkits:
- Added support for the Plotly/R plotting library.
- Added support for Graphviz.
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 ...
- Added the ability to specify configuration file to the
pandoc-plot clean
andpandoc-plot toolkits
commands.
Release 0.5.0.0
- The
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 functionplotTransform
. - Added a benchmarking suite.
- Added
defaultConfiguration
so that people don't have to install thedata-default
package to get access to default configuration values. - Added a check for the
matplotlib
toolkit, preventing users from usingmatplotlib.pyplot.show
in figures. This would haltpandoc-plot
.
Release 0.4.0.1
- Fixed an issue where the
pandoc-plot
executable could not be built outside of its git repository.
Release 0.4.0.0
- Updated documentation.
- Added a
--full-version
flag to the executable, which includes which version of pandoc/pandoc-types was used, as well as the git revision. - Added the
clean
command to the executable. This can be used to clean-up output files produced by pandoc-plot. - Changed the flag
--write-example-config
to the commandwrite-example-config
. - Added the top-level function
cleanOutputDir
to clean output of pandoc-plot. This is only accessible ifpandoc-plot
is used as a library. - Added a distinction between failure to render a figure because of a mistake, and failing to render a figure because the toolkit is not installed.
pandoc-plot
will give better error messages in the latter case.
Release 0.3.0.0
- Added more examples.
- Added MacOS binaries built via Azure pipelines.
- BREAKING CHANGE: Parsing captions based on source file was not working. Captions format can be specified in the configuration file. This unfortunately changes the type signature of a few high-level functions.
Release 0.2.2.0
- Fixed an issue where paths with spaces would not work (issue #2).
- Added Linux binaries built via Azure pipelines.
Release 0.2.1.0
- Improved documentation.
Release 0.2.0.0
-
Added support for gnuplot.
-
Added more tests for all toolkits.
-
Fixed an issue where the package could not be installed because a source file was not included in the cabal file.
Release 0.1.0.0
- Initial release