Text.LaTeX.Base.Writer

The writer monad applied to LaTeX values. Useful to compose LaTeX values using the do notation:

 anExample :: Monad m => LaTeXT m ()
 anExample = do
   documentclass [] article
   author "Daniel Monad"
   title "LaTeX and do notation"
   document $ do
     maketitle
     section "Some words"
     "Using " ; texttt "do" ; " notation "
     "you avoid many ocurrences of the "
     texttt "(<>)" ; " operator and a lot of "
     "parentheses. With the cost of a monad."

Since LaTeXT is a monad transformer, you can do also:

 anotherExample :: Monad m => LaTeXT m ()
 anotherExample = lift (readFile "foo") >>= verbatim . fromString

This way, it is easy (without carrying arguments) to include IO outputs in the LaTeX document, like files, times or random objects.

Another approach could be to have custom counters, label management or any other user-defined feature.

Of course, you can always use the simpler interface provided by the plain LaTeX type.

LaTeXT writer

data LaTeXT m a

Instances

MonadTrans LaTeXT

Monad m => Monad (LaTeXT m)

Functor m => Functor (LaTeXT m)

Applicative m => Applicative (LaTeXT m)

MonadIO m => MonadIO (LaTeXT m)

Monad m => IsString (LaTeXT m a)

Be careful when using fromString over a LaTeXT value, the returned value of the computation is bottom (i.e. undefined).

Monad m => Monoid (LaTeXT m a)

mappend = >>.

Monad m => LaTeXC (LaTeXT m a)

type LaTeXT_ m = LaTeXT m ()

runLaTeXT :: LaTeXT m a -> m (a, LaTeX)

execLaTeXT :: Monad m => LaTeXT m a -> m LaTeX

This is the usual way to run the LaTeXT monad and obtain a LaTeX value.

execLaTeXTWarn :: Monad m => LaTeXT m a -> m (LaTeX, [Warning])

Version of execLaTeXT with possible warning messages. This function applies checkAll to the LaTeX output.

extractLaTeX :: Monad m => LaTeXT m a -> LaTeXT m (a, LaTeX)

This function run a LaTeXT computation, lifting the result again in the monad.

extractLaTeX_ :: Monad m => LaTeXT m a -> LaTeXT m LaTeX

textell :: Monad m => LaTeX -> LaTeXT m ()

With textell you can append LaTeX values to the state of the LaTeXT monad.

rendertexM :: (Render a, Monad m) => a -> LaTeXT_ m

Just like rendertex, but with LaTeXT output.

 rendertexM = textell . rendertex

liftFun :: Monad m => (LaTeX -> LaTeX) -> LaTeXT m a -> LaTeXT m a

Lift a function over LaTeX values to a function acting over the state of a LaTeXT computation.

liftOp :: Monad m => (LaTeX -> LaTeX -> LaTeX) -> LaTeXT m a -> LaTeXT m a -> LaTeXT m a

Lift an operator over LaTeX values to an operator acting over the state of two LaTeXT computations.

Note: The returned value is the one returned by the second argument of the lifted operator.

merror :: Monad m => String -> LaTeXT m a -> LaTeXT m b

Re-export

lift :: MonadTrans t => forall m a. Monad m => m a -> t m a

Lift a computation from the argument monad to the constructed monad.