[kde-doc-english] [kwordquiz] doc: Update KWordquiz handbook to 16.04

Burkhard Lück lueck at hube-lueck.de
Tue May 10 19:31:45 UTC 2016


Git commit 14ca2661e997717a85b42ddd41f1dee722fcf3cc by Burkhard Lück.
Committed on 10/05/2016 at 19:30.
Pushed by lueck into branch 'master'.

Update KWordquiz handbook to 16.04

proofreading
remove entity package, not used any more
bump date + releaseinfo
fix download path
add missing shortcut
remove commented go-to-menu and obsolete option Rows/Columns
replace Settings + Help menu with link to fundamentals
remove chapter id=faq
remove appendix

new screenshots
comment chapter tutor mode, not yet ported to kf5
REVIEW:127859

M  +22   -303  doc/index.docbook
M  +-    --    doc/kwordquiz-icon.png
M  +-    --    doc/kwq-dlg-characters.png
M  +-    --    doc/kwq-dlg-configure-appearance.png
M  +-    --    doc/kwq-dlg-configure-characters.png
M  +-    --    doc/kwq-dlg-configure-editor.png
M  +-    --    doc/kwq-dlg-configure-general.png
M  +-    --    doc/kwq-dlg-configure-quiz.png
M  +-    --    doc/kwq-dlg-languages.png
M  +-    --    doc/kwq-dlg-print-exam.png
M  +-    --    doc/kwq-dlg-print-flashcard.png
M  +-    --    doc/kwq-dlg-print-list.png
M  +-    --    doc/kwq-dlg-print-type.png
M  +-    --    doc/kwq-editor.png
M  +-    --    doc/kwq-flashcard.png
M  +-    --    doc/kwq-multiple.png
M  +-    --    doc/kwq-qanda.png
M  +-    --    doc/kwq-tutor-popup-minimalistic.png
M  +-    --    doc/kwq-tutor-popup-native.png
M  +-    --    doc/kwq-tutor-settings.png
M  +-    --    doc/kwq-tutor-shortcuts.png
M  +-    --    doc/kwq-tutor-welcome.png

http://commits.kde.org/kwordquiz/14ca2661e997717a85b42ddd41f1dee722fcf3cc

diff --git a/doc/index.docbook b/doc/index.docbook
index f3cf695..58001b3 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -2,7 +2,6 @@
 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
  "dtd/kdedbx45.dtd" [
   <!ENTITY kappname "&kwordquiz;">
-  <!ENTITY package "kdeedu">
   <!ENTITY % addindex "IGNORE">
   <!ENTITY % English "INCLUDE"><!-- change language only here -->
 ]>
@@ -35,8 +34,8 @@
 <legalnotice>&FDLNotice;</legalnotice>
 
 
-<date>2011-08-20</date>
-<releaseinfo>0.9.1 (&kde; 4.7)</releaseinfo>
+<date>2016-05-07</date>
+<releaseinfo>0.9.2 (Applications 16.04)</releaseinfo>
 
 <abstract>
 <para>
@@ -168,14 +167,9 @@ You can have several files open at the same time and easily copy or move entries
     <listitem>
       <para>
         <action>Downloads</action> new vocabularies. Downloaded vocabularies 
-	can be found in <filename class="directory">$KDEHOME/share/apps/kvtml</filename> 
-	directory. <envar>$KDEHOME</envar> is usually
-	a hidden folder in your Home folder called <filename class="directory">.kde</filename> 
-	or <filename class="directory">.kde4</filename>
-	<!-- "$KDEHOME" is not always defined eg not in kubuntu 11.04
-	<filename class="directory">`kde4-config - -localprefix`/share/apps/kvtml</filename> 
-	(without whitespace between '- -') is afaik always defined
-	  -->
+	can be found in <filename class="directory">$XDG_DATA_HOME/kvtml</filename> 
+	directory. <envar>$XDG_DATA_HOME</envar> is usually
+	a hidden folder in your Home folder called <filename class="directory">.local</filename>.
       </para>
     </listitem>
   </varlistentry>
