KDEEdu/Language/KVocDocumentPlanningJuly2014Temporary
| Under Construction |
|---|
| This is a new page, currently under construction! |
Individual Requirements
The following section is for planning the requirements of a replacement for KVTML2. It is divided by application.
Each application is divided into File Format, API and Editor requirements. For current File Format requirements I listed the tags from the http://edu.kde.org/kvtml/kvtml2.dtd http://edu.kde.org/kvtml/kvtml2.dtd] I knew to be used. Editor requirements are to explore the possibility of a common editor widget.
Each of those is divided into current and future requirements. The current requirements are to determine what portions of KVTML2, KEduVocDocument and its associated API are not in use. Future requirements are each application's wishes for the future.
Kanagram
File Format
Current
Future
API
Current
Future
Editor
Current
Future
Artikulate
Artikulate currently uses its own XML based file format, but the mid-term plan is to switch to a common format. The specification for the currently used file format is here:
File Format Requirements
Requirements
- association of file with one language (the language for that the pronunciation should be trained)
- string filed for text in training language
- (optional) string field for text in learner's language/English + i18n integration
- pronunciation symbols
- one sound file per string
- EITHER internal editing states OR special editing file format (like: a phrase is translated into the course' language, but a recording is missing)
- association to blueprint/skeleton file
Key Differences to KVTML
- the file format provides a skeleton specification: skeletons are blueprint like files that can be used to create and later synchronize changes for courses of different languages
- learning statistics are not saved within the file format: there is a learner-library that encapsulates learner, learning goals, and the corresponding statistics data
- downloaded course files are not meant to be changed/edited, but to be updated (in particular, system wide installation is provided)
Editor
Current
Future
Parley
File Format
Current
Used Tags
Parley uses almost every tag that is parsed from the kvtml2 file so this section is not very useful
- information.generator
- information.title
- information.author
- information.comment
- identifiers - 2 or more
- indentifier.name
- indentifier.locale
- identifier.comment
- indentifier.article
- indentifier.article.definite
- indentifier.article.indefinite
- indentifier.personalpronouns
- indentifier.personalpronouns.singular
- indentifier.personalpronouns.dual
- indentifier.personalpronouns.plural
- indentifier.personalpronouns.tense
- firstperson
- secondperson
- thirdpersonmale
- thirdpersonfemale
- thirdpersonneutralcommon
- tenses
- tense
- lessons
- wordtypes
- specialwordtype hardcoded as (noun|noun/male|noun/female|noun/neutral|verb|adjective|adverb)
- inpractice
- entry
- entries
- translation
- text
- comment
- pronunciation
- example
- paraphrase
- falsefriend
- antonym
- synonym
- multiplechoice
- image
- sound
- comparison
- absolute
- comparative
- superlative
- conjugation
- tense
- singular
- dual
- plural
- choice
- grade
- currentgrade
- count
- errorcount
- date
- containerentry is used indirectly via inheritence of lessons and wordtype so it is not a requirement
Features
- Header Information
- Per language identifier information to setup locale, articles (definite and indefinite hardcoded) and pronouns (first, second and third person, single, dual and plural hardcoded)
- A list of tenses
- Two nesting containers: word type and lessons
- A marker for special hardcoded wordtypes
- Entries with up to 1 translation per language identifier
- Each translation can have an image, a sound and several types of text attachments
- Each translation can have up to 5 special sets (synonym, antonym, false friends, multiple choice, comparison) attached
- Each translation can be a verb with an attached conjugation
- Each translation can have a grade consisting of (currentgrade, count, errorcount, date)
Future
- ids are alphanumeric so they can be a) human meaningful b) stable if words/lessons/grades are in different locations.
API
Current
Future
Editor
Current
- supports 2 or more languages
- supports 1 root lesson
- supports nested lessons
Future
Currently Unused
These features of the current format appear to be unused
File Format
- information.category
- identifier.identifiertype - never parsed in kvocdoc
- identifier.sizehint - never parsed in kvocdoc
- entry.sizehint - never parsed in kvocdoc
- leitnerboxes - never used in Parley
- deactivated - never parsed in kvocdoc
API
Cumulative Requirements
File Format
API
Editor
Further Reading
The following projects can be interesting for designing a container file format for language learning files: