Text.Pandoc.Filter.Plot.Internal

This module re-exports internal pandoc-plot functionality. The external use of content from this module is discouraged.

Documentation

renderer :: Toolkit -> PlotM Renderer

Get the renderer associated with a toolkit. If the renderer has not been used before, initialize it and store where it is. It will be re-used.

preambleSelector :: Toolkit -> Configuration -> Script

The function that maps from configuration to the preamble.

parseExtraAttrs :: Toolkit -> Map Text Text -> Map Text Text

Parse code block headers for extra attributes that are specific to this renderer. By default, no extra attributes are parsed.

executable :: Toolkit -> PlotM Executable

Find an executable.

availableToolkits :: Configuration -> IO [Toolkit]

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

availableToolkitsM :: PlotM [Toolkit]

Monadic version of availableToolkits.

Note that logging is disabled

unavailableToolkits :: Configuration -> IO [Toolkit]

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

unavailableToolkitsM :: PlotM [Toolkit]

Monadic version of unavailableToolkits

supportedSaveFormats :: Toolkit -> [SaveFormat]

Save formats supported by this renderer.

data OutputSpec

Internal description of all information needed to output a figure.

Constructors

OutputSpec

Fields

• oFigureSpec :: FigureSpec

  Figure spec

• oScriptPath :: FilePath

  Path to the script to render

• oFigurePath :: FilePath

  Figure output path

• oExecutable :: Executable

  Executable to use during rendering

• oCWD :: FilePath

  Current working directory

data Executable

Executable program, and sometimes the directory where it can be found.

Constructors

AbsExe FilePath Text

RelExe Text

data Renderer

Constructors

Renderer

Fields

• rendererToolkit :: Toolkit
• rendererCapture :: FigureSpec -> FilePath -> Script
• rendererCommand :: OutputSpec -> Text
• rendererAvailability :: AvailabilityCheck
• rendererSupportedSaveFormats :: [SaveFormat]
• rendererChecks :: [Script -> CheckResult]
• rendererLanguage :: Text
• rendererComment :: Text -> Text
• rendererScriptExtension :: String

data ScriptResult

Possible result of running a script

Constructors

ScriptSuccess

ScriptChecksFailed Text

ScriptFailure Text Int Script

Instances

Show ScriptResult

Defined in Text.Pandoc.Filter.Plot.Scripting

Methods

showsPrec :: Int -> ScriptResult -> ShowS

show :: ScriptResult -> String

showList :: [ScriptResult] -> ShowS

runTempScript :: FigureSpec -> PlotM ScriptResult

runScriptIfNecessary :: FigureSpec -> PlotM ScriptResult

figurePath :: FigureSpec -> PlotM FilePath

Determine the path a figure should have. The path for this file is unique to the content of the figure, so that figurePath can be used to determine whether a figure should be rendered again or not.

sourceCodePath :: FigureSpec -> PlotM FilePath

Determine the path to the source code that generated the figure. To ensure that the source code path is distinguished from HTML figures, we use the extension .src.html.

plotToolkit :: Block -> Maybe Toolkit

Determine which toolkit should be used to render the plot from a code block, if any.

parseFigureSpec :: Block -> PlotM ParseFigureResult

Determine inclusion specifications from Block attributes. If an environment is detected, but the save format is incompatible, an error will be thrown.

data ParseFigureResult

Constructors

NotAFigure

The block is not meant to become a figure

PFigure FigureSpec

The block is meant to become a figure

MissingToolkit Toolkit

The block is meant to become a figure, but the plotting toolkit is missing

UnsupportedSaveFormat Toolkit SaveFormat

The block is meant to become a figure, but the figure format is incompatible with the plotting toolkit

captionReader :: Format -> Text -> Maybe [Inline]

Reader a caption, based on input document format

configuration :: FilePath -> IO Configuration

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.

configurationPathMeta :: Pandoc -> Maybe FilePath

Extact path to configuration from the metadata in a Pandoc document. The path to the configuration file should be under the plot-configuration key. In case there is no such metadata, return the default configuration.

For example, at the top of a markdown file:

---
title: My document
author: John Doe
plot-configuration: pathto/file.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" ...

Since: 0.6.0.0

defaultConfiguration :: Configuration

Default configuration values.

Since: 0.5.0.0

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

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.

outputDirs :: Walkable Block b => b -> PlotM [FilePath]

