From: Carl Hetherington <cth@carlh.net>
Date: Sat, 2 Feb 2019 00:45:34 +0000 (+0000)
Subject: Some basic documentation of the timeline.
X-Git-Tag: v2.13.112~5
X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=25043fac5a810cc7d906f1b3d88d0ae90f2a2299

Some basic documentation of the timeline.
---

diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 0e3a9a7dd..f56c005d6 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -1536,6 +1536,54 @@ any changes to the corresponding timecode.
 </section>
 
 
+<!-- ============================================================== -->
+<section>
+  <title>Timeline</title>
+
+  <para>
+    The timeline window gives an overview of all the pieces of content
+    in your film, and how they are arranged.  You can open the
+    timeline by clicking the <guilabel>Timeline...</guilabel> button
+    next to the content list.  This will open a window like the one in <xref linkend="fig-timeline1"/>.
+  </para>
+
+  <figure id="fig-timeline1">
+    <title>Timeline</title>
+    <mediaobject>
+      <imageobject>
+	<imagedata fileref="screenshots/timeline1&scs;"/>
+      </imageobject>
+    </mediaobject>
+  </figure>
+
+  <para>
+    The X axis represents time, and you can see the time codes (in
+    hours:minutes:seconds) along the bottom of the window.  Pieces of
+    content are represented with rectangles in the main part of the
+    window.  Content containing different types of data (e.g. a MP4
+    file with video, audio and subtitles) have a rectangle for each
+    type.
+  </para>
+
+  <para>
+    Within the timeline you can select content by clicking, and drag
+    it to change its position.  Right-clicking a piece of content will
+    open the content menu.
+  </para>
+
+  <para>
+    The toolbar at the top of the window offers the following tools:
+  </para>
+
+  <itemizedlist>
+    <listitem>Select &mdash; to select and move content.</listitem>
+    <listitem>Zoom in &mdash; to drag out an area that you want to see more closely.</listitem>
+    <listitem>Zoom out &mdash; to zoom out so that the window shows the whole film.</listitem>
+    <listitem>Snap &mdash; when enabled, content will snap to other content when you drag it close.</listitem>
+    <listitem>Sequence &mdash; when enabled, content will be kept in sequence, without gaps, even if some content is removed.</listitem>
+  </itemizedlist>
+</section>
+
 <!-- ============================================================== -->
 <section>
 <title>Video processing pipeline</title>
diff --git a/doc/manual/screenshots/timeline1.png b/doc/manual/screenshots/timeline1.png
new file mode 100644
index 000000000..579173750
Binary files /dev/null and b/doc/manual/screenshots/timeline1.png differ