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

Issue 0274 xml id editorial improvements #275

Merged
merged 2 commits into from
Dec 10, 2024
Merged

Issue 0274 xml id editorial improvements #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70ca054
Add xml:id to every Script Event div example
nigelmegitt Nov 28, 2024
8223e16
Define Unique Identifier as a Shared Property and reference it
nigelmegitt Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/event-desc-descType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
...
<body>
<div begin="10s" end="13s">
<div begin="10s" end="13s" xml:id="a123">
<ttm:desc daptm:descType="pronunciationNote">[oːnʲ]</ttm:desc>
<p>Eóin looks around at the other assembly members.</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions examples/event-desc-multiple-descType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
...
<body>
<div begin="10s" end="13s">
<div begin="10s" end="13s" xml:id="a1">
<ttm:desc daptm:descType="scene">Scene 1</ttm:desc>
<ttm:desc daptm:descType="plotSignificance">High</ttm:desc>
<p xml:lang="en">
Expand All @@ -10,7 +10,7 @@
<span>Une femme monte à bord d'un petit bateau à voile.</span>
</p>
</div>
<div begin="18s" end="20s">
<div begin="18s" end="20s" xml:id="a2">
<ttm:desc daptm:descType="scene">Scene 1</ttm:desc>
<ttm:desc daptm:descType="plotSignificance">Low</ttm:desc>
<p xml:lang="en">
Expand Down
4 changes: 2 additions & 2 deletions examples/event-desc.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
...
<body>
<div begin="10s" end="13s">
<div begin="10s" end="13s" xml:id="a1">
<ttm:desc>Scene 1</ttm:desc>
<p xml:lang="en">
<span>A woman climbs into a small sailing boat.</span>
Expand All @@ -9,7 +9,7 @@
<span>Une femme monte à bord d'un petit bateau à voile.</span>
</p>
</div>
<div begin="18s" end="20s">
<div begin="18s" end="20s" xml:id="a2">
<ttm:desc>Scene 1</ttm:desc>
<p xml:lang="en">
<span>The woman pulls the tiller and the boat turns.</span>
Expand Down
2 changes: 1 addition & 1 deletion examples/intro-original-language-with-dub-language-and-adaptation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</metadata>
</head>
<body>
<div begin="10s" end="13s" ttm:agent="character_1" daptm:onScreen="ON_OFF" daptm:represents="audio.dialogue">
<div begin="10s" end="13s" xml:id="d1" 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>
Expand Down
2 changes: 1 addition & 1 deletion examples/intro-original-language-with-dub-language.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</metadata>
</head>
<body>
<div begin="10s" end="13s" ttm:agent="character_1" daptm:represents="audio.dialogue">
<div begin="10s" end="13s" xml:id="d1" 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>
Expand Down
2 changes: 1 addition & 1 deletion examples/intro-original-language.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</metadata>
</head>
<body>
<div begin="10s" end="13s" daptm:represents="audio.dialogue">
<div begin="10s" end="13s" xml:id="d1" daptm:represents="audio.dialogue">
<p ttm:agent="character_1">
<span>Et c'est grâce à ça qu'on va devenir riches.</span>
</p>
Expand Down
2 changes: 1 addition & 1 deletion examples/intro-script-with-embedded-audio.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
...
<div begin="25s" end="28s">
<div begin="25s" end="28s" xml:id="a3">
<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"/>
Expand Down
2 changes: 1 addition & 1 deletion examples/intro-script-with-gain.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
xml:lang="en"
daptm:langSrc="">
...
<div begin="25s" end="28s" daptm:represents="visual.nonText">
<div begin="25s" end="28s" xml:id="a3" 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"/>
Expand Down
2 changes: 1 addition & 1 deletion examples/intro-script-with-speak.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
...
<div begin="18s" end="20s">
<div begin="18s" end="20s" xml:id="a2">
<p>
<span tta:speak="normal">
The woman pulls the tiller and the boat turns.</span>
Expand Down
4 changes: 2 additions & 2 deletions examples/intro-times-and-text.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
daptm:scriptRepresents="visual.nonText visual.text"
daptm:scriptType="preRecording">
<body>
<div begin="10s" end="13s" daptm:represents="visual.nonText">
<div begin="10s" end="13s" xml:id="a1" daptm:represents="visual.nonText">
<p>
A woman climbs into a small sailing boat.
</p>
</div>
<div begin="18s" end="20s" daptm:represents="visual.nonText">
<div begin="18s" end="20s" xml:id="a2" daptm:represents="visual.nonText">
<p>
The woman pulls the tiller and the boat turns.
</p>
Expand Down
4 changes: 2 additions & 2 deletions examples/intro-times-only.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
...
<body daptm:represents="...">
<div xml:id="d1" begin="10s" end="13s">
<div xml:id="id1" begin="10s" end="13s">
</div>
<div xml:id="d2" begin="18s" end="20s">
<div xml:id="id2" begin="18s" end="20s">
</div>
</body>
...
10 changes: 9 additions & 1 deletion examples/intro-top-level.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@
</layout>
</head>
<body>
<!-- Content goes here -->
<!-- Content goes here and consists of a div for each Script Event -->
<div xml:id="d1" begin="..." end="..." daptm:represents="audio.dialogue">
<p>
<!-- Text blocks are contained in p elements -->
</p>
<p xml:lang="fr" daptm:langSrc="en">
<!-- Translation text is related to the source language for the translation -->
</p>
</div>
</body>
</tt>
41 changes: 38 additions & 3 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -859,6 +859,7 @@ <h4>Shared properties and Value Sets</h4>
<p class="ednote">Would it be better to make a "Timed Object" class and subclass Script Event,
Mixing Instruction and Audio Recording from it?
</p>