Analyze a document to determine where would the pandoc-plot output directories be.

readDoc :: FilePath -> IO Pandoc

Read a document, guessing what extensions and reader options are appropriate. If the file cannot be read for any reason, an error is thrown.

data Configuration

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

Show Configuration

Defined in Text.Pandoc.Filter.Plot.Monad

Methods

showsPrec :: Int -> Configuration -> ShowS

show :: Configuration -> String

showList :: [Configuration] -> ShowS

Eq Configuration

Defined in Text.Pandoc.Filter.Plot.Monad

Methods

(==) :: Configuration -> Configuration -> Bool

(/=) :: Configuration -> Configuration -> Bool

type PlotM = StateT PlotState (ReaderT RuntimeEnv IO)

pandoc-plot monad

data RuntimeEnv

Constructors

RuntimeEnv

Fields

• envFormat :: Maybe Format
• envConfig :: Configuration
• envLogger :: Logger
• envCWD :: FilePath
• envIOLock :: MVar ()

data PlotState

Constructors

PlotState (MVar (Map FilePath FileHash))

runPlotM :: Maybe Format -> Configuration -> PlotM a -> IO a

Evaluate a PlotM action.

Concurrent execution

mapConcurrentlyN :: Traversable t => Int -> (a -> PlotM b) -> t a -> PlotM (t b)

maps a function, performing at most N actions concurrently.

Running external commands

runCommand :: FilePath -> Text -> PlotM (ExitCode, Text)

Run a command within the PlotM monad. Stderr stream is read and decoded, while Stdout is ignored. Logging happens at the debug level if the command succeeds, or at the error level if it does not succeed.

withPrependedPath :: FilePath -> PlotM a -> PlotM a

Prepend a directory to the PATH environment variable for the duration of a computation.

This function is exception-safe; even if an exception happens during the computation, the PATH environment variable will be reverted back to its initial value.

Halting pandoc-plot

throwStrictError :: Text -> PlotM ()

Throw an error that halts the execution of pandoc-plot due to a strict-mode.

Getting file hashes

fileHash :: FilePath -> PlotM FileHash

Get a filehash. If the file hash has been computed before, it is reused. Otherwise, the filehash is calculated and stored.

Getting executables

executable :: Toolkit -> PlotM Executable

Find an executable.

Logging

data Verbosity

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

FromJSON Verbosity

Defined in Text.Pandoc.Filter.Plot.Monad.Logging

Methods

parseJSON :: Value -> Parser Verbosity

parseJSONList :: Value -> Parser [Verbosity]

IsString Verbosity

Defined in Text.Pandoc.Filter.Plot.Monad.Logging

Methods

fromString :: String -> Verbosity

Bounded Verbosity

Defined in Text.Pandoc.Filter.Plot.Monad.Logging

Methods

minBound :: Verbosity

maxBound :: Verbosity

Enum Verbosity

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]

Show Verbosity

Defined in Text.Pandoc.Filter.Plot.Monad.Logging

Methods

showsPrec :: Int -> Verbosity -> ShowS

show :: Verbosity -> String

showList :: [Verbosity] -> ShowS

Eq Verbosity

Defined in Text.Pandoc.Filter.Plot.Monad.Logging

Methods

(==) :: Verbosity -> Verbosity -> Bool

(/=) :: Verbosity -> Verbosity -> Bool

Ord Verbosity

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

data LogSink

Description of the possible ways to sink log messages.

Constructors

StdErr

Standard error stream.

LogFile FilePath

Appended to file.

Instances

Show LogSink

Defined in Text.Pandoc.Filter.Plot.Monad.Logging

Methods

showsPrec :: Int -> LogSink -> ShowS

show :: LogSink -> String

showList :: [LogSink] -> ShowS

Eq LogSink

Defined in Text.Pandoc.Filter.Plot.Monad.Logging

Methods

(==) :: LogSink -> LogSink -> Bool

(/=) :: LogSink -> LogSink -> Bool

debug :: (MonadLogger m, MonadIO m) => Text -> m ()

err :: (MonadLogger m, MonadIO m) => Text -> m ()

warning :: (MonadLogger m, MonadIO m) => Text -> m ()

info :: (MonadLogger m, MonadIO m) => Text -> m ()

Lifting and other monadic operations

liftIO :: MonadIO m => IO a -> m a

