Text.LaTeX.Base.Warnings

This module provides functionality for check a LaTeX value for possibly undesired things (like the call to an undefined label), returning Warnings. These are called Warnings because they never terminate the program execution.

Warnings datatype

data Warning

List of possible warnings.

Constructors

UnusedLabel Text

There is an unused label. Argument is its name.

UndefinedLabel Text

There is a reference to an undefined label. Arguments is the name.

NoClassSelected

No class selected with documentclass.

NoDocumentInserted

No document inserted.

CustomWarning Text

Custom warning for custom checkings. Use it as you want.

Instances

Eq Warning

Methods

(==) :: Warning -> Warning -> Bool

(/=) :: Warning -> Warning -> Bool

Show Warning

Methods

showsPrec :: Int -> Warning -> ShowS

show :: Warning -> String

showList :: [Warning] -> ShowS

data TeXCheck

A TeXCheck is a function that checks possible warnings from a LaTeX value. Use the Monoid instance to combine check functions.

Instances

Monoid TeXCheck

Methods

mempty :: TeXCheck

mappend :: TeXCheck -> TeXCheck -> TeXCheck

mconcat :: [TeXCheck] -> TeXCheck

check :: TeXCheck -> LaTeX -> [Warning]

Apply a checking.

checkFromFunction :: (LaTeX -> [Warning]) -> TeXCheck

Build a TeXCheck from a function.

Several checkings

checkLabels :: TeXCheck

Checking for unused labels or references tu undefined labels.

checkClass :: TeXCheck

Check if a document class is specified for the document (using documentclass).

checkDoc :: TeXCheck

Check if the document environment is called in a LaTeX.

Complete checking

checkAll :: TeXCheck

Check with checkLabels, checkClass and checkDoc.