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.

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:

• course-format specification

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)

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

1. information.generator
2. information.title
3. information.author
4. information.comment
5. identifiers - 2 or more
7. indentifier.name
8. indentifier.locale
9. identifier.comment
10. indentifier.article
11. indentifier.article.definite
12. indentifier.article.indefinite
13. indentifier.personalpronouns
14. indentifier.personalpronouns.singular
15. indentifier.personalpronouns.dual
16. indentifier.personalpronouns.plural
17. indentifier.personalpronouns.tense
18. firstperson
19. secondperson
20. thirdpersonmale
21. thirdpersonfemale
22. thirdpersonneutralcommon
24. tenses
25. tense
27. lessons
28. wordtypes
30. specialwordtype hardcoded as (noun|noun/male|noun/female|noun/neutral|verb|adjective|adverb)
32. inpractice
34. entry
35. entries
37. translation
38. text
39. comment
40. pronunciation
41. example
42. paraphrase
44. falsefriend
45. antonym
46. synonym
47. multiplechoice
49. image
50. sound
52. comparison
53. absolute
54. comparative
55. superlative
57. conjugation
58. tense
59. singular
60. dual
61. plural
62. choice
64. grade
65. currentgrade
66. count
67. errorcount
68. date
70. containerentry is used indirectly via inheritence of lessons and wordtype so it is not a requirement

Features

1. Header Information
2. Per language identifier information to setup locale, articles (definite and indefinite hardcoded) and pronouns (first, second and third person, single, dual and plural hardcoded)
3. A list of tenses
4. Two nesting containers: word type and lessons
5. A marker for special hardcoded wordtypes
6. Entries with up to 1 translation per language identifier
7. Each translation can have an image, a sound and several types of text attachments
8. Each translation can have up to 5 special sets (synonym, antonym, false friends, multiple choice, comparison) attached
9. Each translation can be a verb with an attached conjugation
10. Each translation can have a grade consisting of (currentgrade, count, errorcount, date)

Future

1. ids are alphanumeric so they can be a) human meaningful b) stable if words/lessons/grades are in different locations.

Editor

Current

1. supports 2 or more languages
2. supports 1 root lesson
3. supports nested lessons

Currently Unused

These features of the current format appear to be unused

File Format

1. information.category
2. identifier.identifiertype - never parsed in kvocdoc
3. identifier.sizehint - never parsed in kvocdoc
4. entry.sizehint - never parsed in kvocdoc
5. leitnerboxes - never used in Parley
6. deactivated - never parsed in kvocdoc