Windows Dependencies

To install AsciiDoc on windows, get the latest version from Sourceforge and unzip somewhere on your drive. Make sure the asccidoc.py file is available in your path in order for CMake to be able to find it.

AsciiDoc cannot produce PDF output without a PDF generator which can be either dblatex or Apache FOP. On Windows we must satisfy the PDF generator dependency ourselves.

Details of how to install dblatex and FOP are included below.

po4a is a perl script and so requires PERL to be installed. If you’re using a POSIX emulation layer with package management, grab the perl package.

Outside of a POSIX emulation you’ll need to grab PERL. ActivePerl is recommended.

Install the CPAN modules which are required by po4a. After installing perl, on the command line type:

Grab the latest po4a distribution from Alioth, decompress it somewhere on your harddrive and make sure the directory containing po4a is available in your PATH environment variable. CMake will be able to find po4a on Windows so long as Perl is working and po4a is in your path.

That’s all there is to get po4a working on Windows; It’s just used in-place.

dblatex has experimental support in the project for PDF generation on Windows. However, it has not been proven to work so currently FOP is the only supported PDF generator on Windows.

In order for CMake to use DBLATEX, use the following when configuring with CMake:

dblatex is currently the default PDF generator anyway, so omitting the above will also work if you just want to build using the default tools (in future we may change to something else, like FOP for example)

Make sure you have the latest version of python 2 installed.

Download and install MikTex which provides the latex backend for dblatex. It’s recommended during install to set the "Install packages on the fly" to yes so MikTex doesn’t have to ask before installing packages - it’s a real pain when installing dblatex otherwise!! It also appears that if you miss that setting dblatex will fail to install because of some crashes of MikTex which then reports missing elements in the toolchain.

Download and install libxml2 which is pain. You’ll need to download and decompress all the zip files. Then, manually copy each of the folders into a common directory so that you end up with one bin directory and one lib directory, etc. You must then make sure the bin path of your installation directory is added to your PATH environment variable.

Then download the latest dblatex .tar.bz2 from Sourceforge

Decompress the tar.bz2 somewhere and then install dbltatex:

So long as the install works, CMake will be able to find dblatex in your python installation

It’s possible to use Apache FOP for PDF generation with AsciiDoc instead of dbaltex. Some people will prefer the output of Apache FOP compared to dblatex. It brings with it a dependency on a Java runtime.

In order for CMake to use FOP, use the following when configuring with CMake: