Image.LaTeX.Render.Pandoc

Data URIs

convertFormulaDataURI

Arguments

:: EnvironmentOptions

System environment settings

-> PandocFormulaOptions

Formula display settings

-> Inline

-> IO Inline

Convert a formula in a pandoc document to an image, embedding the image into the HTML using Data URIs.

convertAllFormulaeDataURI

Arguments

:: EnvironmentOptions

System environment settings

-> PandocFormulaOptions

Formula display settings

-> Pandoc

-> IO Pandoc

Convert all formulae in a pandoc document to images, embedding the images into the HTML using Data URIs.

Separate Files

convertFormulaFiles

Arguments

:: EnvironmentOptions

System environment settings

-> NameSupply

Unique file name supply. Reuse this for every invocation that shares the same image directory.

-> FilePath

Name of image directory where images will be stored

-> PandocFormulaOptions

Formula display settings

-> Inline

-> IO Inline

Convert a formula in a pandoc document to an image, storing the images in a separate directory.

convertAllFormulaeFiles

Arguments

:: EnvironmentOptions

System environment settings

-> NameSupply

Unique file name supply. Reuse this for every invocation that shares the same image directory.

-> FilePath

Name of image directory where images will be stored

-> PandocFormulaOptions

Formula display settings

-> Pandoc

-> IO Pandoc

Convert every formula in a pandoc document to an image, storing the images in a separate directory.

Name Supplies

type NameSupply = IORef Int

If we use files for the images, we need some way of naming the image files we produce A NameSupply provides us with a source of unique names via an ever-increasing integer. It's important that any invocation of convertFormulaFiles or convertAllFormulaeFiles that shares the same image storage directory will also use the same name supply, or they will overwrite each others images.

newNameSupply :: IO NameSupply

Create a new name supply.

Options

data PandocFormulaOptions

All options pertaining to the actual display of formulae.

Constructors

PandocFormulaOptions

Fields

• shrinkBy :: ShrinkSize

  Denominator for all dimensions. Useful for displaying high DPI images in small sizes, for retina displays. Otherwise set to 1.

• errorDisplay :: RenderError -> Inline

  How to display various errors (such as LaTeX errors). Usually this can just be displayError but you may wish hideError to avoid putting potentially secure information into the output page.

• formulaOptions :: MathType -> FormulaOptions

  LaTeX environment settings, including the preamble, for each equation type (display and inline)

type ShrinkSize = Int

Denominator for various dimensions. For high DPI displays, it can be useful to use values of 2 or 4, so that the dimensions of the image are a fraction of the actual image size, and the image appears more crisp. Otherwise, a value of 1 will always produce sensible, if somewhat pixelated results.

defaultPandocFormulaOptions :: PandocFormulaOptions

A set of sensible defaults for formula options.

Error display functions

hideError :: RenderError -> Inline

Render all errors simply as Error

displayError :: RenderError -> Inline

Render errors nicely, in order to show any problems clearly, with all information intact.

Generalised versions

Data URIs

convertFormulaDataURIWith

Arguments

:: (FormulaOptions -> Formula -> IO (Either RenderError (Baseline, DynamicImage)))

Function that renders a formula, such as imageForFormula defaultEnv

-> PandocFormulaOptions

Formula display settings

-> Inline

-> IO Inline

A generalisation of convertFormulaDataURI which allows the actual image rendering function to be customised, so that (e.g) caching can be added or other image processing.

convertAllFormulaeDataURIWith

Arguments

:: (FormulaOptions -> Formula -> IO (Either RenderError (Baseline, DynamicImage)))

Function that renders a formula, such as imageForFormula defaultEnv

-> PandocFormulaOptions

Formula display settings

-> Pandoc

-> IO Pandoc

A generalisation of convertAllFormulaeDataURI which allows the actual image rendering function to be customised, so that (e.g) caching can be added or other image processing.

Files

convertFormulaFilesWith

Arguments

:: (FormulaOptions -> Formula -> IO (Either RenderError (Baseline, DynamicImage)))

Function that renders a formula, such as imageForFormula defaultEnv

-> NameSupply

Unique file name supply. Reuse this for every invocation that shares the same image directory.

-> FilePath

Name of image directory where images will be stored

-> PandocFormulaOptions

Formula display settings

-> Inline

-> IO Inline

A generalisation of convertFormulaFiles which allows the actual image rendering function to be customised, so that (e.g) caching can be added or other image processing.

convertAllFormulaeFilesWith

Arguments

:: (FormulaOptions -> Formula -> IO (Either RenderError (Baseline, DynamicImage)))

Function that renders a formula, such as imageForFormula defaultEnv

-> NameSupply

Unique file name supply. Reuse this for every invocation that shares the same image directory.

-> FilePath

Name of image directory where images will be stored

-> PandocFormulaOptions

Formula display settings

-> Pandoc

-> IO Pandoc

A generalisation of convertAllFormulaeFiles which allows the actual image rendering function to be customised, so that (e.g) caching can be added or other image processing.