Copyright	(c) Laurent P René de Cotret 2019 - present
License	GNU GPL, version 2 or above
Maintainer	laurent.decotret@outlook.com
Stability	unstable
Portability	portable
Safe Haskell	None
Language	Haskell2010

Text.Pandoc.Filter.Plot

Contents

Operating on whole Pandoc documents
Cleaning output directories
Runtime configuration
Determining available plotting toolkits
Version information
For embedding, testing and internal purposes ONLY. Might change without notice.

Description

This module defines a Pandoc filter plotFilter and related functions that can be used to walk over a Pandoc document and generate figures from code blocks, using a multitude of plotting toolkits.

The syntax for code blocks is simple. Code blocks with the appropriate class attribute will trigger the filter, e.g. matplotlib for matplotlib-based Python plots.

Here is an example, in Markdown, for a plot in MATLAB:

This is a paragraph.

```{.matlabplot}
figure()
plot([1,2,3,4,5], [1,2,3,4,5], '-k')
```

or a using GNUPlot:

```{.gnuplot format=png caption="Sinusoidal function" source=true}
sin(x)

set xlabel "x"
set ylabel "y"
```

The code block will be reworked into a script and the output figure will be captured. Optionally, the source code used to generate the figure will be linked in the caption.

Here are some of the possible attributes what pandoc-plot understands for ALL toolkits:

directory=... : Directory where to save the figure. This path should be specified with respect to the current working directory, and not with respect to the document.
source=true|false : Whether or not to link the source code of this figure in the caption. Ideal for web pages, for example. Default is false.
format=...: Format of the generated figure. This can be an extension or an acronym, e.g. format=PNG.
caption="...": Specify a plot caption (or alternate text). Format for captions is specified in the documentation for the Configuration type.
dpi=...: Specify a value for figure resolution, or dots-per-inch. Certain toolkits ignore this.
dependencies=[...]: Specify files/directories on which a figure depends, e.g. data file. Figures will be re-rendered if one of those file/directory changes. These paths should be specified with respect to the current working directory, and not with respect to the document.
preamble=...: Path to a file to include before the code block. Ideal to avoid repetition over many figures.
file=...: Path to a file from which to read the content of the figure. The content of the code block will be ignored. This path should be specified with respect to the current working directory, and not with respect to the document.

All attributes are described in the online documentation, linked on the home page.

Synopsis

plotFilter :: Configuration -> Maybe Format -> Pandoc -> IO Pandoc
plotTransform :: Configuration -> Pandoc -> IO Pandoc
cleanOutputDirs :: Walkable Block b => Configuration -> b -> IO [FilePath]
configuration :: FilePath -> IO Configuration
defaultConfiguration :: Configuration
data Configuration = Configuration {
- defaultDirectory :: !FilePath
- defaultWithSource :: !Bool
- defaultDPI :: !Int
- defaultSaveFormat :: !SaveFormat
- defaultDependencies :: ![FilePath]
- captionFormat :: !Format
- sourceCodeLabel :: !Text
- strictMode :: !Bool
- logVerbosity :: !Verbosity
- logSink :: !LogSink
- matplotlibPreamble :: !Script
- plotlyPythonPreamble :: !Script
- plotlyRPreamble :: !Script
- matlabPreamble :: !Script
- mathematicaPreamble :: !Script
- octavePreamble :: !Script
- ggplot2Preamble :: !Script
- gnuplotPreamble :: !Script
- graphvizPreamble :: !Script
- bokehPreamble :: !Script
- plotsjlPreamble :: !Script
- plantumlPreamble :: !Script
- sagemathPreamble :: !Script
- matplotlibExe :: !FilePath
- matlabExe :: !FilePath
- plotlyPythonExe :: !FilePath
- plotlyRExe :: !FilePath
- mathematicaExe :: !FilePath
- octaveExe :: !FilePath
- ggplot2Exe :: !FilePath
- gnuplotExe :: !FilePath
- graphvizExe :: !FilePath
- bokehExe :: !FilePath
- plotsjlExe :: !FilePath
- plantumlExe :: !FilePath
- sagemathExe :: !FilePath
- matplotlibCmdArgs :: !Text
- matlabCmdArgs :: !Text
- plotlyPythonCmdArgs :: !Text
- plotlyRCmdArgs :: !Text
- mathematicaCmdArgs :: !Text
- octaveCmdArgs :: !Text
- ggplot2CmdArgs :: !Text
- gnuplotCmdArgs :: !Text
- graphvizCmdArgs :: !Text
- bokehCmdArgs :: !Text
- plotsjlCmdArgs :: !Text
- plantumlCmdArgs :: !Text
- sagemathCmdArgs :: !Text
- matplotlibTightBBox :: !Bool
- matplotlibTransparent :: !Bool
}
data Verbosity
- = Debug
- | Info
- | Warning
- | Error
- | Silent
data LogSink
- = StdErr
- | LogFile FilePath
data SaveFormat
- = PNG
- | PDF
- | SVG
- | JPG
- | EPS
- | GIF
- | TIF
- | WEBP
- | HTML
- | LaTeX
type Script = Text
data Toolkit
- = Matplotlib
- | Matlab
- | PlotlyPython
- | PlotlyR
- | Mathematica
- | Octave
- | GGPlot2
- | GNUPlot
- | Graphviz
- | Bokeh
- | Plotsjl
- | PlantUML
- | SageMath
availableToolkits :: Configuration -> IO [Toolkit]
unavailableToolkits :: Configuration -> IO [Toolkit]
toolkits :: [Toolkit]
supportedSaveFormats :: Toolkit -> [SaveFormat]
pandocPlotVersion :: Version
make :: Block -> PlotM Block
makeEither :: Block -> PlotM (Either PandocPlotError Block)
data PandocPlotError

