As you all know KTorrent has at the moment no documentation at all. Stoeptegel on of our forum members was working on that, however due to health issues he is not able to complete it. So he has sent me what he has already finished. You can find that here :

http://ktorrent.org/downloads/ktorrent-documentation.tar.gz

Seeing that I don't have the time to finish and keep it up to date and Ivan hasn't even got the time to do some coding the last few months, so we are looking for some volunteers to finish it, and maintain it.

Obviously, you will need to have a pretty good knowledge of English. And we can't offer you much more then a big thank you.

But you will get my undivided attention on any questions you might have while writing it, and I will keep you informed about new features and changes to the GUI.

So, any volunteers ?

I would be happy to work on it when I get a chance. From quick looking it looks like everything is done except for chapter five.

I don't know how good I will make it, as I have never been great with writing, but I love this project and would be more than willing to do something to give back as I can't code.

Quick question... How much of this documentation is going to need to be changed for the KDE4 port? Are you planning on continuing KDE3 support?

bassmadrigal wrote:Quick question... How much of this documentation is going to need to be changed for the KDE4 port? Are you planning on continuing KDE3 support?

That is another issue, George project is going so fast and changes are popping up everywhere, anytime. I do not think there is a doc needed for kde3 version anymore, seeing kde4 is almost there.

Btw, you need to know how to write docbook xml for this job, which can be tricky if you have not done it before.

I haven't done it before. Is there a program to use, or can you just use a regular text editor? Is it that much different than xhtml? I so far have seemed to pick up well with web programming languages.

As far as KDE3 vs KDE4 versions, I won't be running KDE4 until Patrick Volkerding releases a new slackware version that contains it. I just don't want to go through the hassle of updating Qt and then upgrading KDE. So I may be in the same boat as others. As such I think there should be two versions of the doc.

I can at least get the documentation going for the KDE3 version, but any changes for the KDE4 version will need to be done by someone else, or wait until I can upgrade my distro.

My intention is to basically keep on fixing bugs in the 2.2 series until all of them are gone (somewhere around the year 3000 probably , so there are going to be several bugfix releases (2.2.5 and onwards).

I won't even refuse new features when somebody comes along with a bunch of patches.

So the KDE3 version will be maintained, and documentation makes sense.

As for the KDE4 version, most of the documentation can probably be reused. Might need some modifications here and there, and some new features need to be described.

bassmadrigal wrote:I haven't done it before. Is there a program to use, or can you just use a regular text editor? Is it that much different than xhtml? I so far have seemed to pick up well with web programming languages.

I just use kate, but quanta also has some tags for docbook in it. Be wise and backup with quanta though, as quanta is a little crashy and might destroy your document.

It got the same base as html; sgml. If you know howto work with xml you can do it. You'll only have to learn some extra tags.

As far as KDE3 vs KDE4 versions, I won't be running KDE4 until Patrick Volkerding releases a new slackware version that contains it. I just don't want to go through the hassle of updating Qt and then upgrading KDE. So I may be in the same boat as others. As such I think there should be two versions of the doc.

I agree, me personally won't touch kde4 for another year or so...

I can at least get the documentation going for the KDE3 version, but any changes for the KDE4 version will need to be done by someone else, or wait until I can upgrade my distro.

I and i know definately George will appreciate that!
Be aware that i have tagged it somewhere with <!-- DONE TILL HERE, WORKME! -->, so if you read it and see typo's please do edit so.

I will be able to probably get a lot of this done over Christmas week as I have to "work". The problem is there is very little to do that week, so I will be bringing in my laptop and crunching through this.

Later this week I hope to look through the options in the settings and note the options that I am clueless about. Then hopefully I can get George to get me information on them.

bassmadrigal, how far have you came with this?
I am able to pick it up/support you from half april.

PS. You have a PM.

I downloaded the 2006 manual posted above and put it online as a wikibook here:
.
http://en.wikibooks.org/wiki/Ktorrent#Table_of_Contents

This should make it possible for users to see it, and make it easier to edit.

I've noticed a number of typos and incomplete sections. Please take a look when you have a chance.

I'm new to this forum, but this is just the thing I'd like to get involved with.

Hi... I've just started out helping with documentation, and can see that there's a lot of interest in getting KTorrent's documents up to date! The documentation deadline is approaching for KDE 4.1, but there's still no documentation yet. However, the wiki page looks great, so would it be a good idea to let some of the more experienced members of the doc. team know about the wiki, so they could convert it to DocBook? (better to get something in for 4.1 than nothing at all!!)

(btw, I am editing the grammar of the wiki now)

devenne wrote:Hi... I've just started out helping with documentation, and can see that there's a lot of interest in getting KTorrent's documents up to date! The documentation deadline is approaching for KDE 4.1, but there's still no documentation yet. However, the wiki page looks great, so would it be a good idea to let some of the more experienced members of the doc. team know about the wiki, so they could convert it to DocBook? (better to get something in for 4.1 than nothing at all!!)

(btw, I am editing the grammar of the wiki now)

Thanks for that!

I finished going through the wiki yesterday, and corrected the grammar for everything, but there really is a lot of info missing. It's a really good start though. While reading, I also felt the content might need some re-organization. I doubt that I can fill all the gaps content-wise since the KDE style guide suggests some info which might be better answered by some of the developers, and all the existing info is based on old versions of KTorrent. I definitely need to learn some of the details about BitTorrent too, so it will be easier to write about some of the features! I understand technical jargon, but I definitely need to do some research to effectively try and help explain some of this content for a new user. So, it looks to me like KTorrent docs will be for KDE 4.2 But I'd like to continue working on this, since KTorrent has helped me experiment with so many distros, and it would be awesome to help out! Maybe tomorrow I can post a list of ideas so it might be easier for anyone else to pick something to work on? (It does seem kind of hard for newbies like me to get started without some specific tasks )

oenothera wrote:I downloaded the 2006 manual posted above and put it online as a wikibook here:
.
http://en.wikibooks.org/wiki/Ktorrent#Table_of_Contents

This should make it possible for users to see it, and make it easier to edit.

This wiki is a good idea, however I feel it needs to be much more prominently communicated, first it should probably be mentioned on the ktorrent.org website, second it also probably wouldn't hurt all that much if this URL was directly provided in ktorrent itself, possibly also in some sort of "welcome" screen.

In addition, it's obvious that in its current state the documentation could already benefit rather significantly from some imagery, such as relevant screenshots, depicting configuration screens etc.

This is something that any user can contribute, without requiring any writing/technical skills at all.

So, maybe what's needed is some sort of "Todo" section on the "discussion" page?

All the best,
Segmented