Lift a computation from the IO monad. This allows us to run IO computations in any monadic stack, so long as it supports these kinds of operations (i.e. IO is the base monad for the stack).

Example

import Control.Monad.Trans.State -- from the "transformers" library

printState :: Show s => StateT s IO ()
printState = do
  state <- get
  liftIO $ print state

Had we omitted liftIO, we would have ended up with this error:

• Couldn't match type ‘IO’ with ‘StateT s IO’
 Expected type: StateT s IO ()
   Actual type: IO ()

The important part here is the mismatch between StateT s IO () and IO ().

Luckily, we know of a function that takes an IO a and returns an (m a): liftIO, enabling us to run the program and see the expected results:

> evalStateT printState "hello"
"hello"

> evalStateT printState 3
3

ask :: MonadReader r m => m r

Retrieves the monad environment.

asks

Arguments

:: MonadReader r m

=> (r -> a)

The selector function to apply to the environment.

-> m a

Retrieves a function of the current environment.

asksConfig :: (Configuration -> a) -> PlotM a

Get access to configuration within the PlotM monad.

Base types

data Toolkit

Enumeration of supported toolkits

Constructors

Matplotlib

Matlab

PlotlyPython

PlotlyR

Mathematica

Octave

GGPlot2

GNUPlot

Graphviz

Bokeh

Plotsjl

PlantUML

SageMath

Instances

Bounded Toolkit

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

minBound :: Toolkit

maxBound :: Toolkit

Enum Toolkit

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]

Generic Toolkit

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

Show Toolkit

This instance should only be used to display toolkit names

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

showsPrec :: Int -> Toolkit -> ShowS

show :: Toolkit -> String

showList :: [Toolkit] -> ShowS

Eq Toolkit

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

(==) :: Toolkit -> Toolkit -> Bool

(/=) :: Toolkit -> Toolkit -> Bool

Ord Toolkit

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

type Rep Toolkit

Defined in Text.Pandoc.Filter.Plot.Monad.Types

type Rep Toolkit = D1 ('MetaData "Toolkit" "Text.Pandoc.Filter.Plot.Monad.Types" "pandoc-plot-1.6.1-9PndRExHezK9iuO1yvDL3A" '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)))))

data Renderer

Constructors

Renderer

Fields

• rendererToolkit :: Toolkit
• rendererCapture :: FigureSpec -> FilePath -> Script
• rendererCommand :: OutputSpec -> Text
• rendererAvailability :: AvailabilityCheck
• rendererSupportedSaveFormats :: [SaveFormat]
• rendererChecks :: [Script -> CheckResult]
• rendererLanguage :: Text
• rendererComment :: Text -> Text
• rendererScriptExtension :: String

data AvailabilityCheck

Constructors

CommandSuccess (Executable -> Text)

ExecutableExists

type Script = Text

Source context for plotting scripts

data CheckResult

Result of checking scripts for problems

Constructors

CheckPassed

CheckFailed Text

Instances

Monoid CheckResult

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

mempty :: CheckResult

mappend :: CheckResult -> CheckResult -> CheckResult

mconcat :: [CheckResult] -> CheckResult

Semigroup CheckResult

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

(<>) :: CheckResult -> CheckResult -> CheckResult

sconcat :: NonEmpty CheckResult -> CheckResult

stimes :: Integral b => b -> CheckResult -> CheckResult

Eq CheckResult

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

(==) :: CheckResult -> CheckResult -> Bool

(/=) :: CheckResult -> CheckResult -> Bool

data InclusionKey

Description of any possible inclusion key, both in documents and in configuration files.

Constructors

DirectoryK

CaptionK

SaveFormatK

WithSourceK

CaptionFormatK

PreambleK

DpiK

SourceCodeLabelK

StrictModeK

ExecutableK

CommandLineArgsK

DependenciesK

FileK

MatplotlibTightBBoxK

MatplotlibTransparentK

Instances

Bounded InclusionKey

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

minBound :: InclusionKey

maxBound :: InclusionKey

Enum InclusionKey

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

succ :: InclusionKey -> InclusionKey

pred :: InclusionKey -> InclusionKey

toEnum :: Int -> InclusionKey

fromEnum :: InclusionKey -> Int

enumFrom :: InclusionKey -> [InclusionKey]

enumFromThen :: InclusionKey -> InclusionKey -> [InclusionKey]

