Documenting applet config keys
David Edmundson
david at davidedmundson.co.uk
Thu Sep 8 13:15:03 UTC 2016
For scripting purposes it's important to know the configuration keys of an
applet/wallapper/containment .
Currently this is written into the wiki, which isn't a good way to do
documentation, it gets out of sync.
I wrote a script that reads kcfg xml files and autogenerates the docs for
the wiki.
(Martin G has an idea to put it into api.kde.org, which I think is a good
future direction)
The documentation here [1]: is now completely up-to-date \o/
However, the state of descriptions still sucks. Can people please start to
fill out <label> tags inside the entries in all applet main.xml config
files. Also please add hidden=true if they should not be listed here. [2]
Thanks
[1]
https://userbase.kde.org/KDE_System_Administration/PlasmaDesktopScripting#Configuration_Keys
[2] https://www.kde.org/standards/kcfg/1.0/kcfg.xsd
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/plasma-devel/attachments/20160908/722619ad/attachment.html>
More information about the Plasma-devel
mailing list