[kget] doc: Update KGet docbook
Burkhard Lück
null at kde.org
Tue Jan 2 16:57:46 UTC 2018
Git commit 7b10693c0fd0c1e564340d80ebee6837abaa4b91 by Burkhard Lück.
Committed on 02/01/2018 at 16:57.
Pushed by lueck into branch 'master'.
Update KGet docbook
remove unused entities
bump date + releaseinfo
proofread + update
remove appendix installation
new screenshots
Differential Revision: https://phabricator.kde.org/D8960
M +- -- doc/file.png
M +- -- doc/import_link.png
M +77 -155 doc/index.docbook
M +- -- doc/kget_Advanced.png
M +- -- doc/kget_Appearance.png
M +- -- doc/kget_Network.png
M +- -- doc/kget_Web_Interface.png
M +- -- doc/kget_drop_target.png
M +- -- doc/kget_group.png
M +- -- doc/kget_groups.png
M +- -- doc/kget_plugins.png
M +- -- doc/kget_transfer_hostory.png
M +- -- doc/kget_verification.png
M +- -- doc/metalink0.png
M +- -- doc/metalink1.png
M +- -- doc/metalink2.png
M +- -- doc/metalink3.png
A +- -- doc/pluginsettings.png
https://commits.kde.org/kget/7b10693c0fd0c1e564340d80ebee6837abaa4b91
diff --git a/doc/file.png b/doc/file.png
index f48f2c63..3bcd9f5f 100644
Binary files a/doc/file.png and b/doc/file.png differ
diff --git a/doc/import_link.png b/doc/import_link.png
index bbb779e2..85504a17 100644
Binary files a/doc/import_link.png and b/doc/import_link.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 42d64f4f..fce49c9c 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,9 +1,6 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
<!-- Define an entity for your application if it is not part of KDE CVS -->
- <!ENTITY kget "<application>KGet</application>">
- <!ENTITY kappname "&kget;"><!-- replace kget here do *not* replace kappname-->
- <!ENTITY package "kdenetwork">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
@@ -30,14 +27,14 @@
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
-<date>2010-07-17</date>
-<releaseinfo>2.4.93 (&kde; 4.5)</releaseinfo>
+<date>2017-11-21</date>
+<releaseinfo>2.95.0 (Applications 17.12)</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>
-&kget; is the download manager for &kde;
+&kget; is an advanced download manager by &kde;
</para>
</abstract>
@@ -127,20 +124,6 @@ Right click on the drop target to see the options.
</para>
</listitem>
</varlistentry>
-<!-- no longer in 4.5
- <varlistentry>
- <term>
- <menuchoice>
- <guimenuitem>Show Drop Target</guimenuitem>
- </menuchoice>
- </term>
- <listitem>
- <para>
- <action>Uncheck this box to make the &kget; Drop Target go away.</action>
- </para>
- </listitem>
- </varlistentry>
--->
<varlistentry>
<term>
<menuchoice>
@@ -214,19 +197,7 @@ Right click on the drop target to see the options.
<varlistentry>
<term>
<menuchoice>
- <guimenuitem>Show splashscreen</guimenuitem>
- </menuchoice>
- </term>
- <listitem>
- <para>
- <action>Check this check box to show a splashscreen before startup.</action>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <menuchoice>
- <guimenuitem>Show drop target</guimenuitem>
+ <guimenuitem>Use Drop Target</guimenuitem>
</menuchoice>
</term>
<listitem>
@@ -247,20 +218,6 @@ Right click on the drop target to see the options.
</para>
</listitem>
</varlistentry>
-<!-- what is this?
- <varlistentry>
- <term>
- <menuchoice>
- <guimenuitem>Enable popup tooltip</guimenuitem>
- </menuchoice>
- </term>
- <listitem>
- <para>
- <action>???</action>
- </para>
- </listitem>
- </varlistentry>
--->
</variablelist>
</para>
</sect1>
@@ -325,20 +282,6 @@ Right click on the drop target to see the options.
</para>
</listitem>
</varlistentry>
-
- <varlistentry>
- <term>
- <menuchoice>
- <guimenuitem>Number of downloads</guimenuitem>
- </menuchoice>
- </term>
- <listitem>
- <para>
- <action>You can set the maximum simultaneous downloads using this box.</action>
- </para>
- </listitem>
- </varlistentry>
-
<varlistentry>
<term>
<menuchoice>
@@ -381,7 +324,7 @@ Right click on the drop target to see the options.
<varlistentry>
<term>
<menuchoice>
- <guimenuitem>Reconnect on Error or Broken Connection</guimenuitem>
+ <guimenuitem>Reconnect on Broken Connection</guimenuitem>
</menuchoice>
</term>
<listitem>
@@ -459,35 +402,22 @@ You will need to enter the username and password to get access.
</mediaobject>
</screenshot>
-<para>Using the two methods <guilabel>Checksums</guilabel> and <guilabel>Signature</guilabel>
+<para>Using the two methods <guilabel>Automatic checksums verification</guilabel> and <guilabel>Signature</guilabel>
you can verify your downloads. You just have to tick the Automatic verification check box.</para>
</sect1>
-<sect1 id='Advanced'>
-<title>Advanced</title>
- <para>Modify Advanced Options.</para>
- <screenshot>
- <screeninfo>&kget; Advanced Options</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="kget_Advanced.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>&kget; Advanced Options</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-
+<sect1 id="Integration">
+<title>Integration</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
- <guimenuitem>Disable confirmation dialogs (less verbosity)</guimenuitem>
+ <guimenuitem>Use as download manager for Konqueror</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
- <action>Disables the confirmation dialogs</action>, which causes verbosity.
+ <action>You can set &kget; as your download manager for &konqueror;.</action>
</para>
</listitem>
</varlistentry>
@@ -495,39 +425,43 @@ you can verify your downloads. You just have to tick the Automatic verification
<varlistentry>
<term>
<menuchoice>
- <guimenuitem>Enable system tray icon</guimenuitem>
+ <guimenuitem>Monitor clipboard for files to download</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
- <action>This check box enables the &kget; system tray icon.</action>
+ You can turn on this feature that asks if you want to download &URL;s copied into the clipboard.
</para>
</listitem>
</varlistentry>
+ </variablelist>
+</sect1>
- <varlistentry>
- <term>
- <menuchoice>
- <guimenuitem>Execute action after all downloads have been finished</guimenuitem>
- </menuchoice>
- </term>
- <listitem>
- <para>
- <action> Check this box to enable Quitting &kget; after all downloads have finished.
- At startup you can choose to Restore Download state. Such as Stop All downloads/ Start All downloads.</action>
- </para>
- </listitem>
- </varlistentry>
+<sect1 id="Advanced">
+<title>Advanced</title>
+ <para>Modify Advanced Options.</para>
+ <screenshot>
+ <screeninfo>&kget; Advanced Options</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="kget_Advanced.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>&kget; Advanced Options</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <variablelist>
<varlistentry>
<term>
<menuchoice>
- <guimenuitem>History backend</guimenuitem>
+ <guimenuitem>Enable system tray icon</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
- <action>You can choose your history backend as Sqlite or Xml.</action>
+ <action>This check box enables the &kget; system tray icon.</action>
</para>
</listitem>
</varlistentry>
@@ -535,12 +469,13 @@ you can verify your downloads. You just have to tick the Automatic verification
<varlistentry>
<term>
<menuchoice>
- <guimenuitem>Use as download manager for Konqueror</guimenuitem>
+ <guimenuitem>Execute action after all downloads have been finished</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
- <action>You can set &kget; as your download manager for &konqueror;.</action>
+ <action> Check this box to enable Quitting &kget; after all downloads have finished.
+ At startup you can choose to Restore Download state. Such as Stop All downloads/ Start All downloads.</action>
</para>
</listitem>
</varlistentry>
@@ -548,14 +483,12 @@ you can verify your downloads. You just have to tick the Automatic verification
<varlistentry>
<term>
<menuchoice>
- <guimenuitem>Monitor clipboard for files to download</guimenuitem>
+ <guimenuitem>History backend</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
-<!--
- <action>Blank</action>
--->
+ <action>You can choose your history backend as Sqlite or Xml.</action>
</para>
</listitem>
</varlistentry>
@@ -575,6 +508,24 @@ you can verify your downloads. You just have to tick the Automatic verification
</variablelist>
</sect1>
+<sect1 id="Plugins">
+<title>Plugins</title>
+ <screenshot>
+ <screeninfo>&kget; Plugins Options</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="kget_plugins.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>&kget; Plugins Options</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ <para>On this page you can select the transfer plugins to be used. Use the <inlinemediaobject><imageobject><imagedata fileref="pluginsettings.png" format="PNG"/>
+</imageobject></inlinemediaobject> button to change the default settings for a plugin.</para>
+
+ </sect1>
+
</chapter>
<chapter id="Main_Window">
@@ -593,7 +544,7 @@ you can verify your downloads. You just have to tick the Automatic verification
</screenshot>
<sect1 id='File_Options'>
-<title>The <guimenu>File</guimenu> Menu</title>
+<title>The File Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
@@ -606,39 +557,6 @@ you can verify your downloads. You just have to tick the Automatic verification
<listitem><para><action>Add a new file to download</action></para></listitem>
</varlistentry>
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo>
-</shortcut>
-<guimenu>File</guimenu>
-<guimenuitem>Import Transfers...</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Loads a *.kgt, *.metalink, *.meta4 or *.torrent file.</action></para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>E</keycap></keycombo>
-</shortcut>
-<guimenu>File</guimenu>
-<guimenuitem>Export Transfers List...</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Export the highlighted links to a .kgt file, to be loaded later.</action></para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
-</shortcut>
-<guimenu>File</guimenu>
-<guimenuitem>Export Transfers as Plain Text...</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Exports the links being downloaded as plain text.</action></para></listitem>
-</varlistentry>
-
<varlistentry>
<term><menuchoice>
<shortcut>
@@ -663,6 +581,28 @@ you can verify your downloads. You just have to tick the Automatic verification
There is also a text box to filter out results.</action></para></listitem>
</varlistentry>
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo>
+</shortcut>
+<guimenu>File</guimenu>
+<guimenuitem>Import Transfers...</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>Loads a <filename class="extension">*.kgt</filename>, <filename class="extension">*.metalink</filename>, <filename class="extension">*.meta4</filename> or <filename class="extension">*.torrent</filename> file.</action></para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+<keycombo action="simul">&Ctrl;<keycap>E</keycap></keycombo>
+</shortcut>
+<guimenu>File</guimenu>
+<guimenuitem>Export Transfers List...</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>Export the highlighted links to a <filename class="extension">.kgt</filename> file, to be loaded later.</action></para></listitem>
+</varlistentry>
+
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
@@ -783,24 +723,6 @@ You can manage your history here, including filter and clear the history. </acti
</chapter>
-<appendix id="installation">
-<title>Installation</title>
-
-<sect1 id="getting-KGet">
-<title>How to obtain &kget;</title>
-
-&install.intro.documentation;
-
-</sect1>
-
-<sect1 id="compilation">
-<title>Compilation and installation</title>
-
-&install.compile.documentation;
-
-</sect1>
-</appendix>
-
&documentation.index;
</book>
diff --git a/doc/kget_Advanced.png b/doc/kget_Advanced.png
index 0d69b054..70bea83a 100644
Binary files a/doc/kget_Advanced.png and b/doc/kget_Advanced.png differ
diff --git a/doc/kget_Appearance.png b/doc/kget_Appearance.png
index 09c30c3b..9c867f25 100644
Binary files a/doc/kget_Appearance.png and b/doc/kget_Appearance.png differ
diff --git a/doc/kget_Network.png b/doc/kget_Network.png
index 6ae8640d..93b4988c 100644
Binary files a/doc/kget_Network.png and b/doc/kget_Network.png differ
diff --git a/doc/kget_Web_Interface.png b/doc/kget_Web_Interface.png
index 1d791227..f32e5b92 100644
Binary files a/doc/kget_Web_Interface.png and b/doc/kget_Web_Interface.png differ
diff --git a/doc/kget_drop_target.png b/doc/kget_drop_target.png
index 824494c1..b85ec23a 100644
Binary files a/doc/kget_drop_target.png and b/doc/kget_drop_target.png differ
diff --git a/doc/kget_group.png b/doc/kget_group.png
index 670a7782..46b6a348 100644
Binary files a/doc/kget_group.png and b/doc/kget_group.png differ
diff --git a/doc/kget_groups.png b/doc/kget_groups.png
index d7cb5122..ab884613 100644
Binary files a/doc/kget_groups.png and b/doc/kget_groups.png differ
diff --git a/doc/kget_plugins.png b/doc/kget_plugins.png
index e6d4266c..426359b2 100644
Binary files a/doc/kget_plugins.png and b/doc/kget_plugins.png differ
diff --git a/doc/kget_transfer_hostory.png b/doc/kget_transfer_hostory.png
index 325e7370..1e65b722 100644
Binary files a/doc/kget_transfer_hostory.png and b/doc/kget_transfer_hostory.png differ
diff --git a/doc/kget_verification.png b/doc/kget_verification.png
index 04568da8..8990a6e5 100644
Binary files a/doc/kget_verification.png and b/doc/kget_verification.png differ
diff --git a/doc/metalink0.png b/doc/metalink0.png
index 102bfefb..9d563017 100644
Binary files a/doc/metalink0.png and b/doc/metalink0.png differ
diff --git a/doc/metalink1.png b/doc/metalink1.png
index 1efde3e8..6d57f91d 100644
Binary files a/doc/metalink1.png and b/doc/metalink1.png differ
diff --git a/doc/metalink2.png b/doc/metalink2.png
index 9ee2f499..cf2141a2 100644
Binary files a/doc/metalink2.png and b/doc/metalink2.png differ
diff --git a/doc/metalink3.png b/doc/metalink3.png
index 72004bfe..5d9d2e89 100644
Binary files a/doc/metalink3.png and b/doc/metalink3.png differ
diff --git a/doc/pluginsettings.png b/doc/pluginsettings.png
new file mode 100644
index 00000000..4b2c14d5
Binary files /dev/null and b/doc/pluginsettings.png differ
More information about the kde-doc-english
mailing list