enumFromTo :: InclusionKey -> InclusionKey -> [InclusionKey]

enumFromThenTo :: InclusionKey -> InclusionKey -> InclusionKey -> [InclusionKey]

Show InclusionKey

Keys that pandoc-plot will look for in code blocks. These are only exported for testing purposes.

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

showsPrec :: Int -> InclusionKey -> ShowS

show :: InclusionKey -> String

showList :: [InclusionKey] -> ShowS

Eq InclusionKey

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

(==) :: InclusionKey -> InclusionKey -> Bool

(/=) :: InclusionKey -> InclusionKey -> Bool

data FigureSpec

Datatype containing all parameters required to specify a figure.

It is assumed that once a FigureSpec has been created, no configuration can overload it; hence, a FigureSpec completely encodes a particular figure.

Constructors

FigureSpec

Fields

• renderer_ :: !Renderer

  Renderer to use for this figure.

• fsExecutable :: Executable

  Executable to use in rendering this figure.

• caption :: !Text

  Figure caption.

• withSource :: !Bool

  Append link to source code in caption.

• script :: !Script

  Source code for the figure.

• saveFormat :: !SaveFormat

  Save format of the figure.

• directory :: !FilePath

  Directory where to save the file.

• dpi :: !Int

  Dots-per-inch of figure.

• dependencies :: ![FilePath]

  Files/directories on which this figure depends, e.g. data files.

• extraAttrs :: ![(Text, Text)]

  Renderer-specific extra attributes.

• blockAttrs :: !Attr

  Attributes not related to pandoc-plot will be propagated.

data OutputSpec

Internal description of all information needed to output a figure.

Constructors

OutputSpec

Fields

• oFigureSpec :: FigureSpec

  Figure spec

• oScriptPath :: FilePath

  Path to the script to render

• oFigurePath :: FilePath

  Figure output path

• oExecutable :: Executable

  Executable to use during rendering

• oCWD :: FilePath

  Current working directory

data SaveFormat

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

FromJSON SaveFormat

Use the IsString instance to parse JSON so that the parsing is flexible with respect to uppercase/lowercase (#42)

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

parseJSON :: Value -> Parser SaveFormat

parseJSONList :: Value -> Parser [SaveFormat]

ToJSON SaveFormat

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

toJSON :: SaveFormat -> Value

toEncoding :: SaveFormat -> Encoding

toJSONList :: [SaveFormat] -> Value

toEncodingList :: [SaveFormat] -> Encoding

IsString SaveFormat

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

fromString :: String -> SaveFormat

Bounded SaveFormat

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

minBound :: SaveFormat

maxBound :: SaveFormat

Enum SaveFormat

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]

Generic SaveFormat

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

Show SaveFormat

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

showsPrec :: Int -> SaveFormat -> ShowS

show :: SaveFormat -> String

showList :: [SaveFormat] -> ShowS

Eq SaveFormat

Defined in Text.Pandoc.Filter.Plot.Monad.Types

Methods

(==) :: SaveFormat -> SaveFormat -> Bool

(/=) :: SaveFormat -> SaveFormat -> Bool

Ord SaveFormat

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

type Rep SaveFormat

Defined in Text.Pandoc.Filter.Plot.Monad.Types

type Rep SaveFormat = D1 ('MetaData "SaveFormat" "Text.Pandoc.Filter.Plot.Monad.Types" "pandoc-plot-1.6.1-9PndRExHezK9iuO1yvDL3A" '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)))))

cls :: Toolkit -> Text

Class name which will trigger the filter

extension :: SaveFormat -> String

Save format file extension

toolkits :: [Toolkit]

List of supported toolkits.

inclusionKeys :: [InclusionKey]

List of all keys related to pandoc-plot that can be specified in source material.

data Executable

Executable program, and sometimes the directory where it can be found.

Constructors

AbsExe FilePath Text

RelExe Text

exeFromPath :: FilePath -> Executable

pathToExe :: Executable -> FilePath

isWindows :: Bool

extractPlot :: Text -> Text

Extract the plot-relevant content from inside of a full HTML document. Scripts contained in the head tag are extracted, as well as the entirety of the body tag.

toFigure

Arguments

:: Format

text format of the caption

-> FigureSpec

-> PlotM Block

Convert a FigureSpec to a Pandoc figure component. Note that the script to generate figure files must still be run in another function.