KDEEdu/Artikulate/Todo: Difference between revisions

From KDE Community Wiki
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Bugs ==
* https://bugs.kde.org/buglist.cgi?product=Artikulate


== Release 0.2 ==
== Tasks for Release 0.3 ==
=== Blockers ===
=== Review Issues ===
* broken Trainer mode: for now replace it with information that no Trainer mode is included
* <del>exclude Units without recordings</del>
* <del>after downloading GHNS course, ask learner if it shall be added to favorite languages</del>
* <del>set default qt-multimedia recording source (e.g. "alsa:default"), currently only updated once the config dialog was opened</del>
* <del>due to gstreamer <-> pulseaudio deadlock problem, suggest using QTMULTIMEDIA</del>
* <del>show graph when clicking "finish training"</del>
* <del>user icon should be adjustable (male/female/arbitrary image)</del>
* course resources: update resources at GHNS


=== Release Goals ===
=== Release Goals ===
* <s>provide-GHNS-interface</s>
* '''Handbook''':
* <s>provide training interface</s>
** document editor
* <s>on demand parsing of courses</s>
** update handbook that currently no statistics are stored
* <s>provide at least one language course</s>
* <del>count required learner recordings for statistics, instead of clicks on "Retry Later"</del>
* <s>provide QtGStreamer backend</s>
 
== Release 0.4 ==
=== Blockers ===
* https://bugs.kde.org/show_bug.cgi?id=328418 - missing reload after imported course
=== Release Goals ===
* revisit interaction design
* revisit interaction design
** training interactions
** training interactions
Line 21: Line 23:
** <del>profile based "last learned language"</del>
** <del>profile based "last learned language"</del>
** save statistics
** save statistics
* switch to QtGStreamer as main recording backend
* <del>switch to QtGStreamer as main recording backend</del>
** optionally already allow sound recording with Simon
* provide at least two language courses
* provide at least two language courses
* complete user documentation
* complete user documentation
* use 5-boxes learning approach
** explain overview page
** <del>explain training page</del>
** explain statistics page
* use Leitner box learning for training
* system wide course installation (aka class mode)
* system wide course installation (aka class mode)
* testing color schemes
* test with different color schemes
* port to kqmlgraphplugin
* <del>port to kqmlgraphplugin</del>
** update to QtGStreamer 1.0 (once released)
** <del>upstream padding property for graphs</del>
** upstream axis description property
* minor UI todos
* minor UI todos
** training page
** training page
*** add scrollbars for long texts (not fitting into bubble)
*** <del>add scrollbars for long texts (not fitting into bubble): https://git.reviewboard.kde.org/r/114627/</del>
*** use font settings from configuration dialog
*** use font settings from configuration dialog
*** use background for progress bar phrase information
*** add background for progress bar phrase information
** overview page
** overview page
*** give info if no course/units are available in language
*** give info if no course/units are available in language
* handle corrupt course XML files gracefully in editor
* use language names/translations from kdelibs


=== Minor Goals (candidates for later) ===
= Unspecified Target ToDos =
* port XML parsing to Xmlstream
 
== Later ==
* soundwave diagrams / visual comparison
* kvtml file export
 
== Release Steps ==
# write release notes
# create tarballs and upload them
# notify sysadmins
# add links to community wiki page
# write notification mail
 
= Documentation =
== Proposal for Contributor Documentation ==
 
1. STARTING WITH ARTIKULATE
* 1.1. General Intro: describing what a contributor can do...
* 1.2. Downloading the source files.
* 1.3. Compiling and installing Artikulate.
* 1.4. Getting data files (artikulate-data repository).
 
2. EDITING COURSE SKELETONS
* 2.1. Adding new course skeletons to Artikulate.
* 2.2. Adding units to a course skeleton.
* 2.3 . Adding phrases to units.
 
3. EDITING LANGUAGE COURSES
* 3.1. Creating a new language course from a course skeleton.
* 3.2. Translating phrases to a language.
* 3.3. Adding recordings for phrases.
* 3.4. Tagging phonemes for phrases.
* 3.5. Adding new languages to Artikulate/ Creating new phonology.
 
