[kde-doc-english] [PATCH] Fix kget documentation. Bug no. 97374

Rohan Dhruva rohandhruva at gmail.com
Sat Mar 3 14:25:44 CET 2007


Hello,

This is my first attempt at improving any KDE documentation. I have
not completed my work, I have just lightly modified kget's
index.docbook to make the language more formal. Please tell me where
have I gone wrong. I will update the menu reference subsequently.
Thanks a lot. As this is my first mail, please also tell me if my
etiquette is not right. E.g. the subject line, the method of attaching
patch. The patch is against
http://websvn.kde.org/branches/KDE/3.5/kdenetwork/doc/kget/index.docbook?view=log

Regards,
-- 
Rohan Dhruva

kget.patch:

--- index.docbook       2007-03-03 18:46:18.000000000 +0000
+++ index.docbook.new   2007-03-03 18:46:16.000000000 +0000
@@ -41,8 +41,7 @@

 <abstract>
 <para>
-&kget; allows you to group downloads. In some cases, &kget; can resume these
-downloads even if you shutdown your computer before the downloads
have completed.
+  &kget; is KDE's download manager, designed to be very user friendly.
 </para>
 </abstract>

@@ -56,12 +55,13 @@

 </bookinfo>

-<chapter id="introduction">
-<title>Introduction</title>
-
+<chapter id="quickstart">
+<title>Quick-start Guide</title>
 <para>
-To download a document or package, drag and drop the &URL; on to &kget;.
-
+  <orderedlist>
+    <listitem>Start KGet.</listitem>
+    <listitem>Drag and drop the required &URL; in the &kget; window.</listitem>
+  </orderedlist>
 </para>
 </chapter>

@@ -71,9 +71,10 @@
 <sect1 id="kget-features">
 <title>&kget; Tutorial</title>

-<para>Here is a brief tutorial that uses some of the features of &kget;. Below
-are three software packages that are to be downloaded. Suppose you want to
-download the middle one first and then the top and bottom ones second.
+<para>Here is a brief tutorial that demonstrates some of the features of
+  &kget;. The screenshot shows three software packages that are to be
+  downloaded. This tutorial lists the procedure to download the middle
+  one first, and then the other two.
 </para>


@@ -88,8 +89,8 @@

 <listitem>
 <para>
-Click on the top entry with the &LMB;. Hold down the &Ctrl; key and click on
-the bottom entry. &kget; should look similar to this:
+Click on the first file with the &LMB;. Hold down the &Ctrl; key and click on
+the bottom most file. The &kget; window should look similar to this:

 <screenshot>
 <screeninfo>Screenshot of Kget</screeninfo>
@@ -108,7 +109,7 @@
 </listitem>

 <listitem><para>
-Click on the delay button to prevent these items from being
+Click on the "Delay" button to prevent the files from being
 downloaded.
 </para></listitem>

@@ -129,14 +130,14 @@
 </para></listitem>

 <listitem><para>
-Put &kget; back online by unchecking
+Put &kget; back into the online mode by unchecking
 <menuchoice><guimenu>Options</guimenu><guimenuitem>Offline
-Mode</guimenuitem></menuchoice> and &kget; will download the middle item.
+Mode</guimenuitem></menuchoice>. &kget; will start  downloading the
middle file.
 </para></listitem>

 <listitem><para>
-Click on the top item, hold down the &Shift; key and click on the
bottom item. &kget;
-should look like this:
+Click on the top item, hold down the &Shift; key and click on the bottom item.
+The&kget; window should look like this:
 <screenshot>
 <screeninfo>Screenshot of Kget</screeninfo>
        <mediaobject>



More information about the kde-doc-english mailing list