[kde-doc-english] Adaption of docbook location in frameworks/kf5

Burkhard Lück lueck at hube-lueck.de
Wed Mar 26 06:58:16 UTC 2014


Hi,

kdelibs was already splitted into different frameworks repos, the same will 
happen with kde-runtime and kde-workspace soon.

The documentation has to be splitted accordingly into the different repos.

We need to keep an eye on kde-runtime and kde-workspace and check that this is 
done properly, especially for the kcontrol docbooks. 
You can grep for X-DocPath, then you know the location of the code via the 
desktop file and can check, if the documentation in the X-DocPath string is in 
the correct repo.

But we still have decide how to handle some additional docbooks:

1) frameworks/ktetxteditor
Afaik this is the editor component used in kate, kwrite, kile, kdevelop, 
krusader etc.
Therefore parts of the kate docbooks should be moved into this repo as well 
(keep docs together with code)
This would help to solve https://bugs.kde.org/show_bug.cgi?id=322915
How do we use this docbook then? 
A link from the application handbook using this component? 
Pull in this docbook at application build time? Is that possible?

2) kde-runtime
2a) docbooks like documentationnotfound, fundamentals, onlinehelp
Move them all into khelpcenter repo?
Or should documentationnotfound go into frameworks/kio or kdoctools?

2b) plasmapkg - is this obsolete? 

2c) nepomuk? will be replaced with baloo

Thanks.

-- 
Burkhard Lück



More information about the kde-doc-english mailing list