Caelum Tubaina

Summary

Tubaina is a textbook generator which receives a simple markup language syntax and outputs Xhtml and Latex.

Changelog

August 07, 2012 A lot of bugs fixed and new features added since last update of this changelog, here are some of them:
- it's possible to define boolean variables (in a similar way as C ifdef) to be avaiable at ftl templates with the option -e <var1> <var2>...
- new output option (-kindle) added to generate html output focused on building ebooks such as .epub or .mobi formats.
- a book may be splitted in multiple parts simply by adding [part <title>] tag at the beginning of a chapter.
- a new tag to render code published at gist: [gist <gist-id>]
September 15, 2011 Dropped support for one section per page, HTML. Instead, the -html option will generate an experimental one-page textbook (in which we're working :) ).
April 28, 2011 Support to syntax highlighting using Pygments (in many many languages).
October 24, 2010 Discontinuation of Maven as a build tool. Gradle is the new choice.
Aug 17, 2009 New output format --htmlflat (HTML output with one page per chapter).
Aug 6, 2009 Support for more than one chapter per afc file has been dropped. Please split your chapters in multiple files.

Developers' info

This project is built using Gradle (0.9rc1+). In order for it to behave like an Eclipse project you'll need to have Gradle installed (instructions to be found at: http://www.gradle.org/installation.html) and then run:

$ cd path/to/tubaina
$ gradle eclipse

You need pygments to run the tests, you can install it through easy_install (you should be able to install easy_install with your SO package manager):

$ easy_install Pygments==1.5

In order to build the distribution version do:

$ cd path/to/tubaina
$ gradle clean build zip

This will run the tests and, among other stuff, build a *.zip file with Tubaina's jar and all necessary libraries under build/distributions

Docker image

There's a Docker image that you can use to easilly install all dependencies of Tubaina.

If you want to build the latest version you can build your own image using [this Dockerfile] (https://github.com/caelum/tubaina/blob/master/src/docker/tubaina/Dockerfile) by running:

docker build -t csokol/tubaina src/docker/tubaina

If you don't want to build from latest sources, you can use the docker image available at [DockerHub] (https://registry.hub.docker.com/u/csokol/tubaina/) by running docker pull csokol/tubaina

After installing the image, independently of building from sources of downloading from DockerHub, you can run docker run -t -i csokol/tubaina java -jar /opt/tubaina/tubaina-1.8-SNAPSHOT.jar to execute tubaina jar.