victorcmiraldo / hatex

The Haskell LaTeX library.

The HaTeX library

HaTeX is a Haskell library that implements the LaTeX syntax, plus some abstractions on top.

Check a list of usage examples in the Examples directory of the repository in GitHub. A good starting point is simple.hs. Run any example script executing the main function.

Installation notes

To install HaTeX, use cabal-install or stack.

To install with cabal, run:

$ cabal update
$ cabal install HaTeX

This will download and install the latest official release (recommended). If you want to try a newer version, use git to clone the code contained in this repository.

$ git clone https://github.com/Daniel-Diaz/HaTeX.git
$ cd HaTeX
$ cabal install

However, this is not recommended as it may include some bugs or oddities due to in-development features. Note that this package follows the Package Versioning Policy, so it is unlikely to suffer from API breakages if you follow it too when importing the library (assuming you are using the version in Hackage).

Current HaTeX versions

HaTeX User's Guide

The HaTeX User's Guide lives here... and is also done in Haskell! It is free source and anybody can contribute to it. Doing so, you will help current and future users!

A downloadable version (not necessarily the latest version, but most likely) can be found here. To be sure that you are reading the last version, go to the github repository of the guide and follow instructions to build it. It is fairly easy.

Please note that the user's guide needs to be updated (contributions are more than welcome!).

Community and Contributions

There are many ways to get involved in the HaTeX project. Use the most comfortable way for you.

• Fork the GitHub repository and make your own contributions.
• Report bugs or make suggestions opening a ticket in the Issue Tracker.
• Help us to improve and extend our hatex-guide.

TODO list

• Add more examples.
• Add more documentation.
• BibTeX support.

Related projects

• haskintex: Tool to use Haskell (and, additionaly, the HaTeX library) within a LaTeX file.
• TeX-my-math: Experimental library to ease the production of mathematical expressions using HaTeX.

Travis automatic build

For every code push to the GitHub repository, an automatic build checks that the library compiles with several versions of GHC (check .travis.yml for the complete list of versions) and that all tests pass. This label indicates the result of the last automatic build.

Currently, automatic builds are only running under Linux.