[kde-doc-english] [artikulate/KDE/4.13] doc: Add basic information about phrase editing.

Andreas Cord-Landwehr cordlandwehr at kde.org
Sun Mar 16 17:07:14 UTC 2014


Git commit 9ece8a6a599d101d4ff8c5a2fd663aade2a3d86c by Andreas Cord-Landwehr.
Committed on 16/03/2014 at 17:05.
Pushed by cordlandwehr into branch 'KDE/4.13'.

Add basic information about phrase editing.

A  +-    --    doc/editor-apply.png
A  +-    --    doc/editor-cancel.png
M  +44   -2    doc/index.docbook

http://commits.kde.org/artikulate/9ece8a6a599d101d4ff8c5a2fd663aade2a3d86c

diff --git a/doc/editor-apply.png b/doc/editor-apply.png
new file mode 100644
index 0000000..0f3153c
Binary files /dev/null and b/doc/editor-apply.png differ
diff --git a/doc/editor-cancel.png b/doc/editor-cancel.png
new file mode 100644
index 0000000..6ce7961
Binary files /dev/null and b/doc/editor-cancel.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index f24a6f9..b961612 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -419,7 +419,7 @@ In either case, you will be presented the list of units of the course, where you
 <sect2>
 <title>Edit a Unit</title>
 <para>
-When opening a unit for edit, you will see the list of its phrases (see below).
+When opening a unit for editing, you will see the list of its phrases (see below).
 One line of this list contains the following information:
 <orderedlist>
     <listitem><para>edit button: open this phrase for edit</para></listitem>
@@ -435,10 +435,52 @@ One line of this list contains the following information:
 <imageobject>
 <imagedata fileref="editor-screenshot-unit.png" format="PNG" />
 </imageobject>
-<caption><para>Editor view with list of phrases inside a unit.</para></caption>
+<caption><para>Editor View: list of phrases within a unit.</para></caption>
 </mediaobject>
 </screenshot>
 </sect2>
+
+<sect2>
+<title>Edit a Phrase</title>
+<para>
+When opening a phrase for editing, you will see the phrase editor as shown below.
+This edit interface contains the following elements:
+<itemizedlist>
+    <listitem><para>the phrase text as it will be shown in the trainer</para></listitem>
+    <listitem><para>the original phrase, if using a course skeleton</para></listitem>
+    <listitem><para>the edit state of the phrase</para></listitem>
+    <listitem><para>the type/length of the phrase</para></listitem>
+    <listitem><para>recording buttons for the native speaker recordings</para></listitem>
+    <listitem><para>buttons to denote intersting phonemes of the phrase (currently not used in training mode)</para></listitem>
+</itemizedlist>
+You can close the phrase editing interface with
+<inlinemediaobject><imageobject>
+<imagedata fileref="editor-apply.png" format="PNG"/></imageobject>
+</inlinemediaobject>
+to accept the changes you did, or with
+<inlinemediaobject><imageobject>
+<imagedata fileref="editor-cancel.png" format="PNG"/></imageobject>
+</inlinemediaobject>
+to discard your changes.
+</para>
+<screenshot>
+<screeninfo>Editor View: editing view for a phrase.</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="editor-screenshot-editing-phrase.png" format="PNG" />
+</imageobject>
+<caption><para>Editor View: editing view for a phrase.</para></caption>
+</mediaobject>
+</screenshot>
+</sect2>
+
+<sect2>
+<title>Update from Course Prototype</title>
+<para>
+If the currently edited course derives from a skeleton, then the course can be updated from the latest version of the skeleton by using the button <guilabel>Update from Course Prototype</guilabel> at the top left of the screen.
+This button is deactivated if the course is not derived from a course skeleton.
+</para>
+</sect2>
 </sect1>
 </chapter>
 



More information about the kde-doc-english mailing list