Operating on whole Pandoc documents

plotFilter Source #

Arguments

:: Configuration	Configuration for default values
-> Maybe Format	Final converted format, if known
-> Pandoc	Input document
-> IO Pandoc

Walk over an entire Pandoc document, transforming appropriate code blocks into figures. This function will operate on blocks in parallel if possible.

If the target conversion format is known, then this function can provide better defaults and error messages. For example, hyperlinks to source code will only be created if the final target format supports it (e.g. HTML).

Failing to render a figure does not stop the filter, so that you may run the filter on documents without having all necessary toolkits installed. In this case, error messages are printed to stderr, and blocks are left unchanged.

Since: 1.3.0

plotTransform Source #

Arguments

:: Configuration	Configuration for default values
-> Pandoc	Input document
-> IO Pandoc

Deprecated: plotTransform has been deprecated in favour of plotFilter, which is aware of conversion format.plotTransform will be removed in an upcoming major update.

Walk over an entire Pandoc document, transforming appropriate code blocks into figures. This function will operate on blocks in parallel if possible.

Failing to render a figure does not stop the filter, so that you may run the filter on documents without having all necessary toolkits installed. In this case, error messages are printed to stderr, and blocks are left unchanged.

__Note that this function is DEPRECATED in favour of plotFilter. It will be removed in the next major update (v2+).__

Cleaning output directories

cleanOutputDirs :: Walkable Block b => Configuration -> b -> IO [FilePath] Source #

Clean all output related to pandoc-plot. This includes output directories specified in the configuration and in the document/block, as well as log files. Note that *all* files in pandoc-plot output directories will be removed.

The cleaned directories are returned.

Runtime configuration

configuration :: FilePath -> IO Configuration Source #

Read configuration from a YAML file. The keys are exactly the same as for code blocks.

If a key is not present, its value will be set to the default value. Parsing errors result in thrown exceptions.

defaultConfiguration :: Configuration Source #

Default configuration values.

Since: 0.5.0.0

data Configuration Source #

The Configuration type holds the default values to use when running pandoc-plot. These values can be overridden in code blocks.

You can create an instance of the Configuration type from file using the configuration function.

You can store the path to a configuration file in metadata under the key plot-configuration. For example, in Markdown:

    ---
    title: My document
    author: John Doe
    plot-configuration: pathtofile.yml
    ---

The same can be specified via the command line using Pandoc's -M flag:

pandoc --filter pandoc-plot -M plot-configuration="path/to/file.yml" ...

In this case, use configurationPathMeta to extact the path from Pandoc documents.

Constructors

Configuration

Fields

