W3cubDocs

/Qt 5.11

Generating DITA XML Output

QDoc can generate 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       = "á"
macro.Aring.DITAXML        = "Å"
macro.aring.DITAXML        = "å"
macro.Auml.DITAXML         = "Ä"
macro.br.DITAXML           = " "
macro.BR.DITAXML           = " "
macro.copyright.DITAXML    = "©"
macro.eacute.DITAXML       = "é"
macro.hr.DITAXML           = " "
macro.iacute.DITAXML       = "í"
macro.oslash.DITAXML       = "ø"
macro.ouml.DITAXML         = "ö"
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 = 2018
dita.metadata.default.copyrholder = Qt Project
dita.metadata.default.audience = programmer

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

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5/21-3-qt-dita-xml-output.html