Warning, /education/libkeduvocdocument/keduvocdocument/Mainpage.dox is written in an unsupported language. File is not indexed.

0001 /** @mainpage KEduVocDocument
0002 
0003 KEduVocDocument is a library for reading and writing vocabulary files used by Parley, Kanagram, KHangMan and KWordQuiz.
0004  
0005 At this date no binary compatibility is guaranteed. Please update this lib when updating the applications mentioned above.
0006 
0007 Important classes are:
0008  - KEduVocExpression to hold an abstract entry. It contains translations in KEduVocTranslation.
0009  - Lessons are organized by KEduVocLesson.
0010 
0011 Grammatical terms are part of KEduVocTranslation and also contained in:
0012  - KEduVocArticle (articles of a language)
0013  - KEduVocConjugation (conjugations and personal pronouns)
0014  - KEduVocWordType (word type management)
0015 
0016 Grammar is accessed by using an instance of KEduVocDocument.
0017 
0018 Grades can be stored using the KEduVocGrade class (part of a KEduVocTranslation).
0019 
0020 KEduVocDocument supports reading and writing of different file formats. KVTML (version 2) is the default.
0021 
0022 Readers:
0023  - KEduVocKvtml2Reader the current default file format since KDE4
0024  - KEduVocKvtmlReader for compatibility (pre KDE4)
0025  - KEduVocCsvReader Comma separated values (text files)
0026  - KEduVocPaukerReader Pauker file format
0027  - KEduVocVokabelnReader Vokabeln file format
0028  - KEduVocXdxfReader XDXF file format
0029 
0030 Writers:
0031  - KEduVocKvtml2Writer
0032  - KEduVocKvtmlWriter
0033  - KEduVocCsvWriter
0034 
0035 
0036 */