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

[Burkhard Lück]

Am Dienstag, 30. Juli 2013, 19:11:24 schrieb T.C. Hollingsworth:
> Hi!
> 
> On Mon, Jul 29, 2013 at 12:34 PM, Burkhard Lück <lueck at hube-lueck.de> wrote:
> > 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.
> 
> Yup.  IIRC I left some comments in there the last time I synced them
> up indicating where to copy and paste to/from to make that easier.
> 
> I'd be happy to resync them if you'd like, since it's too late to do
> any split for KDE 4.11.
> 
The problem is the version of ktexteditor to resync to, for some krusader user 
it will be wrong in any case.

What about replacing the parts copied from kwrite with an explanation the 
ktexteditor is used here and links to parts of kwrite docbook?
At least the krusader user will have the correct version of the documentation 
(if kwrite is installed).
 
> > 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
> 
> IIRC I intended to do a katepart docbook the last time this came up,
> but it got forgotten because I suck.  :-(
> 
> Not sure it really should be part of Fundamentals; it's a bit beyond
> its scope IMHO.  KatePart isn't really used a whole lot around KDE;
> just in a handful of applications.
> 
> I'm all for #1, except I think it belongs in kate.git, not
> kdelibs.git.  KatePart itself (the thing that implements KTextEditor
> used by most KDE applications) is not in kdelibs.git, just the
> KTextEditor interface, and even that will be coming back home for KDE
> 5 when frameworks gets split up.
> 
> -T.C.
> _______________________________________________
> kde-doc-english mailing list
> kde-doc-english at kde.org
> https://mail.kde.org/mailman/listinfo/kde-doc-english
-- 
Burkhard Lück