@@ -200,6 +194,9 @@ You can have several files open at the same time and easily copy or move entries
   <varlistentry>
     <term>
       <menuchoice>
+        <shortcut>
+          <keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo>
+        </shortcut>
         <guimenu>File</guimenu>
         <guimenuitem>Save As...</guimenuitem>
       </menuchoice>
@@ -454,83 +451,7 @@ You can have several files open at the same time and easily copy or move entries
 
 </variablelist>
 </sect1>
-<!--
-<sect1 id="go-to-menu">
-<title>The <guimenu>Go to</guimenu> Menu</title>
-
-<variablelist>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <shortcut>
-          <keycombo action="simul"><keycap>F6</keycap></keycombo>
-        </shortcut>
-        <guimenu>Go to</guimenu>
-        <guimenuitem>Editor</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Activate</action> the vocabulary <link linkend="editor">editor</link>
-      </para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <shortcut>
-          <keycombo action="simul"><keycap>F7</keycap></keycombo>
-        </shortcut>
-        <guimenu>Go to</guimenu>
-        <guimenuitem>Flashcard</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Start</action> a <link linkend="flashcard">flashcard</link> session
-      </para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <shortcut>
-          <keycombo action="simul"><keycap>F8</keycap></keycombo>
-        </shortcut>
-        <guimenu>Go to</guimenu>
-        <guimenuitem>Multiple Choice</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Start</action> a <link linkend="multiple">multiple choice</link> quiz
-      </para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <shortcut>
-          <keycombo action="simul"><keycap>F9</keycap></keycombo>
-        </shortcut>
-        <guimenu>Go to</guimenu>
-        <guimenuitem>Question & Answer</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Start</action> a <link linkend="question-and-answer">question & answer</link> quiz
-      </para>
-    </listitem>
-  </varlistentry>
 
-</variablelist>
-</sect1>
--->
 <sect1 id="vocabulary-menu">
 <title>The Vocabulary Menu</title>
 
@@ -595,25 +516,6 @@ You can have several files open at the same time and easily copy or move entries
     </listitem>
   </varlistentry>
 
-<!-- Not in 0.9.1
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <shortcut>
-          <keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
-        </shortcut>
-        <guimenu>Vocabulary</guimenu>
-        <guimenuitem>Rows/Columns...</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Specify</action> the number of rows in the vocabulary, or define the height of selected rows or the width of selected columns. Displays a <link linkend="dlg-rows-columns">dialog</link>.
-      </para>
-    </listitem>
-  </varlistentry>
--->
-
  <varlistentry>
     <term>
       <menuchoice>
@@ -658,7 +560,7 @@ Note that the menu names will change to reflect the column titles of the current
     <term>
       <menuchoice>
         <guimenu>Mode</guimenu>
-        <guimenuitem>Column 1 -> Column 2 In Order</guimenuitem>
+        <guimenuitem>1 Column 1 -> Column 2 In Order</guimenuitem>
       </menuchoice>
     </term>
     <listitem>
@@ -672,7 +574,7 @@ Note that the menu names will change to reflect the column titles of the current
     <term>
       <menuchoice>
         <guimenu>Mode</guimenu>
-        <guimenuitem>Column 2 -> Column 1 In Order</guimenuitem>
+        <guimenuitem>2 Column 2 -> Column 1 In Order</guimenuitem>
       </menuchoice>
     </term>
     <listitem>
@@ -686,7 +588,7 @@ Note that the menu names will change to reflect the column titles of the current
     <term>
       <menuchoice>
         <guimenu>Mode</guimenu>
-        <guimenuitem>Column 1 -> Column 2 Randomly</guimenuitem>
+        <guimenuitem>3 Column 1 -> Column 2 Randomly</guimenuitem>
       </menuchoice>
     </term>
     <listitem>
