Bug 118998

Summary:	Handbook for Kate 2.5 is missing
Product:	[Websites] docs.kde.org	Reporter:	paul.leopardi
Component:	general	Assignee:	Anders Lund <anderslund>
Status:	RESOLVED FIXED
Severity:	normal	CC:	nicolasg
Priority:	NOR
Version:	3.5
Target Milestone:	---
Platform:	openSUSE
OS:	Linux
Latest Commit:		Version Fixed In:

Description paul.leopardi 2005-12-25 23:58:52 UTC

Version:           2.5 (using KDE KDE 3.5.0)
Installed from:    SuSE RPMs
OS:                Linux

The Kate Handbook currently available via Help from Kate 2.5 and http://docs.kde.org/development/en/kdebase/kate/index.html is the handbook for Kate 2.4. Where is the Kate 2.5 Handbook?

Comment 1 Nicolas Goutte 2005-12-26 13:03:55 UTC

KDE cannot write documentation as fast as the coding is done. (We are trying to find ways to make it better in general.)

As for Kate, it seems that other bug reports have explained the problems: bug #96554 and bug #116147

It seems that Anne-Marie Mahfouf is working on it, according to her blog:
http://annma.blogspot.com/2005/12/docs-frenzy.html

I am tempted to mark this bug as duplicate of bug #116147, however I have found out that http://docs.kde.org works still with KDE 3.4 as stable and KDE 3.5 as unstable. I am not sure if this is entirely right.

Have a nice day!

Comment 2 Anne-Marie Mahfouf 2005-12-26 17:27:16 UTC

I am working on KWrite handbook and I doubt i'll have time to update Kate handbook in time as the docs will be frozen again in 3 days....

Comment 3 Anders Lund 2005-12-26 20:28:09 UTC

On Monday 26 December 2005 17:27, Anne-Marie Mahfouf wrote:
> I am working on KWrite handbook and I doubt i'll have time to update Kate
> handbook in time as the docs will be frozen again in 3 days....

auch - this is kinda my area. I can use some time tomorrow to read over the 
files and change the most important things. Any issue you know of that needs 
attention would be appreciated as a comment here.

-anders

Comment 4 Anne-Marie Mahfouf 2005-12-26 22:18:43 UTC

SVN commit 491627 by annma:

improve the handbook. Not totally finished as some explanations are missing.
Anders if you could go through it and fill in the blanks then copy/paste for Kate that would be quite great
CCBUG=118998
CCBUG=116147
CCBUG=96554


 M  +1360 -487 index.docbook

Comment 5 paul.leopardi 2005-12-27 07:38:43 UTC

Here are a few of the items which prompted this bug report.

Where is the Window Menu documented?
The Kate 2.4 Handbook does not document the Kate 2.5 Window menu. Where is the documentation for this menu?

Where is View->Switch to Command Line documented?
The Kate 2.4 Handbook does not document the Kate 2.5 View->Switch to Command Line menu entry. What does this menu entry do? Where is it documented?

The function key F7 has apparently changed from Settings->Show Konsole in 2.4 to View->Switch to Command Line in 2.5. Have any other function keys changed?

Comment 6 Anders Lund 2005-12-29 15:50:25 UTC

SVN commit 492295 by alund:

Update menu and config dialog references.
Brint the chapter on kate window up to date.
Fill in section on navigating the text.
Fill in chapter about using plugins.
Add a section about using sessions.
Fix various issues reported by Natalie.

Thanks goes to annma, PhilRod, cannlaith and other #kde regulars for kind help with english as well as docbook syntax, and to Natalie for very good bug reports.

BUG:118998
BUG:114320



 M  +30 -0     advanced.docbook  
 M  +935 -490  configuring.docbook  
 M  +132 -29   fundamentals.docbook  
 M  +8 -5      highlighting.docbook  
 M  +9 -13     mdi.docbook  
 M  +705 -394  menus.docbook  
 M  +80 -36    part.docbook  
 M  +20 -3     plugins.docbook