Skip to content

Commit

Permalink
test gitlocaize error
Browse files Browse the repository at this point in the history
  • Loading branch information
mattgarrish committed Aug 16, 2024
1 parent ef8c7bd commit 32ae1cb
Showing 1 changed file with 60 additions and 54 deletions.
114 changes: 60 additions & 54 deletions publishing/docs/sync-media/overlays.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,67 +76,73 @@ <h3>Overview</h3>

<p>Media Overlays documents are built using the following elements:</p>

<table class="elemDef">
<thead>
<tr>
<th>Element</th>
<th>Use</th>
</tr>
</thead>
<tbody>
<tr>
<td class="root"><a href="https://www.w3.org/TR/epub/#sec-smil-smil-elem"
>smil</a></td>
<td class="use">The <code>smil</code> element is the root element of each Media Overlay, and
contains an optional <code>head</code> and required <code>body</code> element.</td>
</tr>
<tr>
<td class="firstChild"><a href="https://www.w3.org/TR/epub/#sec-smil-head-elem"
>head</a></td>
<td class="use">The <code>head</code> element may contain metadata in an optional
<code>metadata</code> element, but none is required by the EPUB 3 specification.</td>
</tr>
<tr>
<td class="secondChild"><a href="https://www.w3.org/TR/epub/#sec-smil-seq-elem"
>metadata</a></td>
<td class="use">The <code>metadata</code> element is an extension element that allows metadata
from foreign namespaces to be included in the overlay.</td>
</tr>
<tr>
<td class="firstChild"><a href="https://www.w3.org/TR/epub/#sec-smil-body-elem"
>body</a></td>
<td class="use">The <code>body</code> element defines playback through the order of
<code>seq</code> and <code>par</code> elements it contains.</td>
</tr>
<tr>
<td class="secondChild"><a href="https://www.w3.org/TR/epub/#sec-smil-seq-elem"
>seq</a></td>
<td class="use">The <code>seq</code> element is used to structure an overlay. It is used to
represent complex structures such as sections, tables and lists that a user may want to
skip or escape from.</td>
</tr>
<tr>
<td class="secondChild"><a href="https://www.w3.org/TR/epub/#sec-smil-par-elem"
>par</a></td>
<td class="use">The <code>par</code> element defines a synchronization point in its child
<code>text</code> and/or <code>audio</code> elements.</td>
</tr>
<tr>
<td class="thirdChild"><a href="https://www.w3.org/TR/epub/#sec-smil-text-elem"
>text</a></td>
<td class="use">The <code>text</code> element identifies the content document and element to
synchronize visual rendering to.</td>
</tr>
<tr>
<td class="thirdChild"><a href="https://www.w3.org/TR/epub/#sec-smil-audio-elem"
>audio</a></td>
<td class="use">The <code>audio</code> element identifies the audio file and optional start and
end points for playback.</td>
</tr>
</tbody>
</table>

<p>In order to synchronize a publication, each content document in a publication must have its own overlay
associated with it. Overlays are tied to content documents in the package document manifest using a
<code>media-overlay</code> attribute with the ID of the <code>item</code> that defines the
overlay.</p>

</section>

<section id="ex">
<h3>Examples</h3>
<figure id="ex-01">
<figcaption>Example 1 &#8212; A basic overlay document</figcaption>
<p>The following example shows an overlay document for a chapter that consists of only a heading and two
paragraphs.</p>
<pre id="ex-01-src" class="prettyprint linenums"><code>&lt;smil xmlns="http://www.w3.org/ns/SMIL"
xmlns:epub="http://www.idpf.org/2007/ops"
version="3.0">
&lt;body>
&lt;seq
epub:textref="chapter_001.xhtml"
epub:type="bodymatter chapter">

&lt;par>
&lt;text src="chapter_001.xhtml#c01h01"/>
&lt;audio
src="audio/c01.mp4"
clipBegin="0:00:00.000"
clipEnd="0:00:05.250"/>
&lt;/par>

&lt;par>
&lt;text src="chapter_001.xhtml#c01p0001"/>
&lt;audio
src="audio/c01.mp4"
clipBegin="0:00:05.250"
clipEnd="0:00:58.100"/>
&lt;/par>

&lt;par>
&lt;text src="chapter_001.xhtml#c01p0002"/>
&lt;audio
src="audio/c01.mp4"
clipBegin="0:00:58.100"
clipEnd="0:02:04.000"/>
&lt;/par>
&lt;/seq>
&lt;/body>
&lt;/smil></code></pre>
</figure>

<figure id="ex-02">
<figcaption>Example 2 &#8212; Linking a chapter document to its overlay</figcaption>
<pre id="ex-02-src" class="prettyprint linenums"><code>&lt;item id="xchapter_001"
href="chapter_001.xhtml"
media-type="application/xhtml+xml"
media-overlay="chapter_001_overlay"/>

&lt;item id="chapter_001_overlay"
href="chapter_001_overlay.smil"
media-type="application/smil+xml"/></code></pre>
</figure>
</section>

<section id="samp" class="sample">
<h3>Samples</h3>
Expand Down

0 comments on commit 32ae1cb

Please sign in to comment.