@@ -700,7 +602,7 @@ Note that the menu names will change to reflect the column titles of the current
     <term>
       <menuchoice>
         <guimenu>Mode</guimenu>
-        <guimenuitem>Column 2 -> Column 1 Randomly</guimenuitem>
+        <guimenuitem>4 Column 2 -> Column 1 Randomly</guimenuitem>
       </menuchoice>
     </term>
     <listitem>
@@ -714,7 +616,7 @@ Note that the menu names will change to reflect the column titles of the current
     <term>
       <menuchoice>
         <guimenu>Mode</guimenu>
-        <guimenuitem>Column 1 <-> Column 2 Randomly</guimenuitem>
+        <guimenuitem>5 Column 1 <-> Column 2 Randomly</guimenuitem>
       </menuchoice>
     </term>
     <listitem>
@@ -868,8 +770,13 @@ Note that the menu names will change to reflect the column titles of the current
 </variablelist>
 </sect1>
 
-<sect1 id="settings-menu">
-<title>The Settings Menu</title>
+<sect1 id="settings-help-menu">
+<title>The Settings and Help Menu</title> 
+<para>Apart from the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
+menu items described in the the <ulink url="help:/fundamentals/ui.html#menus-settings"
+>Settings Menu</ulink> and <ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink>
+of the &kde; Fundamentals &kwordquiz; this additional menu entry:
+</para>
 
 <variablelist>
   <varlistentry>
@@ -886,128 +793,9 @@ Note that the menu names will change to reflect the column titles of the current
     </listitem>
   </varlistentry>
 
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <guimenu>Settings</guimenu>
-        <guisubmenu>Toolbars</guisubmenu>
-        <guimenuitem>Main Toolbar</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Toggle</action> the Main Toolbar
-      </para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <guimenu>Settings</guimenu>
-        <guisubmenu>Toolbars</guisubmenu>
-        <guimenuitem>Quiz</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Toggle</action> the Quiz Toolbar
-      </para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <guimenu>Settings</guimenu>
-        <guisubmenu>Toolbars</guisubmenu>
-        <guimenuitem>Special Characters</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Toggle</action> the Special Characters Toolbar
-      </para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <guimenu>Settings</guimenu>
-        <guimenuitem>Show Statusbar</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Toggle</action> the Statusbar
-      </para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <guimenu>Settings</guimenu>
-        <guimenuitem>Configure Shortcuts...</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Configure</action> the keyboard keys you use to access the different actions.
-      </para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <guimenu>Settings</guimenu>
-        <guimenuitem>Configure Toolbars...</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Configure</action> the items you want to put in the toolbar
-      </para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <guimenu>Settings</guimenu>
-        <guimenuitem>Configure Notifications...</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Configure</action> notifications for certain events in &kwordquiz;
-      </para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <menuchoice>
-        <guimenu>Settings</guimenu>
-        <guimenuitem>Configure &kwordquiz;...</guimenuitem>
-      </menuchoice>
-    </term>
-    <listitem>
-      <para>
-        <action>Configure</action> preferences for the vocabulary editor and the quizzes. Displays a <link linkend="dlg-config-editor">dialog</link>.
-      </para>
-    </listitem>
-  </varlistentry>
-
 </variablelist>
 </sect1>
 
-<sect1 id="help-menu">
-<title>The Help Menu</title>
-&help.menu.documentation;
-</sect1>
 </chapter>
 
 <chapter id="main-window">
@@ -1351,7 +1139,7 @@ The 'Fill-in-the-blank' features can be turned on and off in the Configuration d
 </screenshot>
 
 </chapter>
-
+<!--FIXME not ported to kf5
 <chapter id="tutor">
 <title>The Tutor Mode</title>
 
@@ -1475,7 +1263,7 @@ The 'Fill-in-the-blank' features can be turned on and off in the Configuration d
    </variablelist>
 </para>
 </chapter>
-
+-->
 
 <chapter id="dialogs">
 <title>Dialogs</title>
