Remove Script Event Type, use Represents instead (#241)

* Remove Script Event Type, use Represents instead * Merge registry table entries for `eventType` and `<content-descriptor>` (removing the `eventType` registry) * Extract definition of Represents into the Shared Properties section * Remove Script Event Type * Make Represents an optional property of Script Event and move example that was in Script Event Type up into Script Event under the Represents bullet * Add _permitted_ `#represents-div` feature * Update class diagram to remove Script Event Type and add Represents to Script Event * fix validation error * Fix lwsp requirement bug Fix to be one or more, was zero or more. * Iterate design following discussion Separate scriptRepresents from represents as applied to Script Events. Define usage constraints. Define the syntax of `<content-descriptor>` to allow for generic validity checking without needing to understand the contents of the values used. Update the feature extensions and examples. Update the introduction to mention represents. Update the examples. Update the profiles and dispositions. Define an inheritance model for `daptm:represents`. Make Represents required to have a non-empty and valid computed value, but don't require `daptm:represents` on every Script Event `<div>` element. Allow user-defined content-descriptor values beginning `x-`. State that ttm:desc SHOULD NOT be empty. * Temporary fix for speced/respec#4806 Move the term inside the angle brackets, which makes it harder to find in the index of terms, but fixes the Respec error. * Fix SVG validation issue * Address review comments * Fix broken reference to scriptRepresents * Explain presence of inherited `daptm:represents` on `<body>` element in example * Explain how scriptRepresents might include values not present in Script - Represents * Fix syntax references to NMToken and `<lwsp>` * Take suggestions for better term definitions for content-descriptor * Clarify that Represents is inheritable, within the Represents property aside. * Allow `.` as delimiter, and fix user-defined descriptor text * Fix some broken examples * Address additional review comments * Fix up ; to . * Fix up more ; and .
w3c · Sep 28, 2024 · f3fb76f · f3fb76f
1 parent 0d083c2
commit f3fb76f
Show file tree

Hide file tree

Showing 15 changed files with 578 additions and 443 deletions.
diff --git a/README.md b/README.md
@@ -50,7 +50,7 @@ Unfortunately the SVG that PlantUML generates from our source files has some str
 The following steps can be taken to fix them. It'd be neat to automate this somehow, one day...
 1. delete `contentStyleType="text/css"`
 2. delete text matching the regexp ` title="[#a-zA-Z\-]+"`
-3. delete text matching the regexp = ` codeline="[0-9]+"`
+3. delete text matching the regexp = ` codeline="[#a-zA-Z0-9\-]+"`
 4. deduplicate id values, e.g. id="link_Text_Style" in more than one place - a specific problem with the two links from Text to Style in the class diagram. E.g. change the "other" link with `id="link_Text_Style"` to `id="link_Text_Style_other"`
 5. Move <a> wrappers from around boxes which contain other <a> elements, which therefore get nested, so the link is not on the box but is on the top text.
    * Specifically, where there is `/svg/a/g/text` move the `<a>` wrappers to being around the `<text>` that includes the text that's relevant.

diff --git a/examples/intro-original-language-with-dub-language-and-adaptation.xml b/examples/intro-original-language-with-dub-language-and-adaptation.xml
@@ -5,7 +5,7 @@
     ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
     xml:lang="en"
     daptm:langSrc="fr"
-    daptm:represents="dialogue"
+    daptm:scriptRepresents="audio.dialogue"
     daptm:scriptType="preRecording">
   <head>
     <metadata>
@@ -15,7 +15,7 @@
     </metadata>
   </head>
   <body>
-    <div begin="10s" end="13s" ttm:agent="character_1" daptm:onScreen="ON_OFF">
+    <div begin="10s" end="13s" ttm:agent="character_1" daptm:onScreen="ON_OFF" daptm:represents="audio.dialogue">
       <p xml:lang="fr" daptm:langSrc="fr">
         <span>Et c'est grâce à ça qu'on va devenir riches.</span>
       </p>

diff --git a/examples/intro-original-language-with-dub-language.xml b/examples/intro-original-language-with-dub-language.xml
@@ -5,7 +5,7 @@
     ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
     xml:lang="en"
     daptm:langSrc="fr"
-    daptm:represents="dialogue"
+    daptm:scriptRepresents="audio.dialogue"
     daptm:scriptType="translatedTranscript">
   <head>
     <metadata>
@@ -15,7 +15,7 @@
     </metadata>
   </head>
   <body>
-    <div begin="10s" end="13s" ttm:agent="character_1">
+    <div begin="10s" end="13s" ttm:agent="character_1" daptm:represents="audio.dialogue">
       <p xml:lang="fr" daptm:langSrc="fr"> <!-- original -->
         <span>Et c'est grâce à ça qu'on va devenir riches.</span>
       </p>

diff --git a/examples/intro-original-language.xml b/examples/intro-original-language.xml
@@ -5,7 +5,7 @@
     ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
     xml:lang="fr"
     daptm:langSrc="fr"
-    daptm:represents="dialogue"
+    daptm:scriptRepresents="audio.dialogue"
     daptm:scriptType="originalTranscript">
   <head>
     <metadata>
@@ -15,7 +15,7 @@
     </metadata>
   </head>
   <body>
-    <div begin="10s" end="13s">
+    <div begin="10s" end="13s" daptm:represents="audio.dialogue">
       <p ttm:agent="character_1">
         <span>Et c'est grâce à ça qu'on va devenir riches.</span>
       </p>

diff --git a/examples/intro-script-with-audio-clipped.xml b/examples/intro-script-with-audio-clipped.xml
@@ -1,4 +1,4 @@
 ...
-  <audio src="long_audio.wav" clipBegin="5s" clipEnd="8s"/>
+  <span><audio src="long_audio.wav" clipBegin="5s" clipEnd="8s"/>
   A woman climbs into a small sailing boat.</span>
 ...
diff --git a/examples/intro-script-with-gain.xml b/examples/intro-script-with-gain.xml
@@ -1,10 +1,10 @@
 <tt ...
-  daptm:represents="visualNonText, visualText"
+  daptm:scriptRepresents="visual.nonText visual.text"
   daptm:scriptType="asRecorded"
   xml:lang="en"
   daptm:langSrc="">
   ...
-    <div begin="25s" end="28s">
+    <div begin="25s" end="28s" daptm:represents="visual.nonText">
       <p>
         <animate begin="0.0s" end="0.3s" tta:gain="1;0.39" fill="freeze"/>
         <animate begin="2.7s" end="3s" tta:gain="0.39;1"/>

diff --git a/examples/intro-times-and-text.xml b/examples/intro-times-and-text.xml
@@ -5,15 +5,15 @@
   ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
   xml:lang="en"
   daptm:langSrc=""
-  daptm:represents="visualNonText, visualText"
+  daptm:scriptRepresents="visual.nonText visual.text"
   daptm:scriptType="preRecording">
   <body>
-    <div begin="10s" end="13s">
+    <div begin="10s" end="13s" daptm:represents="visual.nonText">
       <p>
         A woman climbs into a small sailing boat.
       </p>
     </div>
-    <div begin="18s" end="20s">
+    <div begin="18s" end="20s" daptm:represents="visual.nonText">
       <p>
         The woman pulls the tiller and the boat turns.
       </p>

diff --git a/examples/intro-times-only.xml b/examples/intro-times-only.xml
@@ -1,5 +1,5 @@
 ...
-  <body>
+  <body daptm:represents="...">
     <div xml:id="d1" begin="10s" end="13s">
     </div>
     <div xml:id="d2" begin="18s" end="20s">

diff --git a/examples/intro-top-level.xml b/examples/intro-top-level.xml
@@ -4,7 +4,7 @@
     ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
     xml:lang="en"
     daptm:langSrc="en"
-    daptm:represents="dialogue"
+    daptm:scriptRepresents="audio"
     daptm:scriptType="originalTranscript">
   <head>
     <metadata>

diff --git a/examples/sourceMediaIdentifier.xml b/examples/sourceMediaIdentifier.xml
@@ -4,7 +4,7 @@
     xmlns:ebuttm="urn:ebu:tt:metadata"
     xml:lang="en" 
     ttp:contentProfiles="http://www.w3.org/ns/ttml/profile/dapt1.0/content"
-    daptm:represents="dialogue"
+    daptm:scriptRepresents="audio.dialogue"
     daptm:scriptType="originalTranscript">
   <head>
     <metadata>