| Safe Haskell | Safe |
|---|---|
| Language | Haskell2010 |
Text.LaTeX.Base.Render
Description
Synopsis
- data Text
- module Data.String
- class Show a => Render a where
- render :: a -> Text
- renderBuilder :: a -> Builder
- renderAppend :: Render a => [a] -> Text
- renderChars :: Render a => Char -> [a] -> Text
- renderCommas :: Render a => [a] -> Text
- renderFile :: Render a => FilePath -> a -> IO ()
- rendertex :: (Render a, LaTeXC l) => a -> l
- readFileTex :: FilePath -> IO Text
- showFloat :: RealFloat a => a -> String
Re-exports
A space efficient, packed, unboxed Unicode text type.
Instances
| Hashable Text | |
Defined in Data.Hashable.Class | |
| Pretty Text | Automatically converts all newlines to
Note that
Manually use |
Defined in Prettyprinter.Internal | |
| Render Text Source # | This instance escapes LaTeX reserved characters. |
| Texy Text Source # | |
| Monad m => Stream Text m Char | |
| type Item Text | |
module Data.String
Render class
class Show a => Render a where Source #
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.
Consider also to use rendertex to get Renderable values
into LaTeX blocks.
If you want to make a type instance of Render and you already
have a Show instance, you can use the default instance.
render = fromString . show
Minimal complete definition
Nothing
Instances
renderAppend :: Render a => [a] -> Text Source #
Render every element of a list and append results.
renderChars :: Render a => Char -> [a] -> Text Source #
Render every element of a list and append results,
separated by the given Char.
renderCommas :: Render a => [a] -> Text Source #
Render every element of a list and append results, separated by commas.
rendertex :: (Render a, LaTeXC l) => a -> l Source #
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 Source #
If you are going to insert the content of a file
in your LaTeX data, use this function to ensure
your encoding is correct.