@@ -1639,57 +1427,6 @@ Use this dialog to select any special character you want to associate with the c
 
 </sect1>
 
-<!-- Not in 0.9.1
-<sect1 id="dlg-rows-columns">
-<title>Rows/Columns</title>
-<para>You can open this dialog from the menubar with <menuchoice><guimenu>Vocabulary</guimenu><guimenuitem>Rows/Columns...</guimenuitem></menuchoice></para>
-<screenshot>
-  <screeninfo>Rows/Columns</screeninfo>
-  <mediaobject>
-    <imageobject>
-      <imagedata fileref="kwq-dlg-rowscolumns.png" format="PNG" />
-    </imageobject>
-    <textobject>
-      <phrase>Rows/Columns</phrase>
-    </textobject>
-  </mediaobject>
-</screenshot>
-<para>
-Use this dialog to specify the number of rows you want in the vocabulary. You can also adjust the width (in pixels) of the selected columns and the height (in pixels) of the selected rows. Select <guibutton>OK</guibutton> to make your changes or <guibutton>Cancel</guibutton> to discard any changes.
-</para>
-<warning>
-<para>
-Specifying a number of rows lower than what currently is in the vocabulary may lead to loss of data.
-</para>
-</warning>
-
-</sect1>
--->
-</chapter>
-
-<chapter id="faq">
-<title>Questions and Answers</title>
-
-&reporting.bugs;
-&updating.documentation;
-<!--
-<qandaset id="faqlist">
-
-  <qandaentry>
-    <question>
-      <para>
-        Can I combine several vocabularies to one.
-      </para>
-    </question>
-    <answer>
-      <para>
-        Yes, when you select <menuchoice><guimenu>File</guimenu><guimenuitem>Open...</guimenuitem></menuchoice> you can highlight more than one file in the dialog. By default they will be opened in separate windows, but if you select the check box <guibutton>Join selected files into one list</guibutton>, then the data in all files will be combined into one new list.
-      </para>
-    </answer>
-  </qandaentry>
-
-</qandaset>
--->
 </chapter>
 
 <chapter id="credits">
@@ -1714,24 +1451,6 @@ Documentation copyright 2003-2008 Peter B. Hedlund <email>peter.hedlund at kdemail.
 
 </chapter>
 
