Qt Documentation

Qt 5.14
QDoc Manual
Generating DITA XML Output

Generating DITA XML Output

In your configuration file, set your outputformats variable to DITAXML, and send the output to an appropriate directory:

outputdir                  = $QTDIR/doc/ditaxml
outputformats              = DITAXML

And include these macros in your configuration file to prevent QDoc from doing some escaping that doesn't validate in XML:

macro.aacute.DITAXML       = "&aacute;"
macro.Aring.DITAXML        = "&Aring;"
macro.aring.DITAXML        = "&aring;"
macro.Auml.DITAXML         = "&Auml;"
macro.br.DITAXML           = " "
macro.BR.DITAXML           = " "
macro.copyright.DITAXML    = "&copy;"
macro.eacute.DITAXML       = "&eacute;"
macro.hr.DITAXML           = " "
macro.iacute.DITAXML       = "&iacute;"
macro.oslash.DITAXML       = "&oslash;"
macro.ouml.DITAXML         = "&ouml;"
macro.raisedaster.DITAXML  = "<sup>*</sup>"
macro.rarrow.DITAXML       = "&rarr;"
macro.reg.DITAXML          = "<sup>&reg;</sup>"
macro.uuml.DITAXML         = "&uuml;"
macro.mdash.DITAXML        = "&mdash;"
macro.emptyspan.DITAXML    = " "

You can also set default values for some of the tags in the DITA <prolog> and <metadata> elements:

dita.metadata.default.author      = Qt Development Frameworks
dita.metadata.default.permissions = all
dita.metadata.default.publisher   = Qt Project
dita.metadata.default.copyryear = 2020
dita.metadata.default.copyrholder = Qt Project
dita.metadata.default.audience = programmer

See the \meta command for more details on DITA metadata.

minimum.qdocconf QA Pages

© 2020 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.