The following examples describe the basic usage of the Doxia Converter.

Command Line Help

# java -jar target/apache-doxia-1.2-jar-with-dependencies.jar -h

usage: doxia [options] -in <arg> [-from <arg>] [-inEncoding <arg>] -out
             <arg> -to <arg> [-outEncoding <arg>]

 -e,--errors                         Produce execution error messages.
 -f,--format                         Format the output (actually only xml
                                     based outputs) to be human readable.
 -from <arg>                         From format. If not specified, try to
                                     autodetect it.
 -h,--help                           Display help information.
 -in,--input <arg>                   Input file or directory.
 -inEncoding,--inputEncoding <arg>   Input file encoding. If not
                                     specified, try to autodetect it.
 -out,--output <arg>                 Output file or directory.
 -outEncoding,--outputEncoding <arg>   Output file encoding. If not
                                       specified, use the input encoding (or detected).
 -to <arg>                           To format.
 -v,--version                        Display version information.
 -X,--debug                          Produce execution debug output.

Supported Formats:
from: apt, confluence, docbook, fml, twiki, xdoc, xhtml or autodetect
out: apt, docbook, fo, itext, latex, rtf, xdoc, xhtml
Supported Encoding:
UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, Shift_JIS, ISO-2022-JP,
ISO-2022-CN, ISO-2022-KR, GB18030, EUC-JP, EUC-KR, Big5, ISO-8859-1,
ISO-8859-2, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, windows-1251,
windows-1256, KOI8-R, ISO-8859-9

Note: The input parameters (i.e. encoding and format) can be autodetected.

Command Line Execution

# java -jar target/apache-doxia-1.2-jar-with-dependencies.jar \
    -in /path/to/xhtml.file \
    -from xhtml \
    -out /path/to/outputdir \
    -to apt

Note: The from parameter can be empty. In that case, Doxia converter tries to autodetect the from input from the in file parameter.

Java Usage

String in = "...";
String from = "...";
String out = "...";
String to = "...";

Converter converter = new DefaultConverter();
    InputFileWrapper input = InputFileWrapper.valueOf( in, from, "ISO-8859-1", converter.getInputFormats() );
    OutputFileWrapper output = OutputFileWrapper.valueOf( out, to, "UTF-8", converter.getOutputFormats() );

    converter.convert( input, output );
catch ( UnsupportedFormatException e )
catch ( ConverterException e )