[kde-doc-english] Assist with KWin documentation

[Yuri Chornoivan]

Hi,

написане Wed, 28 Mar 2012 22:40:45 +0300, Pablo Sanchez  
<pablo at blueoakdb.com>:

> Hi everyone,
>
> I am the author of the KWin Rules document (see
> http://userbase.kde.org/KWin_Rules).  I'd like to continue documenting
> other KDE areas.

Many thanks for your work. It is now in KDE repositories and on d.k.o:

http://docs.kde.org/development/en/kde-workspace/kcontrol/windowspecific/index.html
http://docs.kde.org/development/en/kde-workspace/kcontrol/windowspecific/windowspecific.pdf

> I ping'd Martin Gräßlin who suggested I coordinate with Burkhard
> Lueck.  I e-mailed Burkhard a while ago but I got busy and I suspect
> he did as well because I haven't heard anything back.  :)

Burkhard is busy at least until Easter.

> I was wondering what would be the best way to proceed?

You can do anything you like, everything will be helpful. ;)

You can write pages on UserBase (just convert them by yourself or let me  
know, so I will do the conversion) or write docs directly in DocBook  
format and send them here or commit to KDE repository by yourself.

The only concern is that these docs should be easily reach by the ordinary  
user (there must be "Help" button with corresponding line in desktop file  
of KCM module or some link in corresponding window)

> Martin did suggest a few other KWin areas which I could document:
>
> "But I think that quite a lot of our very useful effects like Present
> Windows and Desktop Grid are not documented at all. Also I could
> imagine that quite some documentation is outdated. Oh and the new
> scripting module does not have any documentation yet, though scripting
> itself is documented on techbase."

It would be good if Martin give some hints about what should become  
offline docs (docs for KCM modules), what should be written on UserBase  
(with links in KWin windows) and what should be packaged with -dev  
packages for developers (not for ordinary users).

Thanks in advance for your work.

Best regards,
Yuri