Split Script Event Description out as a separate object #181
Conversation
Closes #174. Clarifies the cardinality of Script Event Description. Updates the data model diagram (in a way that is non-ideal but hard to fix automatically: it may be worth replacing the PlantUML-generated diagram with a more manually constructed one prior to final publication), and defines Description Type more explicitly. Also clarify that there is no uniqueness constraint for `daptm:descType` and that `xml:lang` can be used to label the language of the contents of a `ttm:desc`.
|
Raised #182 regarding cleaning up the PlantUML-generated SVG diagrams. |
|
pinging @cconcolato @andreastai for a review please |
Not sure I understand - are you suggesting that we should require the presence of |
I wasn't clear. When I read the sentence https://github.com/w3c/dapt/pull/181/files#diff-0eb547304658805aad788d320f10bf1f292797b5e6d745a3bf617584da017051R984, I thought maybe we should have an |
|
Oh sure, makes sense. |
Also pre-emptively remove the Style assuming that #185 is approved too. If not, will need to re-instate Style.
|
Have added optional Language to the script description in the UML model. The model in this PR originally looked pretty bad, and the one in #185 is much better, from a layout perspective, but omits Style. To save editorial time, I've slightly naughtily assumed that we will approve and merge #185, and gone ahead with the UML model from that pull request, omitting Style, and added the ScriptDescription object in to that one. If we don't merge #185 then we'll need to put the Style back. |
There was a problem hiding this comment.
Thanks, @nigelmegitt Overall the changes look good to me. Some observations:
The information about the Description Type is now represented two times in the Document:
The Description Type is represented in a DAPT Document by a daptm:descType attribute on the ttm:desc element.
and
The ttm:desc element MAY have a daptm:descType attribute specified to indicate the Description Type.
In any case, the info about the Description Type should go after Example 20.
The information that the attribute @xml:lang is used to represent the optional language of the Event Description should be in the normative text with a MAY keyword rather than in a note.
A note may also be added if the language of the Event Description is the Primary Language of the DAPT script in case @xml:lang is omited on <ttm:desc>.
|
Thank you @andreastai for the great review feedback. I've reworked the section to address the points. Just one thing I disagree with: if Hopefully the order is now clearer and there is no unnecessary duplication. |
Yes, thanks @nigelmegitt! The edits look good to me.
As I understand the Script Event object does not have a language property and the language is always specified on the Text object. |
Oh I see. Formally, Script Events do have a computed language regardless of whether they have an My view here is that we should go with the text in this pull request and if anyone asks about this subtlety we can consider amending or adding extra explanation. |
Thanks, @nigelmegitt I think we should be clear about how language information is applied and inherited. From the class model (at least from what I can see) there is no other way to inherit the language information other than from the document level. |
Raised as #192. |
Closes #174.
Clarifies the cardinality of Script Event Description.
Updates the data model diagram (in a way that is non-ideal but hard to fix automatically: it may be worth replacing the PlantUML-generated diagram with a more manually constructed one prior to final publication), and defines Description Type more explicitly.
Also clarify that there is no uniqueness constraint for
daptm:descTypeand thatxml:langcan be used to label the language of the contents of attm:desc.Preview | Diff