Commit a0d8feec authored by Andreas Cord-Landwehr's avatar Andreas Cord-Landwehr
Browse files

Update docbook.

parent 0af81107
doc/editor-set-repository.png

57.9 KB | W: | H:

doc/editor-set-repository.png

46 KB | W: | H:

doc/editor-set-repository.png
doc/editor-set-repository.png
doc/editor-set-repository.png
doc/editor-set-repository.png
  • 2-up
  • Swipe
  • Onion skin
doc/first-steps-3-download-course.png

105 KB | W: | H:

doc/first-steps-3-download-course.png

65.4 KB | W: | H:

doc/first-steps-3-download-course.png
doc/first-steps-3-download-course.png
doc/first-steps-3-download-course.png
doc/first-steps-3-download-course.png
  • 2-up
  • Swipe
  • Onion skin
doc/first-steps-4-start-training.png

63.2 KB | W: | H:

doc/first-steps-4-start-training.png

80.5 KB | W: | H:

doc/first-steps-4-start-training.png
doc/first-steps-4-start-training.png
doc/first-steps-4-start-training.png
doc/first-steps-4-start-training.png
  • 2-up
  • Swipe
  • Onion skin
......@@ -31,18 +31,18 @@
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright><year>2014</year><holder>The &artikulate; Developers</holder></copyright>
<copyright><year>2014-2015</year><holder>The &artikulate; Developers</holder></copyright>
<date>2015-09-27</date>
<releaseinfo>&artikulate; 0.5.0 (Applications 15.12)</releaseinfo>
<releaseinfo>&artikulate; 0.6.0 (Applications 15.12)</releaseinfo>
<legalnotice>&FDLNotice;</legalnotice>
<abstract>
<para>
&artikulate; is a pronunciation trainer, which helps in improving and perfecting pronunciation skills.
Learners train their pronunciation by recording their own voices and comparing them to native speaker recordings.
&artikulate; is part of the &kde; Education Project.
&artikulate; is a pronunciation trainer, designed to help in improving and perfecting pronunciation skills.
Learners train their pronunciation skills by recording their own voices and comparing those recording to native speaker recordings.
&artikulate; is part of the &kde; Education project.
</para>
</abstract>
......@@ -53,7 +53,6 @@ Learners train their pronunciation by recording their own voices and comparing t
<keyword>course</keyword>
<keyword>unit</keyword>
<keyword>phrase</keyword>
<keyword>learner profile</keyword>
</keywordset>
</bookinfo>
......@@ -61,73 +60,35 @@ Learners train their pronunciation by recording their own voices and comparing t
<chapter id="introduction">
<title>Introduction</title>
<para>
&artikulate; is a pronunciation trainer that helps improving and perfecting a learner's pronunciation skills for a foreign language.
For this, it provides courses with native speaker recordings of the target language for download.
The learner download courses for selected language, selects a group of phrases, starts to record her/his own voice when speaking the phrases himself/herself, and compares the results to the native speaker's recordings by listening to both.
&artikulate; is a pronunciation trainer for improving and perfecting pronunciation skills for a non-native language.
For this, &artikulate; provides courses created by native speakers, who recorded their own voices as comparison material.
A student can download these recordings in form of courses from the Internet.
The training then consists of iterative playing of a native speaker's recording of some phrase, recording the own voice, and comparing both until the result is good enough to proceed with the next phrase.
</para>
<sect1 id="introduction-concept">
<title>The Learning Concept</title>
<para>
The study concept of this language learning application is as follows.
By repeating and comparing own recordings of spoken phrases to the recordings of (a representative set of) native speakers, a learner can
<itemizedlist>
<listitem><para>identify weaknesses when speaking the foreign language and</para></listitem>
<listitem><para>adapt the pronunciation to coincide with the native speaker's pronunciation.</para></listitem>
</itemizedlist>
For best learning outcome, specifically designed courses for every supported language are necessary.
Those courses can concentrate on training special scenarios (like ordering food in a restaurant) but can also focus on learning how to pronounce difficult syllables and words of a particular language correctly.
The study concept of &artikulate; is based on honest self-assessment of the student.
A student trains several phrases in one training session.
For each such phase, first he/she plays the native speaker recording for the phrase and listens to it.
Then, by recording his/her own voice when attempting to repeat this phrase, we get a second recording.
The studen then can compare both recordings and either decides that the phrase is mastered or that another attempt is needed.
The provided courses provide trainings for special scenarios (like ordering food in a restaurant) but can also focus on learning how to pronounce difficult syllables and words of a particular language correctly.
</para>
</sect1>
<sect1 id="introduction-first-steps">
<title>First Steps in &artikulate;</title>
<para>
This chapter explains how to make the first steps in &artikulate;, especially how to create a learner identity, how to select a language and how to get native speaker recordings to start training.
</para>
<sect2>
<title>1. Create a Learner Identity</title>
<para>
For every learner, there has to be one learner identity that saves the learning progress.
This also allows multiple people to use &artikulate; on the same computer, each being able to have his/her private learning goals.
To create a learner identity, click on the <guilabel>Create Learner Identity</guilabel> button (if starting &artikulate; for the first time) or otherwise the button with the name of the currently selected learner identity at the top left of the window.
In the opening dialog, then select <guilabel>Create New Learner Identity</guilabel>.
You can edit your name with the <guilabel>Edit</guilabel> button and set a picture if you like.
</para>
<screenshot>
<screeninfo>Create a learner identity.</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="first-steps-1-create-profile.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</sect2>
<sect2>
<title>2. Select a Language</title>
<para>
Setting the training language(s) of a learner is done in the <guilabel>Favorite Languages</guilabel> tab by activating (clicking at) the languages.
The star symbol corresponding to each language will turn colored once it is selected.
Close the Learner Identity dialog by selecting your identity with <guilabel>Use Selected Identity</guilabel>.
Note that when downloading courses, the course language will automatically be activated for the currently selected learner identity.
This chapter explains how to make the first steps in &artikulate;.
</para>
<screenshot>
<screeninfo>Set favorite languages.</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="first-steps-2-set-language.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</sect2>
<sect2>
<title>3. Download a Language Course</title>
<title>1. Download a New Course</title>
<para>
For this tutorial, we assume that we would like to learn Polish and hence that we want to download a course for Polish.
You can download courses through <menuchoice><guimenu>File</guimenu> <guimenuitem>Download New Language Course</guimenuitem></menuchoice> or by clicking at the orange star at the top right.
You can download courses through <menuchoice><guimenu>File</guimenu> <guimenuitem>Download Courses</guimenuitem></menuchoice>.
If the menubar is not activated, you can open the <menuchoice><guimenu>File</guimenu></menuchoice> menu by clicking at the top-right button.
A download window will appear, listing the available languages provided by the &kde; Community.
You can sort through them using the order by functions at the right.
We download the Polish course by clicking on <guilabel>Install</guilabel>.
......@@ -143,10 +104,10 @@ We download the Polish course by clicking on <guilabel>Install</guilabel>.
</sect2>
<sect2>
<title>4. Start Training</title>
<title>2. Start Training</title>
<para>
Courses consist of multiple training units, each usually grouping a set of phrases according to a scenario.
Select one of the training units available at the left panel, and then click on <guilabel>Start Training</guilabel>.
They can be switched by using the combo boxes for language and course at the top boarder of the screen.
</para>
<screenshot>
<screeninfo>Select unit and start training.</screeninfo>
......@@ -159,46 +120,44 @@ Select one of the training units available at the left panel, and then click on
</sect2>
<sect2>
<title>Finish Training / Statistics </title>
<title>Finish Training</title>
<para>
After completing through all the phrases in a training unit, you will see a statistics screen for the completed training.
You can see how many tries it took for the various types of phrases.
The statistics screen is closed by click on the <guilabel>Finish Training</guilabel> button at the top right.
The training can be finished at any point by just closing the program.
</para>
</sect2>
</sect1>
</chapter>
<!--
<chapter id="screens">
<title>Screens</title>
<sect1 id="screens-training">
<title>The Training Screen</title>
<para>
The training view is the most important view in &artikulate;.
Whenever starting a training, this view is opened and will be presented until the training of the selected training unit is finished or the learner stops the training.
In the center of this screen, there are controls for playing a native speaker recording, the text of the corresponding phrase, and controls to record and playback the learner's own voice.
When a learner judges to be done with training the pronunciation of the current phrase, by clicking <guilabel>OK</guilabel> the current phrase is marked as done and a next phrase is selected.
Whenever starting a training, this view is opened and will be presented until the training of the selected training unit is finished or the student stops the training.
In the center of this screen, there are controls for playing a native speaker recording, the text of the corresponding phrase, and controls to record and playback the student's own voice.
When a student judges to be done with training the pronunciation of the current phrase, by clicking <guilabel>OK</guilabel> the current phrase is marked as done and a next phrase is selected.
Otherwise, when clicking on <guilabel>Retry Later</guilabel>, a next phrase is selected but the current phrase will be displayed later again.
</para>
<para>
For training the pronunciation of a current phrase, the learner shall first play the native speaker's recording by pressing at the <guilabel>Playback</guilabel> button at the left.
For training the pronunciation of a current phrase, the student shall first play the native speaker's recording by pressing at the <guilabel>Playback</guilabel> button at the left.
The next step is to press on the <guilabel>Record</guilabel> button and read the presented phrase aloud.
A further press on the <guilabel>Record</guilabel> button stops the recording and the recording can then be played with the corresponding <guilabel>Playback</guilabel> button.
By listening to both recordings, the learner shall judge if the phrase was pronounced correctly or not.
By listening to both recordings, the student shall judge if the phrase was pronounced correctly or not.
If it was pronounced correctly, clicking on <guilabel>OK</guilabel> marks the phrase as learned and proceeds with the next phrase.
Otherwise, if not yet satisfied with the recording, the learner either can retry recording by again clicking on <guilabel>Record</guilabel> or schedule the phrase for later training by clicking on <guilabel>Retry Later</guilabel>.
Otherwise, if not yet satisfied with the recording, the student either can retry recording by again clicking on <guilabel>Record</guilabel> or schedule the phrase for later training by clicking on <guilabel>Retry Later</guilabel>.
</para>
<para>
&artikulate;'s units are composed of a list of phrases of different lengths (words, expressions, sentences, and paragraphs).
A learner can see the current learning progress at the bottom when looking at <link linkend="screens-training-progressbar">the progress bar</link>.
A student can see the current learning progress at the bottom when looking at <link linkend="screens-training-progressbar">the progress bar</link>.
The progress bar also allows switching between phrases.
</para>
<para>
At any time, the learner can choose to stop training by clicking at the <guilabel>Finish</guilabel> button.
At any time, the student can choose to stop training by clicking at the <guilabel>Finish</guilabel> button.
</para>
<screenshot>
......@@ -291,7 +250,7 @@ The available types are:
</sect2>
</sect1>
</chapter>
-->
<chapter>
<title>Editor</title>
<para>
......@@ -407,7 +366,7 @@ It can be found at <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configur
</sect2>
</sect1>
<sect1>
<!--<sect1>TODO needs complete rewrite
<title>Edit a Course</title>
<para>
The editor can be started from the main menu with <menuchoice><guimenu>Mode</guimenu> <guimenuitem>Course Editor mode</guimenuitem></menuchoice>.
......@@ -483,7 +442,7 @@ If the currently edited course derives from a skeleton, then the course can be u
This button is deactivated if the course is not derived from a course skeleton.
</para>
</sect2>
</sect1>
</sect1>-->
</chapter>
......@@ -495,7 +454,7 @@ This button is deactivated if the course is not derived from a course skeleton.
</para>
<para>Program Copyright:</para>
<itemizedlist>
<listitem><para>Copyright 2013-2014 Andreas Cord-Landwehr</para></listitem>
<listitem><para>Copyright 2013-2015 Andreas Cord-Landwehr</para></listitem>
<listitem><para>Copyright 2013 Oindrila Gupta</para></listitem>
<listitem><para>Copyright 2013 Magdalena Konkiewitz</para></listitem>
<listitem><para>Copyright 2013-2014 Samikshan Bairagya</para></listitem>
......@@ -503,7 +462,7 @@ This button is deactivated if the course is not derived from a course skeleton.
<para>Documentation Copyright:</para>
<itemizedlist>
<listitem><para>Copyright 2014 Andreas Cord-Landwehr</para></listitem>
<listitem><para>Copyright 2014-2015 Andreas Cord-Landwehr</para></listitem>
</itemizedlist>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment