I've been using ktorrent for a long time and have got to know a fair bit of it, Recently i was browsing through kde's help manuals and realized there wasn't one for ktorrent I quickly hoped over to the kde-docs irc channel and asked them about it. They said that people have been offering to do it for quite some time but it just hasn't happened yet. This would be the first bit of documentation I've written for kde but i would really like to document ktorrent, fill that empty space If i can do it in plain text i could start immediately, as apparently the doc team can turn it into docbook. I'm learning docbook at the moment, but would like to begin documenting right away! If anyone could give me any useful articles, anything atall that would help me in providing the quality documentation for ktorrent. On a side note, thanks for providing such a great torrent program!

Thank you,

Shadoze

There is some stuff on the wiki, but this is very incomplete :

http://ktorrent.org/wiki/index.php/Manual

This was from an earlier attempt by somebody else (who then gave up, probably when he realized the work involved) :

http://ktorrent.org/tmp/ktorrent-docs-0.0.13.tar.gz

Don't want to discourage you but, but it will involve some work. This is not done in an hour or two, and it will require regular updates.

You will get all my support, so ask any question you want.

Thank you well my time is pretty tight at the moment (coming to the end of my college course) But i'm sure i will be able to write a few bits before the end (3 - 4 weeks) After that i should have alot of time at weekends and wouldn't mind spending a lot of time writing documentation during those times. I'll try and start sometime this week though, and give everyone regular updates on how I'm doing in order to see that it's ok and i'm not accidentally misleading anyone.

I figured it wouldn't be a quick task and it will require quite a a lot of hours to be put in and some bits are going to be stressful, but the developers of ktorrent I'm sure get stressful a lot when writing code for it, but have you bailed out on us? No you haven't! Hopefully I'll follow the same trait as the you and stick to it till the end ^^

I do have a question however, is it compulsory that i must do it in docbook to begin with? Or can i start with plain text and work my way up (when i feel confident enough with docbook).

Shadoze wrote:I do have a question however, is it compulsory that i must do it in docbook to begin with? Or can i start with plain text and work my way up (when i feel confident enough with docbook).

Not really conversion to docbook can be done later on.