search

oasis-tcs / xliff-omos-jliff

OASIS XLIFF OMOS TC: JSON serialization of the XLIFF Abstract Object Model
https://github.com/oasis-tcs/xliff-omos-jliff
Other
17 stars 4 forks source link

review note object in schema and prose #27

Closed DavidFatDavidF closed 3 years ago

DavidFatDavidF commented 3 years ago

Add notes to some of the JLIFF examples

DavidFatDavidF commented 3 years ago

Looking at schema and prose for notes/note, suspected issues are as follows:

  1. notes don't seem to be allowed in schema for the anonymous file object.
  2. the note object as currently defined both in schema and prose doesn't seem to have storage for the note text. This could be "note" : "string", where note would be a required property.
  3. note in the schema is not extensible (doesn't specify the userdata object)
  4. the array of anonymous note objects could be a property of a notes object [? for better readability ?]
  5. In the prose description of note, "Contains: object" seems strange, as it is an object rather than contains an object..
DavidFatDavidF commented 3 years ago

Consensus from Dec 15 meeting

WRT line 2., we agreed to reuse a required "text" : "string" property that reuses the element-text type definition. Don't do 4. WRT line 5. Replace Contains with Type in the prose spec (not only in note prose but globally)

  1. and 3. need to be addressed as is
DavidFatDavidF commented 3 years ago

@genivia-inc to implement Consensus from Dec 15 meeting for review in the January 2021 meeting

DavidFatDavidF commented 3 years ago

@DavidFatDavidF to modify the prose to reflect consensus for 2.