(introduce phrase state cycle) |
(→Course related to Skeleton) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 29: | Line 29: | ||
There are two cycles for phrases. The simple one appears, when creating a course without a skeleton file. Then, a phrase gets created and possible is updated. | There are two cycles for phrases. The simple one appears, when creating a course without a skeleton file. Then, a phrase gets created and possible is updated. | ||
+ | ===== Course related to Skeleton ===== | ||
The case when working with skeleton files is quite different. Here, the phrases are created (in English) in the skeleton file and then imported, translated and recorded for the course. Yet, when updating a phrase in the skeleton, possibly the phrases in the course file may also need updates. To approach this, we have the following update cycle for phrases: | The case when working with skeleton files is quite different. Here, the phrases are created (in English) in the skeleton file and then imported, translated and recorded for the course. Yet, when updating a phrase in the skeleton, possibly the phrases in the course file may also need updates. To approach this, we have the following update cycle for phrases: | ||
# phrase is changed in skeleton file | # phrase is changed in skeleton file | ||
# course is updated from skeleton: i18n-text strings of phrases also get updated | # course is updated from skeleton: i18n-text strings of phrases also get updated | ||
− | # if i18n-text strings are changed, the phrase's editorState is set to " | + | # if i18n-text strings are changed, the phrase's editorState is set to "unknown" |
− | # the editor must check whether the change requires changes to the translated string in the course file or not (in the latter case, the editor can set the state to " | + | # the editor must check whether the change requires changes to the translated string in the course file or not (in the latter case, the editor can set the state to "completed"), in the former case the following steps must be performed: |
− | ## the editor translates the string updates the phoneme tags and removes the recording, editorState will be set to " | + | ## the editor translates the string updates the phoneme tags and removes the recording, editorState will be set to "translated" |
− | ## once a native speaker recorded the phrase, the state is set to " | + | ## once a native speaker recorded the phrase, the state is set to "completed" |
+ | |||
+ | ===== States ===== | ||
+ | * '''unknown:''' phrase is either untranslated or original phrase string from skeleton got updated and it must be checked whether phrase in course file still fits to it | ||
+ | * '''translated:''' phrase is translated and all set phoneme tags are correct (possibly none are set), but a recording is missing | ||
+ | * '''completed:''' phrase is translated, tagged and a recording exists |
Training of pronunciation skills is performed with courses. A course is associated with a specific language, consists of different units and each unit is given by a sequence of phrases in different lengths. To ease the further explanation we defined a list of specific notions:
All course material for Artikulate can be found and edited in the following repository:
For licensing information please see:
You can contribute to this repository with a KDE Developer account. But also if you do not have a KDE Developer account (yet), we are happy to get contributions. For those cases, please write to the mailing list [1].
To work with Artikulate directly at this course material repository please create a local copy of it (git clone). Then start Artikulate and go to the dialog "Settings" (top-left button) and select the root folder of your local copy in that dialog as your course material repository. After restarting Artikulate the training mode as well as the editor mode operate only on the data from the repository.
The following life cycles explain how courses and the contained phrases shall be created and updated.
There are two cycles for phrases. The simple one appears, when creating a course without a skeleton file. Then, a phrase gets created and possible is updated.
The case when working with skeleton files is quite different. Here, the phrases are created (in English) in the skeleton file and then imported, translated and recorded for the course. Yet, when updating a phrase in the skeleton, possibly the phrases in the course file may also need updates. To approach this, we have the following update cycle for phrases: