Latest revision as of 17:38, 4 July 2013

Artikulate Technical Guide

Artikulate is a learning software that helps improving pronunciation skills. This is a manual for developers and course data contributors.

Preparing Your System

Currently, it is necessary for every contributor to compile and install Artikulate by herself/himself. But having an up to date KDE SC system in your distribution (KDE SC >= 4.10) makes this rather simple.

Details on how to set up your build system and how to set up environment variables to run Artikulate please see:

Preparing Your System

Course material and workflow explained

For details on course material and the general workflow of contribution please refer to:

course material and workflow

Editing course skeletons

For details on how to edit or add course skeletons to Artikulate please refer to:

How To Edit Course Skeletons

Editing language courses

For details on how to edit or add new language courses please refer to:

How To Edit Language Courses

@@ Line 1: / Line 1: @@
-= Artikulate =
+= Artikulate Technical Guide=
-Artikulate is a learning software that helps improving pronunciation skills.
+Artikulate is a learning software that helps improving pronunciation skills. This is a manual for developers and course data contributors.
-==Artikulate manual==
+==Preparing Your System==
-===What a contributor can do===
+Currently, it is necessary for every contributor to compile and install Artikulate by herself/himself. But having an up to date KDE SC system in your distribution (KDE SC >= 4.10) makes this rather simple.
-In construction
-===Buliding Artikulate from sources===
-Currently it is necessary for every contributor to compile and install Artikulate by herself/himself. Having an up to date KDE SC system in your distribution (KDE SC >= 4.10) makes this rather simple.
-Details on how to set up your build system and how to set up environment variables to run Artikulate please refer to:
+Details on how to set up your build system and how to set up environment variables to run Artikulate please see:
-* [[Projects/Edu/Artikulate/BuildAndInstall|How To Build Artikulate from sources]]
+* [[Projects/Edu/Artikulate/BuildAndInstall|Preparing Your System]]
-===Getting data files (artikulate-data repository)===
-All course material for Artikulate can be found and edited in the following repository:
-* https://projects.kde.org/projects/playground/edu/artikulate-data
-For licensing information please see:
-* https://projects.kde.org/projects/playground/edu/artikulate-data/repository/revisions/master/entry/README
-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 [mailto:[email protected]].
-==== Using the Repository Directly in Artikulate ====
+==Course material and workflow explained==
-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.
-===Course material and workflow explained===
 For details on course material and the general workflow of contribution please refer to:
 * [[Projects/Edu/Artikulate/CourseMaterial|course material and workflow]]
-===Editing course skeletons===
+==Editing course skeletons==
 For details on how to edit or add course skeletons to Artikulate please refer to:
 * [[Projects/Edu/Artikulate/CourseSkeletons|How To Edit Course Skeletons]]
-===Editing language courses===
+==Editing language courses==
 For details on how to edit or add new language courses please refer to:
 * [[Projects/Edu/Artikulate/LanguageCourses|How To Edit Language Courses]]