Safe Haskell | None |
---|---|
Language | Haskell2010 |
TODO(kerckhove) big example here!
- buildLaTeXProject :: MonadIO m => ΛTeXT m a -> ProjectConfig -> m (Either [ΛError] ())
- execLambdaTeXT :: Monad m => ΛTeXT m a -> GenerationConfig -> m ([ΛError], LaTeX, [Reference], [(String, FilePath -> IO ())])
- data ProjectConfig = ProjectConfig {}
- defaultProjectConfig :: ProjectConfig
- newtype GenerationConfig = GenerationConfig {}
- defaultGenerationConfig :: GenerationConfig
- module Text.LaTeX.LambdaTeX.Selection
- module Text.LaTeX.LambdaTeX.Reference
- module Text.LaTeX.LambdaTeX.Package
- module Text.LaTeX.LambdaTeX.Action
- module Text.LaTeX.LambdaTeX.Types
Documentation
buildLaTeXProject :: MonadIO m => ΛTeXT m a -> ProjectConfig -> m (Either [ΛError] ()) Source #
Build all the files for a LaTeX project given by a ΛTeXT generator This either returns Left with an error or Right () to signify success.
This function takes care of some of the LaTeX tediousness:
- LaTeX file generation
- Automatic bibtex file generation
- All safety provided by
execLambdaTeXT
(in the form of textual errors) - Automatic asynchronic resolution of IO dependencies for graphviz or tikz figures
execLambdaTeXT :: Monad m => ΛTeXT m a -> GenerationConfig -> m ([ΛError], LaTeX, [Reference], [(String, FilePath -> IO ())]) Source #
Execute a ΛTeXT generation This either returns a tuple of the errors and a tuple of the resulting LaTeX value and a list of external references that need to be put into a bibtex file.
This function takes care of a lot of safety issues:
- Subset selection. This allows you to build large documents in parts.
- External dependency selection. No more
??
for external references in the output pdf. - Internal dependency safety. No more
??
for external references in the internal pdf. - Package dependency resolution, TODO(kerckhove) with packages in the right order
- Dependency selection of figure dependencies on graphviz or tikz figures
Configuration
defaultProjectConfig :: ProjectConfig Source #
Default project configuration.
Modify this instead of building your own ProjectConfig
newtype GenerationConfig Source #
Configuration of ΛTeX generation
defaultGenerationConfig :: GenerationConfig Source #
Default generation config.
Modify this instead of building your own GenerationConfig
Selections
References
Packages dependencies
module Text.LaTeX.LambdaTeX.Package
IO dependencies
module Text.LaTeX.LambdaTeX.Action
Re-exports
module Text.LaTeX.LambdaTeX.Types