This forum has been archived. All content is frozen. Please use KDE Discuss instead.

No manual??? Need help writing one?

Tags: None
(comma "," separated)
MilhousePunkRock
Registered Member
Posts
5
Karma
0

No manual??? Need help writing one?

Wed Jul 05, 2006 5:58 am
Hello KTorrent forum members!

I recently switched to Linux and started using KTorrent. As I have used Azureus and µTorrent before, I find quite a few things being different now. So I wanted to enlighten myself by reading the manual.
And found out there is none!

So maybe this is my first opportunity to contribute to a software project by helping with the manual. If there already is one in the making, I might as well jump in for the German translation.

Rock on,
MilhousePunkRock
imported4-Ivan
Registered Member
Posts
819
Karma
0

Wed Jul 05, 2006 8:56 am
We had a thread here on forums about this. A guy volunteered to write the manual you could probably contact him and speed this thing up. It would be great if we could finish this manual before final version 2.0.

I cannot find that thread at the moment since I'm in a hurry but you could search the forums and find contact info. You can also count on my help if needed.
stoeptegel
Registered Member
Posts
1075
Karma
0

Thu Jul 06, 2006 10:08 am
http://ktorrent.org/forum/viewtopic.php ... highlight=

I haven't seen Lengau on jabber for some time now, but he lives in the U.S. so the timegap is not in my favour.
MilhousePunkRock
Registered Member
Posts
5
Karma
0

Mon Jul 10, 2006 6:30 am
Thanks for the search, stoeptegel.
I will try to get in touch with Lengau and see if there is something left to do for me...
lengau
Registered Member
Posts
36
Karma
0

Wed Jul 12, 2006 7:51 am
Hi, I'm still here.

Sorry. I've been away in Canada for a while. Having not had a computer, I couldn't do anything with the docs. But I'm still working on it.

I think maybe what we should do is split the document into sections that we write. I'm attaching the table of contents I've been using.

I. Introduction
II. User's Guide
1.KTorrent Fundamentals and Configuration
Please note: Due to the purpose of UpnP, it will be introduced here instead of under plugins.
This is also where the info widget is introduced.
A)Torrent Lingo
B)Configuring and using KTorrent
2.File Organization
3.The Queue Manager
4.Basic Plugins
A)Search Plugin
B)Bandwidth Scheduler
C)Partial Torrent Importer
5.Advanced Functionality
A)Bittorrent Encryption
B)DHT
C)Filtering IP addresses
D)Automatically adding Torrents
IV. Tips and Tricks
V. Glossary
VI. Credits

Sorry about the lack of formatting (not my fault, the site removed it).

What's done and not done is ever-changing, so please just e-mail me and ask me about anything in particular you want to do.

Parts I, II-1 and II-2 are already 100% complete. Everything else is an varying stages of completion (most 0%, some between 25% and 80%). I'll handle the glossary and credits (just tell me how you want to be credited). If you write something that contains a Glossary link, please include that Glossary entry.

I'd prefer ODT, (X)HTML, or Docbook (in that order) files if possible, but I'm not picky as long as I can read and copy the text from the file.
Also, PLEASE include screenshots (even if they are in a non-English language). I will recreate any non-english screenshots for the English version of the documentation (provided you don't have too many screenshots, in which case I might drop some of them). I'd also like some volunteers to translate the documentation (and make new screenshots). stoeptegel has already agreed to make a Dutch translation, but all other languages are a problem.

Thanks,

Alex
grouchyolddude
Registered Member
Posts
4
Karma
0

anything ever developed?

Tue Mar 11, 2008 3:37 am
.. with this. :oops:
I'm a newbie, triying to understand terms and settings ect.
"chunks, swarms, peers, requests, upload slots,"
I understaand the 'basic p2p" process, but I could sure use some reading.. :?
stoeptegel
Registered Member
Posts
1075
Karma
0

Tue Mar 11, 2008 1:19 pm
Yeah, we need to get this out soon, it has been taking too long already...
Knut
Registered Member
Posts
79
Karma
0

Tue Mar 11, 2008 8:33 pm
lengau wrote:Parts I, II-1 and II-2 are already 100% complete. Everything else is an varying stages of completion (most 0%, some between 25% and 80%).


Then send it to the developers so they can place it in SVN, or do it yourself, as soon as possible. Even unfinished it's infinite better than no documentation. Making it available will only help, it does not matter if it's not finished. And in SVN it's easier for others to add to it or make small modifications, helping you get it closer to finished.
stoeptegel
Registered Member
Posts
1075
Karma
0

Wed Mar 12, 2008 6:15 pm
No i already revised lengau's version, though that wasn' t finished yet. Currently bassmadrigal is busy with it, but i am getting more and more time currently, so i expect that i can help with the doc soon again.


Bookmarks



Who is online

Registered users: Bing [Bot], Google [Bot], Yahoo [Bot]