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.
-== Course and Language Contributions ==
+==Preparing Your System==
-We seek for non-coding contributions in essentially two areas. One area is the creation of language specifications, the other area is the contribution of courses and native speaker recordings:
+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.
-* [[Projects/Edu/Artikulate/LanguageSpecifications|How to create and submit language specifications]]
-* [[Projects/Edu/Artikulate/CourseMaterial|How to create and submit course material]]
-== Setup Artikulate from Sources ==
+Details on how to set up your build system and how to set up environment variables to run Artikulate please see:
-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.
+* [[Projects/Edu/Artikulate/BuildAndInstall|Preparing Your System]]
-Details on how to set up your build system and how to set up environment variables to run Artikulate please refer to:
+==Course material and workflow explained==
-* [[Projects/Edu/Artikulate/BuildAndInstall|How To Build Artikulate from sources]]
+For details on course material and the general workflow of contribution please refer to:
+* [[Projects/Edu/Artikulate/CourseMaterial|course material and workflow]]
-==Artikulate manual==
+==Editing course skeletons==
-===Getting started wit Artikulate===
+For details on how to edit or add course skeletons to Artikulate please refer to:
-====What a contributor can do====
+* [[Projects/Edu/Artikulate/CourseSkeletons|How To Edit Course Skeletons]]
-In construction
-====Downloading the source files====
-In construction
-====Compiling and installing Artikulate====
-In construction
-====Getting data files (artikulate-data repository)====
-In construction
-===Editing course skeletons===
+==Editing language courses==
-====Adding new course skeletons====
+For details on how to edit or add new language courses please refer to:
-In construction
+* [[Projects/Edu/Artikulate/LanguageCourses|How To Edit Language Courses]]
-====Adding units to a course skeleton====
-In construction
-====Adding phrases to units====
-In construction
-===Editing language courses===
-====Creating a new language course from a course skeleton====
-In construction
-====Translating phrases to a language====
-In construction
-====Adding recordings for phrases====
-In construction
-====Tagging phonemes for phrases====
-In construction
-====Adding new languages/ Creating new phonology====
-In construction