KDEEdu/Language/KVocDocumentPlanningJuly2014Temporary: Difference between revisions

From KDE Community Wiki
Line 1: Line 1:
{{Construction}}
{{Construction}}
{{Construction}}
= KVocDocument Planning (July 2014) Temporary =
= KVocDocument Planning (July 2014) Temporary =
Line 7: Line 9:


Each application is divided into File Format, API and Editor requirements.   
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.   
Editor requirements are to explore the possibility of a common editor widget.   


Line 13: Line 16:




=== Hot New Stuff ===
* File Format
** Current
** Future
* API
** Current
** Future
* Editor
** Current
** Future


=== KAnagram ===
=== KAnagram ===
Line 39: Line 53:
* File Format
* File Format
** Current
** Current
***
**# information.generator
**# information.title
**# information.author
**# information.comment
**# identifiers - 2 or more
**# indentifier.name
**# indentifier.locale
**# 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
**# comparison
**# absolute
**# comparative
**# superlative
 
 
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.
**#
* API
* API
** Current
** Current
Line 46: Line 93:
* Editor
* Editor
** Current
** Current
**# supports 2 or more languages
**# supports 1 root lesson
**# supports nested lessons
** Future
** Future


== Cumulative Requiremnts ==  
== Currently Unused ==
These features of the current format appear to be unused
* File Format
*# information.category
*# identifier.identifiertype - never parsed
*# identifier.comment
*# identifier.sizehint - never parsed
*# entry.sizehint - never parsed
**# inpractice
* API
 
== Cumulative Requirements ==  


== File Format ==
== File Format ==

Revision as of 16:26, 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.


Hot New Stuff

  • File Format
    • Current
    • Future
  • API
    • Current
    • Future
  • Editor
    • Current
    • 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
      1. information.generator
      2. information.title
      3. information.author
      4. information.comment
      5. identifiers - 2 or more
      6. indentifier.name
      7. indentifier.locale
      8. indentifier.article
      9. indentifier.article.definite
      10. indentifier.article.indefinite
      11. indentifier.personalpronouns
      12. indentifier.personalpronouns.singular
      13. indentifier.personalpronouns.dual
      14. indentifier.personalpronouns.plural
      15. indentifier.personalpronouns.tense
      16. firstperson
      17. secondperson
      18. thirdpersonmale
      19. thirdpersonfemale
      20. thirdpersonneutralcommon
      21. tenses
      22. tense
      23. lessons
      24. wordtypes
      25. comparison
      26. absolute
      27. comparative
      28. superlative


containerentry is used indirectly so it is not a requirement

    • Future
      1. 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
      1. supports 2 or more languages
      2. supports 1 root lesson
      3. supports nested lessons
    • Future

Currently Unused

These features of the current format appear to be unused

  • File Format
    1. information.category
    2. identifier.identifiertype - never parsed
    3. identifier.comment
    4. identifier.sizehint - never parsed
    5. entry.sizehint - never parsed
      1. inpractice
  • API

Cumulative Requirements

File Format

API

Editor