defaultDirectory :: !FilePath
The default directory where figures will be saved.
defaultWithSource :: !Bool
The default behavior of whether or not to include links to source code and high-res
defaultDPI :: !Int
The default dots-per-inch value for generated figures. Renderers might ignore this.
defaultSaveFormat :: !SaveFormat
The default save format of generated figures.
defaultDependencies :: ![FilePath]
List of files/directories on which all figures depend.
captionFormat :: !Format
Caption format, in the same notation as Pandoc format, e.g. "markdown+tex_math_dollars"
sourceCodeLabel :: !Text
The text label to which the source code is linked. Change this if you are writing non-english documents.
strictMode :: !Bool
Whether to halt pandoc-plot when an error is encountered or not.
logVerbosity :: !Verbosity
Level of logging verbosity.
logSink :: !LogSink
Method of logging, i.e. printing to stderr or file.
matplotlibPreamble :: !Script
The default preamble script for the matplotlib toolkit.
plotlyPythonPreamble :: !Script
The default preamble script for the Plotly/Python toolkit.
plotlyRPreamble :: !Script
The default preamble script for the Plotly/R toolkit.
matlabPreamble :: !Script
The default preamble script for the MATLAB toolkit.
mathematicaPreamble :: !Script
The default preamble script for the Mathematica toolkit.
octavePreamble :: !Script
The default preamble script for the GNU Octave toolkit.
ggplot2Preamble :: !Script
The default preamble script for the GGPlot2 toolkit.
gnuplotPreamble :: !Script
The default preamble script for the gnuplot toolkit.
graphvizPreamble :: !Script
The default preamble script for the Graphviz toolkit.
bokehPreamble :: !Script
The default preamble script for the Python/Bokeh toolkit.
plotsjlPreamble :: !Script
The default preamble script for the Julia/Plots.jl toolkit.
plantumlPreamble :: !Script
The default preamble script for the PlantUML toolkit.
sagemathPreamble :: !Script
The default preamble script for the SageMath toolkit.
matplotlibExe :: !FilePath
The executable to use to generate figures using the matplotlib toolkit.
matlabExe :: !FilePath
The executable to use to generate figures using the MATLAB toolkit.
plotlyPythonExe :: !FilePath
The executable to use to generate figures using the Plotly/Python toolkit.
plotlyRExe :: !FilePath
The executable to use to generate figures using the Plotly/R toolkit.
mathematicaExe :: !FilePath
The executable to use to generate figures using the Mathematica toolkit.
octaveExe :: !FilePath
The executable to use to generate figures using the GNU Octave toolkit.
ggplot2Exe :: !FilePath
The executable to use to generate figures using the GGPlot2 toolkit.
gnuplotExe :: !FilePath
The executable to use to generate figures using the gnuplot toolkit.
graphvizExe :: !FilePath
The executable to use to generate figures using the Graphviz toolkit.
bokehExe :: !FilePath
The executable to use to generate figures using the Python/Bokeh toolkit.
plotsjlExe :: !FilePath
The executable to use to generate figures using the Julia/Plots.jl toolkit.
plantumlExe :: !FilePath
The executable to use to generate figures using the PlantUML toolkit.
sagemathExe :: !FilePath
The executable to use to generate figures using SageMath.
matplotlibCmdArgs :: !Text
Command-line arguments to pass to the Python interpreter for the Matplotlib toolkit
matlabCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the MATLAB toolkit.
plotlyPythonCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the Plotly/Python toolkit.
plotlyRCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the Plotly/R toolkit.
mathematicaCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the Mathematica toolkit.
octaveCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the GNU Octave toolkit.
ggplot2CmdArgs :: !Text
Command-line arguments to pass to the interpreter for the GGPlot2 toolkit.
gnuplotCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the gnuplot toolkit.
graphvizCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the Graphviz toolkit.
bokehCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the Python/Bokeh toolkit.
plotsjlCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the Julia/Plots.jl toolkit.
plantumlCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the plantUML toolkit.
sagemathCmdArgs :: !Text
Command-line arguments to pass to the interpreter for the SageMath toolkit.
matplotlibTightBBox :: !Bool
Whether or not to make Matplotlib figures tight by default.
matplotlibTransparent :: !Bool
Whether or not to make Matplotlib figures transparent by default.

Instances

Instances details

Eq Configuration Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad Methods (==) :: Configuration -> Configuration -> Bool # (/=) :: Configuration -> Configuration -> Bool #
Show Configuration Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad Methods showsPrec :: Int -> Configuration -> ShowS # show :: Configuration -> String # showList :: [Configuration] -> ShowS #

data Verbosity Source #

Verbosity of the logger.

Constructors

Debug	Log all messages, including debug messages.
Info	Log information, warning, and error messages.
Warning	Log warning and error messages.
Error	Only log errors.
Silent	Don't log anything.

Instances

Instances details

