Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Script Event Description should be an object #174

Closed
andreastai opened this issue Jul 24, 2023 · 1 comment · Fixed by #181
Closed

Script Event Description should be an object #174

andreastai opened this issue Jul 24, 2023 · 1 comment · Fixed by #181
Assignees
@nigelmegitt

Comments

@andreastai
Copy link

Script Event Description should be represented as an object. With Script Event Description Type (currently only specified in the TTML syntax as the attribute daptm:descType) it has its own property and it can also be associated with Script Event multiple times.
@nigelmegitt
Copy link
Contributor

You're right, by allowing use of ttm:desc, TTML2 does not restrict the number of <ttm:desc> element children of an element that accepts children in the Metadata.class class. And this is inconsistent in DAPT at the moment:

The specification for Script Event says:

an optional Script Event Description property, as a human-readable description of the Script Event.

whereas under Script Event Description itself we have:

Multiple ttm:desc elements MAY be present with different values of daptm:descType, as in the following example.

which does not match. Since DAPT also defines daptm:descType as a distinguishing attribute, it should be considered a separate entity.

@nigelmegitt nigelmegitt self-assigned this Jul 24, 2023
nigelmegitt added a commit that referenced this issue Aug 1, 2023
@nigelmegitt
Split Script Event Description out as a separate object
c894194 
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`.
@nigelmegitt nigelmegitt mentioned this issue Aug 1, 2023
Merged
nigelmegitt added a commit that referenced this issue Oct 11, 2023
@nigelmegitt
Split Script Event Description out as a separate object (#181)
04b0b5d 
* Split Script Event Description out as a separate object

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`.

* Add optional language to script description in UML model

Also pre-emptively remove the Style assuming that #185 is approved too. If not, will need to re-instate Style.

* Address review feedback

* typos and minor editorial tweaks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nigelmegitt nigelmegitt

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Split Script Event Description out as a separate object w3c/dapt
2 participants
@andreastai @nigelmegitt