[kde-doc-english] ktexteditor component (≃kwrite) documentation

Burkhard Lück lueck at hube-lueck.de
Mon Jul 29 19:34:12 UTC 2013


Hallo,

talking with Yuri on irc how to fix https://bugs.kde.org/show_bug.cgi?id=322915 
(New: Krusader - KrViewer - content menu View -> Code Folding) he pointed out 
that Krusader - an Extragear application with its own release cycle - can be 
build with a range of kde version from 4.8 (?) to 4.11. 
That is typical for nearly all application outside the kde main modules.

Because the ktexteditor component is in kdelibs and used by many extragear / 
playground application outside kde main modules like e.g krusader or kdevelop 
there is no real solution for fixing the KrViewer bug.

So far the doc for the ktexteditor component in Krusader is a manual copy of 
menu + config docbook from KWrite docs.

That means we can provide only one correct version of documentation for the 
Editor used in Krusader, but depending on the version of kdelibs the users 
Krusader release was build, this will be wrong for some users.

Using links to KWrite doc parts on docs.kde.org doesn't not really work 
either, because there are only the latest stable (already a 4.11) and the 
master version of ktexteditor documented.

>From my point of view the reason for this dilemma is that the ktexteditor 
component has its code in kdelibs but the documentation in Kwrite in the Kate 
module.

I'd like to discuss possible solution for the issue with the documentation for 
ktexteditor component:

1) Move part of Kate/KWrite docbooks (menu + config parts) into kdelibs and 
provide a link in the extragear apps to this docbook and for Kate/KWrite pull 
this into their handbooks

2) Like No 1) but as part of fundamentals in kde-runtime

Please comment and discuss this.

Thanks.

-- 
Burkhard Lück



More information about the kde-doc-english mailing list