Safe Haskell	Safe
Language	Haskell2010

Image.LaTeX.Render

Contents

Rendering Formulas
BaseLine
Errors
Options
- Environment Options
- Formula Options

Synopsis

imageForFormula :: EnvironmentOptions -> FormulaOptions -> Formula -> IO (Either RenderError SVG)
type Formula = String
type SVG = String
type BaseLine = Double
getBaseline :: SVG -> Double
alterForHTML :: SVG -> SVG
data RenderError
- = LaTeXFailure String
- | DVISVGMFailure String
- | IOException IOException
data EnvironmentOptions = EnvironmentOptions {
- latexCommand :: String
- dvisvgmCommand :: String
- latexArgs :: [String]
- dvisvgmArgs :: [String]
- latexFontSize :: Int
- tempDir :: TempDirectoryHandling
- tempFileBaseName :: String
- globalCache :: Bool
}
defaultEnv :: EnvironmentOptions
data TempDirectoryHandling
- = UseSystemTempDir String
- | UseCurrentDir String
data FormulaOptions = FormulaOptions {
- preamble :: String
- environment :: Maybe String
}
displaymath :: FormulaOptions
math :: FormulaOptions
defaultFormulaOptions :: FormulaOptions

Rendering Formulas

imageForFormula :: EnvironmentOptions -> FormulaOptions -> Formula -> IO (Either RenderError SVG) Source #

Convert a formula into a SVG image.

type Formula = String Source #

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 SVG = String Source #

A source of SVG image.

BaseLine

type BaseLine = Double Source #

Number of points (pt) from the bottom of the image to the typesetting baseline. Useful for setting your formulae inline with text

getBaseline :: SVG -> Double Source #

alterForHTML :: SVG -> SVG Source #

Alter SVG image to be embeddable in HTML page, i.e.align baseline.

Add style="vertical-align: baseline-correction"
Remove id="page1"

Errors

data RenderError Source #

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

LaTeXFailure String	`latex` returned a nonzero error code
DVISVGMFailure String	`dvisvgm` returned a nonzero error code
IOException IOException	An `IOException` occurred while managing the temporary files used to convert the equation

Instances

Eq RenderError Source #
Instance details Defined in Image.LaTeX.Render Methods (==) :: RenderError -> RenderError -> Bool # (/=) :: RenderError -> RenderError -> Bool #
Show RenderError Source #
Instance details Defined in Image.LaTeX.Render Methods showsPrec :: Int -> RenderError -> ShowS # show :: RenderError -> String # showList :: [RenderError] -> ShowS #

Options

Environment Options

data EnvironmentOptions Source #

Constructors

EnvironmentOptions

Fields

latexCommand :: String
Command to use for latex, default is latex
dvisvgmCommand :: String
Command to use for dvisvgm, default is dvisvgm
latexArgs :: [String]
Any additional arguments for latex
dvisvgmArgs :: [String]
Any additional arguments for dvisvgm
latexFontSize :: Int
Document font size, one of 8,9,10,11,12,14,17,20. If not 10,11,12 then extarticle document size is used.
tempDir :: TempDirectoryHandling
How to handle temporary files
tempFileBaseName :: String
The base name to use for the temporary files.
globalCache :: Bool
Cache outputs globally in XDG_CACHE/latex-svg

Instances

Eq EnvironmentOptions Source #
Instance details Defined in Image.LaTeX.Render Methods (==) :: EnvironmentOptions -> EnvironmentOptions -> Bool # (/=) :: EnvironmentOptions -> EnvironmentOptions -> Bool #
Ord EnvironmentOptions Source #
Instance details Defined in Image.LaTeX.Render 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 Source #
Instance details Defined in Image.LaTeX.Render Methods readsPrec :: Int -> ReadS EnvironmentOptions # readList :: ReadS [EnvironmentOptions] # readPrec :: ReadPrec EnvironmentOptions # readListPrec :: ReadPrec [EnvironmentOptions] #
Show EnvironmentOptions Source #
Instance details Defined in Image.LaTeX.Render Methods showsPrec :: Int -> EnvironmentOptions -> ShowS # show :: EnvironmentOptions -> String # showList :: [EnvironmentOptions] -> ShowS #

defaultEnv :: EnvironmentOptions Source #

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

data TempDirectoryHandling Source #

Constructors

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

Instances

Eq TempDirectoryHandling Source #
Instance details Defined in Image.LaTeX.Render Methods (==) :: TempDirectoryHandling -> TempDirectoryHandling -> Bool # (/=) :: TempDirectoryHandling -> TempDirectoryHandling -> Bool #
Ord TempDirectoryHandling Source #
Instance details Defined in Image.LaTeX.Render 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 Source #
Instance details Defined in Image.LaTeX.Render Methods readsPrec :: Int -> ReadS TempDirectoryHandling # readList :: ReadS [TempDirectoryHandling] # readPrec :: ReadPrec TempDirectoryHandling # readListPrec :: ReadPrec [TempDirectoryHandling] #
Show TempDirectoryHandling Source #
Instance details Defined in Image.LaTeX.Render Methods showsPrec :: Int -> TempDirectoryHandling -> ShowS # show :: TempDirectoryHandling -> String # showList :: [TempDirectoryHandling] -> ShowS #

Formula Options

data FormulaOptions Source #

Constructors

FormulaOptions
Fields preamble :: String LaTeX preamble to use. Put your `usepackage` commands here.@ commands here. environment :: Maybe String LaTeX environment in which the equation will be typeset, usually `math` or `displaymath`

Instances

Eq FormulaOptions Source #
Instance details Defined in Image.LaTeX.Render Methods (==) :: FormulaOptions -> FormulaOptions -> Bool # (/=) :: FormulaOptions -> FormulaOptions -> Bool #
Ord FormulaOptions Source #
Instance details Defined in Image.LaTeX.Render 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 Source #
Instance details Defined in Image.LaTeX.Render Methods readsPrec :: Int -> ReadS FormulaOptions # readList :: ReadS [FormulaOptions] # readPrec :: ReadPrec FormulaOptions # readListPrec :: ReadPrec [FormulaOptions] #
Show FormulaOptions Source #
Instance details Defined in Image.LaTeX.Render Methods showsPrec :: Int -> FormulaOptions -> ShowS # show :: FormulaOptions -> String # showList :: [FormulaOptions] -> ShowS #

displaymath :: FormulaOptions Source #

Use the amsmath, amsfonts and lmodern package, the displaymath environment.

math :: FormulaOptions Source #

Use the amsmath, amsfonts and lmodern package, the math environment.

defaultFormulaOptions :: FormulaOptions Source #

Use the amsmath, amsfonts and lmodern packages.