User documentation

Using Shell

Thanks to this converter, you can get hdoc files from your docbook files.

It is quite easy to use:

  1. First you have to put your DocBook source file and the resources attached in the "DocBook" folder.

  2. Open your shell terminal

  3. Go to the converter's root directory (which contains ANT, XSL and DocBook folders).

  4. Then you can execute the script called main.ant, located in the "ANT" folder. It takes two parameters :

    • "InputFile", which is your DocBook source file's name (without the extension).

    • "OutputFile", which is optionnal (is "out" by default), and allows you to specify the name of the output file.

Here is an example: ant -DInputFile=myfilename -buildfile ./ANT/main.ant

The hdoc content will be generated in the root folder, as out.hdoc if you did not specify the OutputFile parameter, or as valueOfOutputFile.hdoc. An Opale file is also generated, as out.scar, or valueOfOutputFile.scar.