summaryrefslogtreecommitdiff
path: root/doc/manual
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2025-08-22 23:50:28 +0200
committerCarl Hetherington <cth@carlh.net>2025-08-25 11:22:27 +0200
commit6ea9b75c5fc4736f19a424796a3d2c7550fb16dc (patch)
treefc826b31fc5bc5edab88ff1b4c5759e95afd4cef /doc/manual
parentb02325ff69686381f40fee39df35666e58df367e (diff)
Add cover sheet magic strings for marker positions (#3076).
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/dcpomatic.xml79
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index f74299ac9..975d8bb7c 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -3325,6 +3325,85 @@ DCP that has been made:
</table>
<para>
+You can also insert the timecode of any of the DCP's markers using <code>$</code> with the marker's name:
+</para>
+
+<table>
+<tgroup cols='2' align='left' colsep='1' rowsep='1'>
+<tbody>
+<row>
+<entry><code>$FFOC</code></entry><entry>First frame of content</entry>
+</row>
+<row>
+<entry><code>$LFOC</code></entry><entry>Last frame of content</entry>
+</row>
+<row>
+<entry><code>$FFTC</code></entry><entry>First frame of title credits</entry>
+</row>
+<row>
+<entry><code>$LFTC</code></entry><entry>Last frame of title credits</entry>
+</row>
+<row>
+<entry><code>$FFOI</code></entry><entry>First frame of intermission</entry>
+</row>
+<row>
+<entry><code>$LFOI</code></entry><entry>Last frame of intermission</entry>
+</row>
+<row>
+<entry><code>$FFEC</code></entry><entry>First frame of end credits</entry>
+</row>
+<row>
+<entry><code>$LFEC</code></entry><entry>Last frame of end credits</entry>
+</row>
+<row>
+<entry><code>$FFMC</code></entry><entry>First frame of moving credits</entry>
+</row>
+<row>
+<entry><code>$LFMC</code></entry><entry>Last frame of moving credits</entry>
+</row>
+<row>
+<entry><code>$FFOB</code></entry><entry>First frame of ratings band</entry>
+</row>
+<row>
+<entry><code>$LFOB</code></entry><entry>Last frame of ratings band</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+
+<para>
+These magic strings will be replaced with &lsquo;Unknown&rsquo; if the marker is not defined.
+Alternatively, adding <code>_LINE</code> to a marker magic string will make the
+timecode appear if the marker is set, otherwise the whole line containing the magic string
+will be removed.
+</para>
+
+<para>
+For example, a cover sheet defined as
+</para>
+
+<para>
+<programlisting>
+Hello: $FFMC
+Goodbye: $FFMC_LINE
+</programlisting>
+</para>
+
+<para>
+will be written as
+</para>
+
+<para>
+<programlisting>
+Hello: Unknown
+</programlisting>
+</para>
+
+<para>
+if the <code>FFMC</code> marker is undefined.
+</para>
+
+<para>
Clicking <guilabel>Reset to default text</guilabel> will replace the current cover sheet with DCP-o-matic's default.
</para>