[ktouch] doc: Update/proofread KTouch docbooks for kf5

Burkhard Lück lueck at hube-lueck.de
Thu Nov 3 10:51:22 UTC 2016


Git commit 1c5373cbb14dbd5c9c2efa388f2b353286afa621 by Burkhard Lück.
Committed on 03/11/2016 at 10:50.
Pushed by lueck into branch 'master'.

Update/proofread KTouch docbooks for kf5

handbook:
  bump date+releaseinfo
  fix some menu strings
  use link to fundamentals for Help menu
manpage:
  bump date+releaseinfo
  update options
  use education instead of edutainment
  add kf5options + qt5options
add some icon pngs
REVIEW:129310

M  +-    --    doc/Icon-arrow-left.png
M  +-    --    doc/Icon-arrow-right.png
M  +-    --    doc/Icon-configure.png
M  +-    --    doc/Icon-go-home.png
M  +9    -6    doc/index.docbook
M  +17   -13   doc/man-ktouch.1.docbook

http://commits.kde.org/ktouch/1c5373cbb14dbd5c9c2efa388f2b353286afa621

diff --git a/doc/Icon-arrow-left.png b/doc/Icon-arrow-left.png
index d2ff752..e099a26 100644
Binary files a/doc/Icon-arrow-left.png and b/doc/Icon-arrow-left.png differ
diff --git a/doc/Icon-arrow-right.png b/doc/Icon-arrow-right.png
index b6f4f48..c441e06 100644
Binary files a/doc/Icon-arrow-right.png and b/doc/Icon-arrow-right.png differ
diff --git a/doc/Icon-configure.png b/doc/Icon-configure.png
index e6215f0..20a34f6 100644
Binary files a/doc/Icon-configure.png and b/doc/Icon-configure.png differ
diff --git a/doc/Icon-go-home.png b/doc/Icon-go-home.png
index dc82da9..f81a578 100644
Binary files a/doc/Icon-go-home.png and b/doc/Icon-go-home.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 2fb59c8..819653b 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -51,8 +51,8 @@
 
 <legalnotice>&FDLNotice;</legalnotice>
 
-<date>2015-09-27</date>
-<releaseinfo>&ktouch; 2.3.0 (Applications 15.12)</releaseinfo>
+<date>2016-11-02</date>
+<releaseinfo>Applications 16.12</releaseinfo>
 
 <abstract>
 <para>&i18n-ktouch; is a program for learning to touch type.  &i18n-ktouch;
@@ -110,7 +110,7 @@ at the keyboard all the time to find the right keys which slows you down a lot.
 <sect2>
 <title>Features</title>
 
-<para>In its current version, &i18n-ktouch; 2.2 has quite a number of
+<para>In its current version, &i18n-ktouch; has quite a number of
 features, such as:</para>
 <itemizedlist>
 <listitem><simpara>Ships with dozens different courses in many
@@ -228,7 +228,7 @@ On some platforms, especially on &Microsoft; &Windows;, automatic keyboard layou
 detection is not available. In that case you have to click on the <inlinemediaobject>
 <imageobject> <imagedata fileref="Icon-configure.png" format="PNG"/>
 </imageobject> </inlinemediaobject> button in the toolbar, select <guisubmenu>
-Choose Keyboard Layout...</guisubmenu> submenu and choose the name of keyboard
+Configure Keyboard...</guisubmenu> submenu and choose the name of keyboard
 layout or some keyboard layout which is similar to yours. If your keyboard is
 not included, you can define your own keyboard layout yourself, see <xref
 linkend="create_layouts"/>.
@@ -468,7 +468,7 @@ with some actions
 </varlistentry>
 
 <varlistentry>
-<term><guimenuitem>Configure keyboard layout...</guimenuitem></term>
+<term><guimenuitem>Configure Keyboard...</guimenuitem></term>
 <listitem><para>A shortcut to the &systemsettings;
 module to configure the keyboard settings. Useful to prepare for training on
 a different keyboard layout.
@@ -485,7 +485,10 @@ with a submenu to select &i18n-ktouch;'s keyboard layout manually.
 
 </variablelist>
 
-&help.menu.documentation;
+<para>
+&i18n-ktouch; has the common &kde; <guimenu>Help</guimenu> menu item, for more information read the section
+about the <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.
+</para>
 </sect3>
 
 <sect3 id="configuration_dialog">
diff --git a/doc/man-ktouch.1.docbook b/doc/man-ktouch.1.docbook
index dabfa5b..d887f68 100644
--- a/doc/man-ktouch.1.docbook
+++ b/doc/man-ktouch.1.docbook
@@ -9,8 +9,8 @@
 <author><firstname>Ben</firstname><surname>Burton</surname>
 <contrib>KTouch man page.</contrib>
 <email>bab at debian.org</email></author>
-<date>2015-09-27</date>
-<releaseinfo>&ktouch; 2.3.0 (Applications 15.12)</releaseinfo>
+<date>2016-11-02</date>
+<releaseinfo>&ktouch; 2.3.0 (Applications 16.12)</releaseinfo>
 <productname>KDE Applications</productname>
 </refentryinfo>
 
@@ -27,8 +27,8 @@
 <refsynopsisdiv>
 <cmdsynopsis>
 <command>ktouch</command>
-<group choice="opt"><option>URL</option></group>
-<arg choice="opt">options</arg>
+<group choice="opt"><option>--resource-editor</option></group>
+<group choice="opt"><option>-I --import-path</option> <replaceable>path</replaceable></group>
 </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -40,7 +40,7 @@ the keyboard with associated keys to press.</para>
 <para>&ktouch; helps you learn to touch type by providing you with text to
 train on, and adjusts to different levels depending on how good you are.  It
 can display which key to press next, and correct finger to use.</para>
-<para>This application is part of the official &kde; edutainment
+<para>This application is part of the official &kde; education
 module.</para>
 </refsect1>
 
@@ -48,27 +48,31 @@ module.</para>
 <title>KTouch Options</title>
 <variablelist>
 <varlistentry>
-<term><option>--opengl</option></term>
-<listitem><para>Use a QGLWidget for the viewport.</para></listitem>
-</varlistentry>
-<varlistentry>
 <term><option>--resource-editor</option></term>
 <listitem><para>Launch the course and keyboard layout editor.</para></listitem>
 </varlistentry>
+<varlistentry>
+<term><option>-I --import-path</option> <replaceable>path</replaceable></term>
+<listitem><para>Prepend the path to the list of QML import paths.</para></listitem>
+</varlistentry>
 </variablelist>
 
 </refsect1>
 
 <refsect1>
 <title>See Also</title>
-<para>More detailed user documentation is available from <ulink
+<simplelist>
+<member>More detailed user documentation is available from <ulink
 url="help:/ktouch">help:/ktouch</ulink>
 (either enter this <acronym>URL</acronym> into &konqueror;, or run
 <userinput><command>khelpcenter</command>
-<parameter>help:/ktouch</parameter></userinput>).</para>
+<parameter>help:/ktouch</parameter></userinput>).</member>
+<member>kf5options(7)</member> <!-- only for application with a GUI-->
+<member>qt5options(7)</member> <!-- only for application with a GUI-->
+<member>There is also further information available at the <ulink
+url="http://edu.kde.org/ktouch/">&kde; education website</ulink>.</member>
+</simplelist>
 
-<para>There is also further information available at the <ulink
-url="http://edu.kde.org/ktouch/">&kde; edutainment website</ulink>.</para>
 </refsect1>
 
 <refsect1>


More information about the kde-doc-english mailing list