Revision as of 19:38, 9 July 2014

Under Construction
This is a new page, currently under construction!

Under Construction
This is a new page, currently under construction!

KVocDocument Planning (July 2014) Temporary

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

KArtikulate

File Format

Current

Future

API

Current

Future

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

@@ Line 5: / Line 5: @@
 == 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.
-=== Hot New Stuff ===
-* File Format
-** Current
-** Future
-* API
-** Current
-** Future
-* Editor
-** Current
-** Future
 === KAnagram ===
-* File Format
+==== File Format ====
-** Current
+===== Current =====
-** Future
+===== Future =====
-* API
+==== API ====
-** Current
+===== Current =====
-** Future
+===== Future =====
-* Editor
+==== Editor ====
-** Current
+===== Current =====
-** Future
+===== Future =====
 === KArtikulate ===
-* File Format
+==== File Format ====
-** Current
+===== Current =====
-** Future
+===== Future =====
-* API
+==== API ====
-** Current
+===== Current =====
-** Future
+===== Future =====
-* Editor
+==== Editor ====
-** Current
+===== Current =====
-** Future
+===== Future =====
 === Parley ===
-* File Format
+==== File Format ====
-** Current
+===== Current =====
-**# information.generator
+====== Used Tags ======
-**# information.title
+Parley uses almost every tag that is parsed from the kvtml2 file so this section is not very useful
-**# information.author
-**# information.comment
+# information.generator
-**# identifiers - 2 or more
+# information.title
-**# indentifier.name
+# information.author
-**# indentifier.locale
+# information.comment
-**# indentifier.article
+# identifiers - 2 or more
-**# indentifier.article.definite
+#
-**# indentifier.article.indefinite
+# indentifier.name
-**# indentifier.personalpronouns
+# indentifier.locale
-**# indentifier.personalpronouns.singular
+# identifier.comment
-**# indentifier.personalpronouns.dual
+# indentifier.article
-**# indentifier.personalpronouns.plural
+# indentifier.article.definite
-**# indentifier.personalpronouns.tense
+# indentifier.article.indefinite
-**# firstperson
+# indentifier.personalpronouns
-**# secondperson
+# indentifier.personalpronouns.singular
-**# thirdpersonmale
+# indentifier.personalpronouns.dual
-**# thirdpersonfemale
+# indentifier.personalpronouns.plural
-**# thirdpersonneutralcommon
+# indentifier.personalpronouns.tense
-**# tenses
+# firstperson
-**# tense
+# secondperson
-**# lessons
+# thirdpersonmale
-**# wordtypes
+# thirdpersonfemale
-**# comparison
+# thirdpersonneutralcommon
-**# absolute
+#
-**# comparative
+# tenses
-**# superlative
+# 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)
-containerentry is used indirectly so it is not a requirement
-** Future
+===== Future =====
-**# ids are alphanumeric so they can be a) human meaningful b) stable if words/lessons/grades are in different locations.
+# ids are alphanumeric so they can be a) human meaningful b) stable if words/lessons/grades are in different locations.
-**#
+#
-* API
+==== API ====
-** Current
+===== Current =====
-** Future
+===== Future =====
-* Editor
+==== Editor ====
-** Current
+===== Current =====
-**# supports 2 or more languages
+# supports 2 or more languages
-**# supports 1 root lesson
+# supports 1 root lesson
-**# supports nested lessons
+# supports nested lessons
-** Future
+===== Future =====
 == Currently Unused ==
 These features of the current format appear to be unused
-* File Format
+==== File Format ====
-*# information.category
+# information.category
-*# identifier.identifiertype - never parsed
+# identifier.identifiertype - never parsed in kvocdoc
-*# identifier.comment
+# identifier.sizehint - never parsed in kvocdoc
-*# identifier.sizehint - never parsed
+# entry.sizehint - never parsed in kvocdoc
-*# entry.sizehint - never parsed
+# leitnerboxes - never used in Parley
-**# inpractice
+# deactivated - never parsed in kvocdoc
-* API
+==== API ====
 == Cumulative Requirements ==
 == File Format ==