User documentation

This section tends to provide the main guidelines to install the environment and to use properly the LaTeX_to_Hdoc converter.

Setting the environment

Before converting the LaTeX document to a Hdoc document, you have to set up the environment properly.

The LaTeX2Hdoc converter uses :

  • an Ant script in order to convert a LaTeX document to a Hdoc document ;

  • a Java application to convert a LaTeX document to its XML equivalent. In fact, a LaTeX document is not a basic XML document and hence has to be first converted to this metalanguage.

  1. Installing Apache Ant :

    Follow the instructions in this website : http://ant.apache.org/manual/install.html.

  2. Installing Java :

    You can download it on https://www.java.com/fr/download/.

Those installations are prerequisites for the Latex_to_Hdoc converter to be effective and efficient.

Convert LaTeX document to Hdoc document

Now that the environment is ready, you will be able to convert directly a Latex document to a Hdoc document using the converter.

  1. Download the LaTeX_to_Hdoc converter archive

  2. Unzip it

  3. Open a Terminal and move to this directory

  4. Use the following command : ant -buildfile latex_to_hdoc.ant -DLaTeXPath your_latex_file.tex -DimgPath image_directory_path

  5. A latex.hdoc file is available in the hdoc directory.

Image directory path

Please note that :

  • the actual script will copy all the images included in the directory you have indicated as parameter and it will search them at the path you have written in the command includegraphics. If you don't use the command graphicspath, you have to well organize the directory in order to make the images accessible by the converter.

  • if your LaTeX document doesn't have images, indicate only the LaTeXPath parameter.