Bounded Verbosity Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Logging Methods minBound :: Verbosity # maxBound :: Verbosity #
Enum Verbosity Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Logging Methods succ :: Verbosity -> Verbosity # pred :: Verbosity -> Verbosity # toEnum :: Int -> Verbosity # fromEnum :: Verbosity -> Int # enumFrom :: Verbosity -> [Verbosity] # enumFromThen :: Verbosity -> Verbosity -> [Verbosity] # enumFromTo :: Verbosity -> Verbosity -> [Verbosity] # enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity] #
Eq Verbosity Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Logging Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Ord Verbosity Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Logging Methods compare :: Verbosity -> Verbosity -> Ordering # (<) :: Verbosity -> Verbosity -> Bool # (<=) :: Verbosity -> Verbosity -> Bool # (>) :: Verbosity -> Verbosity -> Bool # (>=) :: Verbosity -> Verbosity -> Bool # max :: Verbosity -> Verbosity -> Verbosity # min :: Verbosity -> Verbosity -> Verbosity #
Show Verbosity Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Logging Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #
IsString Verbosity Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Logging Methods fromString :: String -> Verbosity #
FromJSON Verbosity Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Logging Methods parseJSON :: Value -> Parser Verbosity # parseJSONList :: Value -> Parser [Verbosity] #

data LogSink Source #

Description of the possible ways to sink log messages.

Constructors

StdErr	Standard error stream.
LogFile FilePath	Appended to file.

Instances

Instances details

Eq LogSink Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Logging Methods (==) :: LogSink -> LogSink -> Bool # (/=) :: LogSink -> LogSink -> Bool #
Show LogSink Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Logging Methods showsPrec :: Int -> LogSink -> ShowS # show :: LogSink -> String # showList :: [LogSink] -> ShowS #

data SaveFormat Source #

Generated figure file format supported by pandoc-plot. Note that not all formats are supported by all toolkits.

Constructors

PNG	Portable network graphics
PDF	Portable document format
SVG	Scalable vector graphics
JPG	JPEG/JPG compressed image
EPS	Encapsulated postscript
GIF	GIF format
TIF	Tagged image format
WEBP	WebP image format
HTML	HTML for interactive plots.
LaTeX	LaTeX text and pdf graphics

Instances

Instances details

Bounded SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods minBound :: SaveFormat # maxBound :: SaveFormat #
Enum SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods succ :: SaveFormat -> SaveFormat # pred :: SaveFormat -> SaveFormat # toEnum :: Int -> SaveFormat # fromEnum :: SaveFormat -> Int # enumFrom :: SaveFormat -> [SaveFormat] # enumFromThen :: SaveFormat -> SaveFormat -> [SaveFormat] # enumFromTo :: SaveFormat -> SaveFormat -> [SaveFormat] # enumFromThenTo :: SaveFormat -> SaveFormat -> SaveFormat -> [SaveFormat] #
Eq SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods (==) :: SaveFormat -> SaveFormat -> Bool # (/=) :: SaveFormat -> SaveFormat -> Bool #
Ord SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods compare :: SaveFormat -> SaveFormat -> Ordering # (<) :: SaveFormat -> SaveFormat -> Bool # (<=) :: SaveFormat -> SaveFormat -> Bool # (>) :: SaveFormat -> SaveFormat -> Bool # (>=) :: SaveFormat -> SaveFormat -> Bool # max :: SaveFormat -> SaveFormat -> SaveFormat # min :: SaveFormat -> SaveFormat -> SaveFormat #
Show SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods showsPrec :: Int -> SaveFormat -> ShowS # show :: SaveFormat -> String # showList :: [SaveFormat] -> ShowS #
IsString SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods fromString :: String -> SaveFormat #
Generic SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Associated Types type Rep SaveFormat :: Type -> Type # Methods from :: SaveFormat -> Rep SaveFormat x # to :: Rep SaveFormat x -> SaveFormat #
ToJSON SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods toJSON :: SaveFormat -> Value # toEncoding :: SaveFormat -> Encoding # toJSONList :: [SaveFormat] -> Value # toEncodingList :: [SaveFormat] -> Encoding #
FromJSON SaveFormat Source #	Use the IsString instance to parse JSON so that the parsing is flexible with respect to uppercase/lowercase (#42)
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods parseJSON :: Value -> Parser SaveFormat # parseJSONList :: Value -> Parser [SaveFormat] #
type Rep SaveFormat Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types type Rep SaveFormat = D1 ('MetaData "SaveFormat" "Text.Pandoc.Filter.Plot.Monad.Types" "pandoc-plot-1.5.0-LmGPVep0DRd45vUB2d1s4P" 'False) (((C1 ('MetaCons "PNG" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PDF" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SVG" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "JPG" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EPS" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "GIF" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TIF" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "WEBP" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "HTML" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LaTeX" 'PrefixI 'False) (U1 :: Type -> Type)))))

type Script = Text Source #

Source context for plotting scripts

Determining available plotting toolkits

data Toolkit Source #

Enumeration of supported toolkits

Constructors

Matplotlib
Matlab
PlotlyPython
PlotlyR
Mathematica
Octave
GGPlot2
GNUPlot
Graphviz
Bokeh
Plotsjl
PlantUML
SageMath

Instances

Instances details

Bounded Toolkit Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods minBound :: Toolkit # maxBound :: Toolkit #
Enum Toolkit Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods succ :: Toolkit -> Toolkit # pred :: Toolkit -> Toolkit # toEnum :: Int -> Toolkit # fromEnum :: Toolkit -> Int # enumFrom :: Toolkit -> [Toolkit] # enumFromThen :: Toolkit -> Toolkit -> [Toolkit] # enumFromTo :: Toolkit -> Toolkit -> [Toolkit] # enumFromThenTo :: Toolkit -> Toolkit -> Toolkit -> [Toolkit] #
Eq Toolkit Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods (==) :: Toolkit -> Toolkit -> Bool # (/=) :: Toolkit -> Toolkit -> Bool #
Ord Toolkit Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods compare :: Toolkit -> Toolkit -> Ordering # (<) :: Toolkit -> Toolkit -> Bool # (<=) :: Toolkit -> Toolkit -> Bool # (>) :: Toolkit -> Toolkit -> Bool # (>=) :: Toolkit -> Toolkit -> Bool # max :: Toolkit -> Toolkit -> Toolkit # min :: Toolkit -> Toolkit -> Toolkit #
Show Toolkit Source #	This instance should only be used to display toolkit names
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Methods showsPrec :: Int -> Toolkit -> ShowS # show :: Toolkit -> String # showList :: [Toolkit] -> ShowS #
Generic Toolkit Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types Associated Types type Rep Toolkit :: Type -> Type # Methods from :: Toolkit -> Rep Toolkit x # to :: Rep Toolkit x -> Toolkit #
type Rep Toolkit Source #
Instance details Defined in Text.Pandoc.Filter.Plot.Monad.Types type Rep Toolkit = D1 ('MetaData "Toolkit" "Text.Pandoc.Filter.Plot.Monad.Types" "pandoc-plot-1.5.0-LmGPVep0DRd45vUB2d1s4P" 'False) (((C1 ('MetaCons "Matplotlib" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Matlab" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PlotlyPython" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "PlotlyR" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Mathematica" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Octave" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "GGPlot2" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "GNUPlot" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Graphviz" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Bokeh" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Plotsjl" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PlantUML" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SageMath" 'PrefixI 'False) (U1 :: Type -> Type)))))

availableToolkits :: Configuration -> IO [Toolkit] Source #

List of toolkits available on this machine. The executables to look for are taken from the configuration.

unavailableToolkits :: Configuration -> IO [Toolkit] Source #

List of toolkits not available on this machine. The executables to look for are taken from the configur

toolkits :: [Toolkit] Source #

List of supported toolkits.

supportedSaveFormats :: Toolkit -> [SaveFormat] Source #

Save formats supported by this renderer.

Version information

pandocPlotVersion :: Version Source #

The version of the pandoc-plot package.

Since: 0.8.0.0

For embedding, testing and internal purposes ONLY. Might change without notice.

make :: Block -> PlotM Block Source #

Try to process the block with `pandoc-plot`. If a failure happens (or the block) was not meant to become a figure, return the block as-is unless running in strict mode. In strict mode, any failure (for example, due to a missing plotting toolkit) will halt execution.

New in version 1.2.0: this function will detect nested code blocks, for example in Div blocks.

makeEither :: Block -> PlotM (Either PandocPlotError Block) Source #

Try to process the block with `pandoc-plot`, documenting the error. This function does not transform code blocks nested in other blocks (e.g. Divs)

data PandocPlotError Source #

Constructors

ScriptRuntimeError Text Int
ScriptChecksFailedError Text
ToolkitNotInstalledError Toolkit
IncompatibleSaveFormatError SaveFormat Toolkit

Instances

Instances details

Show PandocPlotError Source #
Instance details Defined in Text.Pandoc.Filter.Plot Methods showsPrec :: Int -> PandocPlotError -> ShowS # show :: PandocPlotError -> String # showList :: [PandocPlotError] -> ShowS #