Text.LaTeX.Base.Render

Re-exports

data Text

A space efficient, packed, unboxed Unicode text type.

Instances

Eq Text

Data Text

Ord Text

Read Text

Show Text

Typeable Text

IsString Text

Monoid Text

NFData Text

Monad m => Stream Text m Char

module Data.String

Render class

class Show a => Render a where

Class of values that can be transformed to Text. You mainly will use this to obtain the Text output of a LaTeX value. If you are going to write the result in a file, consider to use renderFile.

Methods

render :: a -> Text

Instances

Render Double

Render Float

Render Int

Render Integer

Render TeXArg

Render LaTeX

Render Measure

Render TableSpec

Render Pos

Render Label

Render PaperType

Render ClassOption

Render URL

Render HRefOption

Render Theme

Render OverlaySpec

Render TheoremStyle

Render ColorName

Render ColorModel

Render Color

Render ColSpec

Render IGOption

renderAppend :: Render a => [a] -> Text

Render every element of a list and append results.

renderChars :: Render a => Char -> [a] -> Text

Render every element of a list and append results, separated by the given Char.

renderCommas :: Render a => [a] -> Text

Render every element of a list and append results, separated by commas.

renderFile :: Render a => FilePath -> a -> IO ()

Use this function to render a LaTeX (or another one in the Render class) value directly in a file.

rendertex :: (Render a, LaTeXC l) => a -> l

If you can transform a value to Text, you can insert that Text in your LaTeX code. That is what this function does.

Warning: rendertex does not escape LaTeX reserved characters. Use protectText to escape them.

Reading files

readFileTex :: FilePath -> IO Text

If you are going to insert the content of a file in your LaTeX data, use this function to ensure your encoding is correct.