<section>
<h5>Timing Properties</h5>
<p>The following <dfn data-lt="timing property|timing properties">timing properties</dfn>
Expand Down Expand Up @@ -1045,6 +1046,40 @@ <h5><code>&lt;content-descriptor&gt;</code> values</h5>
</table>
</div>
</section>

<section>
<h5>Unique identifiers</h5>
<p>Some entities in the data model include unique identifiers.
A <dfn>Unique Identifier</dfn> has the following requirements:</p>
<ul>
<li><p>it is unique within the <a>DAPT Script</a>,
i.e. the value of a <a>Unique Identifier</a> can only
be used one time within the document,
regardless of which specific kind of identifier it is.</p>
<p class="example">If a <a>Character Identifier</a> has the value <code>&quot;abc&quot;</code>
and a <a>Script Event Identifier</a> in the same document has the same value,
that is an error.</p>
</li>
<li><p>its value has to conform to the requirements of
<code><a data-cite="XML#NT-Name">Name</a></code> as defined by [[XML]]</p>
<div class="note"><p>It cannot begin with
a digit,
a combining diacritical mark (an accent),
or any of the following characters:</p>
<pre><code> .
-
&#xB7; // #xB7
&#x203F; // #x203F
&#x2040; // #x2040</code></pre>
<p>but those characters can be used elsewhere.
</p></div>
</li>
</ul>
<p>A <a>Unique Identifier</a> for an entity is expressed in a <a>DAPT Document</a>
by an <code>xml:id</code> attribute on the corresponding element.</p>
<p class="note">The formal requirements for the semantics and processing of <code>xml:id</code>
are defined in [[xml-id]].</p>
</section>
</section>

</section>
Expand All @@ -1054,8 +1089,8 @@ <h3>Character</h3>
<p><em>This section is mainly relevant to <a>Dubbing</a> workflows.</em></p>
<p>A character in the programme can be described using a <dfn>Character</dfn> object which has the following properties:
<ul>
<li>a mandatory <dfn data-lt="Character Identifier">Identifier</dfn>
which is a unique identifier used to reference the character from elsewhere in the document,
<li>a mandatory <dfn data-lt="Character Identifier">Character Identifier</dfn>
which is a <a>Unique Identifier</a> used to reference the character from elsewhere in the document,
for example to indicate when a <a>Character</a> participates in a <a>Script Event</a>.</li>
<li>a mandatory <dfn data-lt="Character Name">Name</dfn> which is the name of the <a>Character</a> in the programme</li>
<li>an optional <dfn data-lt="Character Talent Name">Talent Name</dfn>, which is the name of the actor speaking dialogue for this <a>Character</a>.</li>
Expand Down Expand Up @@ -1149,7 +1184,7 @@ <h3>Character</h3>
<h3>Script Event</h3>
<p>A <dfn>Script Event</dfn> object represents dialogue, on screen text or audio descriptions to be spoken and has the following properties:</p>
<ul>
<li>A mandatory <dfn>Script Event Identifier</dfn> which is unique in the <a>script</a></li>
<li>A mandatory <dfn>Script Event Identifier</dfn> which is a <a>Unique Identifier</a>.</li>
<li>An optional <a>Begin</a> property and an optional <a>End</a> and an optional <a>Duration</a> property
that together define the <a>Script Event</a>'s time interval in the programme timeline
<p class="note">Typically <a>Script Events</a> do not overlap in time.
Expand Down