Hackage :: [Package]

hatex-guide: HaTeX User's Guide.

[ bsd3, latex, library ] [ Propose Tags ] [ Report a vulnerability ]

The HaTeX User's Guide is a manual explaining the HaTeX library (http://hackage.haskell.org/package/HaTeX). This library can be used to output the guide in different formats. A compiled pdf version of the latex output can be found at http://daniel-diaz.github.com/projects/hatex/hatex-guide.pdf. The online HTML version is in http://daniel-diaz.github.com/projects/hatex/hatex-guide.html. See the README file (https://github.com/Daniel-Diaz/hatex-guide/blob/master/README.md) for more details.

[Skip to Readme]

Modules

[Index]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 1.0, 1.0.1, 1.0.1.1, 1.0.1.2, 1.0.1.3, 1.0.1.4, 1.0.1.5, 1.0.1.6, 1.1.0.0, 1.2.0.0, 1.3.0.0, 1.3.0.1, 1.3.1.0, 1.3.1.1, 1.3.1.2, 1.3.1.3, 1.3.1.4, 1.3.1.5, 1.3.1.6
Dependencies base (>=4 && <5), blaze-html (>=0.5.1.0 && <0.8), directory (>=1.2.0.0 && <1.3), filepath (>=1.1.0.0 && <1.4), HaTeX (>=3.7.0.0 && <3.11.0.0), parsec (>=3.1.2 && <3.2), text (>=0.11 && <2), time (>=1.2.0.2 && <1.5), transformers (>=0.3.0.0 && <0.4) [details]
License BSD-3-Clause
Author Daniel Díaz
Maintainer Daniel Díaz (dhelta `dot` diaz `at` gmail `dot` com)
Category LaTeX
Bug tracker https://github.com/Daniel-Diaz/hatex-guide/issues
Source repo head: git clone git@github.com:Daniel-Diaz/hatex-guide.git
Uploaded by DanielDiaz at 2014-02-04T15:39:54Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 14938 total (64 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Successful builds reported [all 1 reports]

Readme for hatex-guide-1.3.0.1

[back to package description]

HaTeX User's Guide

Welcome to the HaTeX User's Guide!

A pdf version (created from the LaTeX output) can be downloaded from here.

An online version (created from the HTML output) can be seen here.

Building the guide

To build the guide, first you need to install the library.

Installing from Hackage

Using cabal-install you can install the library directly from Hackage.

$ cabal install hatex-guide

The installed package includes a small library which exports a function called writeGuide. This function has a parameter indicating the format of the output. For example, writeGuide LaTeX will write the output in the current directory in LaTeX format. Read the package documentation to know about the supported formats.

Once the package is installed, run GHCi and run the following session.

$ import Text.LaTeX.Guide
$ writeGuide LaTeX

Installing HEAD version

Run the following commands to download and install the HEAD version. Requires git and cabal.

$ git clone git@github.com:Daniel-Diaz/hatex-guide.git
$ cd hatex-guide
$ cabal install

Once installed, import Text.LaTeX.Guide and use writeGuide to build the actual guide. Depending on the argument used for writeGuide, the output will have a different format. For example, writeGuide LaTeX will output in the current directory a .tex file of the guide.

Contributing to the guide

There are several things to keep in mind to contribute to the guide. If you contribute, do not forget to add your name to the contributors list which you can find in the Text.LaTeX.Guide.Info module.

Sections

Each section of the guide is written in a different file. Every section is stored in the src folder in the repository. The order in which each section appears in the guide is determined by the sectionList constant defined in the Text.LaTeX.Guide.Info module.

Syntax

The syntax used to write the guide is described in Text.LaTeX.Guide.Syntax. The current content can also be helpful to understand it.

Images

When including images, it is required to save them in the res directory, and include their file name in the otherResources value defined in the Text.LaTeX.Guide.Info module.