== Proposal for User Documentation ==
 
1. INTRODUCTION
* 1.1. What is Artikulate.
* 1.2. How Artikulate aims to help the user.
 
2. BEGINNING WITH ARTIKULATE
* 2.1. Choosing a Language.
* 2.2. Choosing a Course.
* 2.3. Choosing a training unit.
 
3. SCENARIO TRAINING UNITS
* 3.1. What is a Scenario Training Unit.
* 3.2. Contents of a Scenario Unit.
* 3.3. What it aims at.
 
4. PHONEME TRAINING UNITS
* 4.1. What is Phoneme Training Units.
* 4.2. What it aims at.
 
5. PROCEEDING WITH THE TRAINING
* 5.1. Playing the recording provided.
* 5.2. Recording one's own voice.
* 5.3. Evaluating oneself for every phrase.
* 5.4. Cumulative Evaluation.
 
= Coding =
== General User Interface ==
== General User Interface ==
=== Course Editor ===
=== Course Editor ===
Line 104: Line 52:
* when scrolled down, cannot open phrase for edit
* when scrolled down, cannot open phrase for edit
* enable the user to add new course skeletons
* enable the user to add new course skeletons
 
* kvtml file export
* optionally use Simon recording backend


=== Trainer ===
=== Trainer ===
[[File:ArtikulateTrainerMockup.jpg]]
* soundwave diagrams / visual comparison
 
* create concept for trainer UI (when training a unit)
* missing scrollbars for language list
* missing scrollbars for course list
* missing scrollbars for unit list


== Core ==
== Core ==
* set input volume (change at config dialog has no effect currently)
* set input volume (change at config dialog has no effect currently)
* port XML parsing to Xmlstream
= Release Steps =
# write release notes
# create tarballs and upload them
# notify sysadmins
# add links to community wiki page
# write notification mail

Latest revision as of 17:45, 15 March 2014

Bugs

Tasks for Release 0.3

Review Issues

  • exclude Units without recordings
  • after downloading GHNS course, ask learner if it shall be added to favorite languages
  • set default qt-multimedia recording source (e.g. "alsa:default"), currently only updated once the config dialog was opened
  • due to gstreamer <-> pulseaudio deadlock problem, suggest using QTMULTIMEDIA
  • show graph when clicking "finish training"
  • user icon should be adjustable (male/female/arbitrary image)
  • course resources: update resources at GHNS

Release Goals

  • Handbook:
    • document editor
    • update handbook that currently no statistics are stored
  • count required learner recordings for statistics, instead of clicks on "Retry Later"
  • revisit interaction design
    • training interactions
    • overview screen (previously called start/home screen)
  • use learner profiles
    • profile based "last learned language"
    • save statistics
  • switch to QtGStreamer as main recording backend
  • provide at least two language courses
  • complete user documentation
    • explain overview page
    • explain training page
    • explain statistics page
  • use Leitner box learning for training
  • system wide course installation (aka class mode)
  • test with different color schemes
  • port to kqmlgraphplugin
    • update to QtGStreamer 1.0 (once released)
    • upstream padding property for graphs
    • upstream axis description property
  • minor UI todos
    • training page
    • overview page
      • give info if no course/units are available in language
  • handle corrupt course XML files gracefully in editor
  • use language names/translations from kdelibs

Unspecified Target ToDos

General User Interface

Course Editor

  • broken layout for phrases with several text lines
  • when scrolled down, cannot open phrase for edit
  • enable the user to add new course skeletons
  • kvtml file export
  • optionally use Simon recording backend

Trainer

  • soundwave diagrams / visual comparison

Core

  • set input volume (change at config dialog has no effect currently)
  • port XML parsing to Xmlstream

Release Steps

  1. write release notes
  2. create tarballs and upload them
  3. notify sysadmins
  4. add links to community wiki page
  5. write notification mail
Retrieved from "https://community.kde.org/index.php?title=KDEEdu/Artikulate/Todo&oldid=36942"