XSLT to convert Doxygen to MediaWiki
Martin Gräßlin
mgraesslin at kde.org
Sun Jan 1 15:01:27 UTC 2012
Hi all,
I faced the problem of how to get the scripting documentation generated and
most important up to date without manually editing the Wiki pages.
As I am lazy I wrote an XSL Template to convert Doxygen generated XML into
MediaWiki syntax. The template processes:
* read-only properties
* read-write properties
* public slots
* Q_SCRIPTABLE public methods
The generated MediaWiki code matches the style used by Plasma's JavaScript
documentation.
An example for docu generated by the template can be found in [1]. To convert
xsltproc cannot be used as I use XSLT 2.0 functionality. Best use saxon [2].
To generate use the following command:
java -cp saxon9he.jar net.sf.saxon.Transform -t -s:/path/to/doxygen-
generated.xml -xsl:/path/to/mediawiki.xslt
I hope this can be useful to keep the Plasma JavaScript docu up to date :-)
Cheers
Martin
[1] http://techbase.kde.org/Development/Tutorials/KWin/Scripting/API_4.9
[2] http://saxon.sourceforge.net
-------------- next part --------------
A non-text attachment was scrubbed...
Name: mediawiki.xslt
Type: application/xslt+xml
Size: 1774 bytes
Desc: not available
URL: <http://mail.kde.org/pipermail/plasma-devel/attachments/20120101/4899d526/attachment.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/plasma-devel/attachments/20120101/4899d526/attachment.sig>
More information about the Plasma-devel
mailing list