-<appendix id="installation">
-<title>Installation</title>
-
-<sect1 id="getting-kwordquiz">
-<title>How to obtain &kwordquiz;</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/kwordquiz-icon.png b/doc/kwordquiz-icon.png
index f1b49d0..a279daa 100644
Binary files a/doc/kwordquiz-icon.png and b/doc/kwordquiz-icon.png differ
diff --git a/doc/kwq-dlg-characters.png b/doc/kwq-dlg-characters.png
index 1d81177..e7d5d01 100644
Binary files a/doc/kwq-dlg-characters.png and b/doc/kwq-dlg-characters.png differ
diff --git a/doc/kwq-dlg-configure-appearance.png b/doc/kwq-dlg-configure-appearance.png
index b5a1cf5..56a8127 100644
Binary files a/doc/kwq-dlg-configure-appearance.png and b/doc/kwq-dlg-configure-appearance.png differ
diff --git a/doc/kwq-dlg-configure-characters.png b/doc/kwq-dlg-configure-characters.png
index 01f4ad6..1c7833c 100644
Binary files a/doc/kwq-dlg-configure-characters.png and b/doc/kwq-dlg-configure-characters.png differ
diff --git a/doc/kwq-dlg-configure-editor.png b/doc/kwq-dlg-configure-editor.png
index 5ae2b99..2b917ef 100644
Binary files a/doc/kwq-dlg-configure-editor.png and b/doc/kwq-dlg-configure-editor.png differ
diff --git a/doc/kwq-dlg-configure-general.png b/doc/kwq-dlg-configure-general.png
index 4ac7df2..a4f1137 100644
Binary files a/doc/kwq-dlg-configure-general.png and b/doc/kwq-dlg-configure-general.png differ
diff --git a/doc/kwq-dlg-configure-quiz.png b/doc/kwq-dlg-configure-quiz.png
index 8c3d471..302761c 100644
Binary files a/doc/kwq-dlg-configure-quiz.png and b/doc/kwq-dlg-configure-quiz.png differ
diff --git a/doc/kwq-dlg-languages.png b/doc/kwq-dlg-languages.png
index 4ef3758..4799a8b 100644
Binary files a/doc/kwq-dlg-languages.png and b/doc/kwq-dlg-languages.png differ
diff --git a/doc/kwq-dlg-print-exam.png b/doc/kwq-dlg-print-exam.png
index a12dce7..a53b22b 100644
Binary files a/doc/kwq-dlg-print-exam.png and b/doc/kwq-dlg-print-exam.png differ
diff --git a/doc/kwq-dlg-print-flashcard.png b/doc/kwq-dlg-print-flashcard.png
index affc755..07cbefd 100644
Binary files a/doc/kwq-dlg-print-flashcard.png and b/doc/kwq-dlg-print-flashcard.png differ
diff --git a/doc/kwq-dlg-print-list.png b/doc/kwq-dlg-print-list.png
index 9e74243..9100500 100644
Binary files a/doc/kwq-dlg-print-list.png and b/doc/kwq-dlg-print-list.png differ
diff --git a/doc/kwq-dlg-print-type.png b/doc/kwq-dlg-print-type.png
index 4175b4b..4a2f074 100644
Binary files a/doc/kwq-dlg-print-type.png and b/doc/kwq-dlg-print-type.png differ
diff --git a/doc/kwq-editor.png b/doc/kwq-editor.png
index ab1e0e7..b2be7b2 100644
Binary files a/doc/kwq-editor.png and b/doc/kwq-editor.png differ
diff --git a/doc/kwq-flashcard.png b/doc/kwq-flashcard.png
index 7fbff2b..f75a5b6 100644
Binary files a/doc/kwq-flashcard.png and b/doc/kwq-flashcard.png differ
diff --git a/doc/kwq-multiple.png b/doc/kwq-multiple.png
index a18b2be..175fda4 100644
Binary files a/doc/kwq-multiple.png and b/doc/kwq-multiple.png differ
diff --git a/doc/kwq-qanda.png b/doc/kwq-qanda.png
index c23a135..ab31ec6 100644
Binary files a/doc/kwq-qanda.png and b/doc/kwq-qanda.png differ
diff --git a/doc/kwq-tutor-popup-minimalistic.png b/doc/kwq-tutor-popup-minimalistic.png
index acbfa5e..9920fd9 100644
Binary files a/doc/kwq-tutor-popup-minimalistic.png and b/doc/kwq-tutor-popup-minimalistic.png differ
diff --git a/doc/kwq-tutor-popup-native.png b/doc/kwq-tutor-popup-native.png
index 0e890a9..21f2e48 100644
Binary files a/doc/kwq-tutor-popup-native.png and b/doc/kwq-tutor-popup-native.png differ
diff --git a/doc/kwq-tutor-settings.png b/doc/kwq-tutor-settings.png
index b8f85c8..73d8893 100644
Binary files a/doc/kwq-tutor-settings.png and b/doc/kwq-tutor-settings.png differ
diff --git a/doc/kwq-tutor-shortcuts.png b/doc/kwq-tutor-shortcuts.png
index 32d6ad6..951e500 100644
Binary files a/doc/kwq-tutor-shortcuts.png and b/doc/kwq-tutor-shortcuts.png differ
diff --git a/doc/kwq-tutor-welcome.png b/doc/kwq-tutor-welcome.png
index e254d25..fc2c99f 100644
Binary files a/doc/kwq-tutor-welcome.png and b/doc/kwq-tutor-welcome.png differ


More information about the kde-doc-english mailing list