Safe Haskell | None |
---|---|
Language | Haskell2010 |
- imageForFormula :: EnvironmentOptions -> FormulaOptions -> Formula -> IO (Either RenderError (Baseline, DynamicImage))
- type Formula = String
- type Baseline = Int
- data RenderError
- data EnvironmentOptions = EnvironmentOptions {}
- defaultEnv :: EnvironmentOptions
- data TempDirectoryHandling
- = UseSystemTempDir { }
- | UseCurrentDir { }
- data FormulaOptions = FormulaOptions {}
- displaymath :: FormulaOptions
- math :: FormulaOptions
Rendering Formulas
imageForFormula :: EnvironmentOptions -> FormulaOptions -> Formula -> IO (Either RenderError (Baseline, DynamicImage)) Source
Convert a formula into a JuicyPixels DynamicImage
, also detecting where the typesetting baseline of the image is.
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.
Number of pixels from the bottom of the image to the typesetting baseline. Useful for setting your formulae inline with text.
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.
ImageIsEmpty | The equation produced an empty image |
CannotDetectBaseline | The baseline marker could not be found |
LaTeXFailure String |
|
DVIPSFailure String |
|
IMConvertFailure String |
|
IOException IOException | An |
ImageReadError String | The PNG image from ImageMagick could not be read by JuicyPixels. |
Options
Environment Options
data EnvironmentOptions Source
EnvironmentOptions | |
|
defaultEnv :: EnvironmentOptions Source
Sensible defaults for system environments. Works if dvips
, convert
, and latex
are recent enough and in your $PATH
.
data TempDirectoryHandling Source
UseSystemTempDir | A temporary directory with a name based on the given template will be created in the system temporary files location |
UseCurrentDir | A temporary directory with a name based on the given template will be created in the current directory |
Formula Options
data FormulaOptions Source
FormulaOptions | |
|
displaymath :: FormulaOptions Source
Use the amsmath
package, the displaymath
environment, and 200dpi.
Use the amsmath
package, the math
environment, and 200dpi.