Image.LaTeX.Render

Rendering Formulas

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

Convert a formula into a JuicyPixels DynamicImage, also detecting where the typesetting baseline of the image is.

type Formula = String

A LaTeX formula, e.g x=frac{-bpmsqrt{b^2-4ac}}{2a} for the quadratic formula. Do not include any $s to denote the environment, just specify the environment in the FormulaOptions instead.

type Baseline = Int

Number of pixels from the bottom of the image to the typesetting baseline. Useful for setting your formulae inline with text.

Errors

data RenderError

This type contains all possible errors than can happen while rendering an equation. It includes all IO errors that can happen as well as more specific errors.

Constructors

ImageIsEmpty

The equation produced an empty image

CannotDetectBaseline

The baseline marker could not be found

LaTeXFailure String

latex returned a nonzero error code

DVIPSFailure String

dvips returned a nonzero error code

IMConvertFailure String

convert returned a nonzero error code

IOException IOException

An IOException occurred while managing the temporary files used to convert the equation

ImageReadError String

The PNG image from ImageMagick could not be read by JuicyPixels.

Instances

Eq RenderError

Methods

(==) :: RenderError -> RenderError -> Bool

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

Show RenderError

Methods

showsPrec :: Int -> RenderError -> ShowS

show :: RenderError -> String

showList :: [RenderError] -> ShowS

Options

Environment Options

data EnvironmentOptions

Constructors

EnvironmentOptions

Fields

• latexCommand :: String

  Command to use for latex, default is latex

• dvipsCommand :: String

  Command to use for dvips, default is dvips

• imageMagickCommand :: String

  Command to use for ImageMagick's convert, default is convert

• latexArgs :: [String]

  Any additional arguments for latex

• dvipsArgs :: [String]

  Any additional arguments for dvips

• imageMagickArgs :: [String]

  Any additional arguments for convert

• tempDir :: TempDirectoryHandling

  How to handle temporary files

• tempFileBaseName :: String

  The base name to use for the temporary files.

Instances

Eq EnvironmentOptions

Methods

(==) :: EnvironmentOptions -> EnvironmentOptions -> Bool

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

Ord EnvironmentOptions

Methods

compare :: EnvironmentOptions -> EnvironmentOptions -> Ordering

(<) :: EnvironmentOptions -> EnvironmentOptions -> Bool

(<=) :: EnvironmentOptions -> EnvironmentOptions -> Bool

(>) :: EnvironmentOptions -> EnvironmentOptions -> Bool

(>=) :: EnvironmentOptions -> EnvironmentOptions -> Bool

max :: EnvironmentOptions -> EnvironmentOptions -> EnvironmentOptions

min :: EnvironmentOptions -> EnvironmentOptions -> EnvironmentOptions

Read EnvironmentOptions

Methods

readsPrec :: Int -> ReadS EnvironmentOptions

readList :: ReadS [EnvironmentOptions]

readPrec :: ReadPrec EnvironmentOptions

readListPrec :: ReadPrec [EnvironmentOptions]

Show EnvironmentOptions

Methods

showsPrec :: Int -> EnvironmentOptions -> ShowS

show :: EnvironmentOptions -> String

showList :: [EnvironmentOptions] -> ShowS

defaultEnv :: EnvironmentOptions

Sensible defaults for system environments. Works if dvips, convert, and latex are recent enough and in your $PATH.

data TempDirectoryHandling

Constructors

UseSystemTempDir

A temporary directory with a name based on the given template will be created in the system temporary files location

Fields

• nameTemplate :: String

UseCurrentDir

A temporary directory with a name based on the given template will be created in the current directory

Fields

• nameTemplate :: String

Instances

Eq TempDirectoryHandling

Methods

(==) :: TempDirectoryHandling -> TempDirectoryHandling -> Bool

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

Ord TempDirectoryHandling

Methods

compare :: TempDirectoryHandling -> TempDirectoryHandling -> Ordering

(<) :: TempDirectoryHandling -> TempDirectoryHandling -> Bool

(<=) :: TempDirectoryHandling -> TempDirectoryHandling -> Bool

(>) :: TempDirectoryHandling -> TempDirectoryHandling -> Bool

(>=) :: TempDirectoryHandling -> TempDirectoryHandling -> Bool

max :: TempDirectoryHandling -> TempDirectoryHandling -> TempDirectoryHandling

min :: TempDirectoryHandling -> TempDirectoryHandling -> TempDirectoryHandling

Read TempDirectoryHandling

Methods

readsPrec :: Int -> ReadS TempDirectoryHandling

readList :: ReadS [TempDirectoryHandling]

readPrec :: ReadPrec TempDirectoryHandling

readListPrec :: ReadPrec [TempDirectoryHandling]

Show TempDirectoryHandling

Methods

showsPrec :: Int -> TempDirectoryHandling -> ShowS

show :: TempDirectoryHandling -> String

showList :: [TempDirectoryHandling] -> ShowS

Formula Options

data FormulaOptions

Constructors

FormulaOptions

Fields

• preamble :: String

  LaTeX preamble to use. Put your usepackage commands here.@ commands here.

• environment :: String

  LaTeX environment in which the equation will be typeset, usually math or displaymath

• dpi :: Int

  DPI for the image to be rendered at. ~200 is good for retina displays, ~100 works OK for non-retina displays.

Instances

Eq FormulaOptions

Methods

(==) :: FormulaOptions -> FormulaOptions -> Bool

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

Ord FormulaOptions

Methods

compare :: FormulaOptions -> FormulaOptions -> Ordering

(<) :: FormulaOptions -> FormulaOptions -> Bool

(<=) :: FormulaOptions -> FormulaOptions -> Bool

(>) :: FormulaOptions -> FormulaOptions -> Bool

(>=) :: FormulaOptions -> FormulaOptions -> Bool

max :: FormulaOptions -> FormulaOptions -> FormulaOptions

min :: FormulaOptions -> FormulaOptions -> FormulaOptions

Read FormulaOptions

Methods

readsPrec :: Int -> ReadS FormulaOptions

readList :: ReadS [FormulaOptions]

readPrec :: ReadPrec FormulaOptions

readListPrec :: ReadPrec [FormulaOptions]

Show FormulaOptions

Methods

showsPrec :: Int -> FormulaOptions -> ShowS

show :: FormulaOptions -> String

showList :: [FormulaOptions] -> ShowS

displaymath :: FormulaOptions

Use the amsmath package, the displaymath environment, and 200dpi.

math :: FormulaOptions

Use the amsmath package, the math environment, and 200dpi.