summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2014-06-21 00:30:11 +0100
committerCarl Hetherington <cth@carlh.net>2014-06-21 00:30:11 +0100
commit7f4f37f498d56b734b49d66127f6f53cf1652d8f (patch)
tree3f6c058a6f5aa0485aeaeb5ab84d1590ca8cfc14
parentdaac3d993d98a5e20f0ab2ef313748c5c0dc8a40 (diff)
Manual updates.
-rw-r--r--doc/manual/Makefile4
-rw-r--r--doc/manual/dcpomatic.css10
-rw-r--r--doc/manual/dcpomatic.xml91
-rw-r--r--doc/manual/screenshots/dcp-tab.pngbin37495 -> 43867 bytes
-rw-r--r--doc/manual/screenshots/timing-tab.pngbin10417 -> 24796 bytes
5 files changed, 96 insertions, 9 deletions
diff --git a/doc/manual/Makefile b/doc/manual/Makefile
index baf8bddc8..eb10af245 100644
--- a/doc/manual/Makefile
+++ b/doc/manual/Makefile
@@ -2,13 +2,13 @@
all: html pdf
-DIAGRAMS := file-structure.svg 3d-left-right.svg 3d-top-bottom.svg
+DIAGRAMS := file-structure.svg 3d-left-right.svg 3d-top-bottom.svg timecode.svg
SCREENSHOTS := file-new.png video-new-film.png still-new-film.png video-select-content-file.png \
still-select-content-file.png examine-thumbs.png examine-content.png timing-tab.png \
calculate-audio-gain.png add-file.png dcp-tab.png \
prefs-kdm-email.png prefs-colour-conversions.png prefs-metadata.png prefs-misc.png prefs-tms.png \
- making-dcp.png filters.png video-tab.png audio-tab.png subtitles-tab.png \
+ making-dcp.png filters.png video-tab.png audio-tab.png subtitles-tab.png timing-tab.png \
audio-plot.png audio-map-eg1.png audio-map-eg2.png audio-map-eg3.png kdm.png
XML := dcpomatic.xml
diff --git a/doc/manual/dcpomatic.css b/doc/manual/dcpomatic.css
index 0e4982f20..566f09e63 100644
--- a/doc/manual/dcpomatic.css
+++ b/doc/manual/dcpomatic.css
@@ -17,3 +17,13 @@ div.sidebar {
border-style: solid;
background-color: #E2E8EE;
}
+
+span.guilabel {
+ border-width: 1px;
+ border-style: solid;
+ background-color: #BED2E6;
+ padding-top: 1px;
+ padding-bottom: 1px;
+ padding-left: 3px;
+ padding-right: 3px;
+} \ No newline at end of file
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index a346c69c7..ef4b7ff6d 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -879,7 +879,79 @@ DCPs).
</section>
-<!-- XXX: timing tab -->
+<section>
+<title>Timing</title>
+
+<para>
+The timing tab contains settings related to the timing of your
+content, as shown in <xref linkend="fig-timing-tab-detail"/>.
+</para>
+
+<figure id="fig-timing-tab-detail">
+ <title>Timing settings tab</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshots/timing-tab&scs;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+Most of the timing tab's entries are <emphasis>time-codes</emphasis>.
+These are expressed as four numbers, as shown in <xref
+linkend="fig-timecode"/>.
+</para>
+
+<figure id="fig-timecode">
+ <title>Timecode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="diagrams/timecode&dia;"/>
+ </imageobject>
+ </mediaobject>
+</figure>
+
+<para>
+<guilabel>Position</guilabel> is the time at which this piece of
+content should start within the DCP. In most cases, this will be
+<code>0:0:0:0</code> to make the content start at the beginning of the
+DCP.
+</para>
+
+<para>
+<guilabel>Full length</guilabel> is the length of the piece of
+content. This can only be set for still-image content: for video or
+sound content, it is fixed by the nature of the content file. If
+still-image content is being used you can set the length for which it
+should be displayed using this control.
+</para>
+
+<para>
+<guilabel>Trim from start</guilabel> specifies the amount that should be trimmed from the start of the content.
+</para>
+
+<para>
+<guilabel>Trim from end</guilabel> specifies the amount that should be trimmed from the end of the content.
+</para>
+
+<para>
+<guilabel>Play length</guilabel> indicates how long this piece of
+content will be once the trims have been applied. This will be equal
+to the full length minus <guilabel>trim-from-start</guilabel> and minus <guilabel>trim-from-end</guilabel>.
+</para>
+
+<para>
+<guilabel>Video frame rate</guilabel> specifies the frame rate for still-image content.
+</para>
+
+<para>
+Each timecode control has a <guilabel>Set</guilabel> which you should
+click when you have entered a new value for a timecode. The
+<guilabel>Set</guilabel> button will make DCP-o-matic take account of
+any changes to the corresponding timecode.
+</para>
+
+</section>
</chapter>
@@ -903,19 +975,19 @@ the main window, as shown in <xref linkend="fig-dcp-tab"/>.
<para>
The first thing here is the name. This is generally set to the title
-of the film that is being encoded. If <guilabel>Use DCI
+of the film that is being encoded. If <guilabel>Use ISDCF
name</guilabel> is not ticked, the name that you specify will be used
-as-is for the name of the DCP. If <guilabel>Use DCI name</guilabel>
+as-is for the name of the DCP. If <guilabel>Use ISDCF name</guilabel>
is ticked, the name that you enter will be used as part of a
-DCI-compliant name.
+ISDCF-compliant name.
</para>
<para>
Underneath the name field is a preview of the name that the DCP will
-get. To use a DCI-compliant name, tick the <guilabel>Use DCI
-name</guilabel> check-box. The DCI name will be composed using details
+get. To use a ISDCF-compliant name, tick the <guilabel>Use ISDCF
+name</guilabel> check-box. The ISDCF name will be composed using details
of your content's soundtrack, the current date and other things that
-can be specified in the DCI name details dialogue box, which you can
+can be specified in the ISDCF name details dialogue box, which you can
open by clicking on the <guilabel>Details</guilabel> button.
</para>
@@ -950,6 +1022,11 @@ more detail in <xref linkend="ch-frame-rates"/>.
</para>
<para>
+The <guilabel>Signed</guilabel> check-box sets whether or not the DCP
+is signed. This is rarely important; if in doubt, tick it.
+</para>
+
+<para>
The <guilabel>Encrypted</guilabel> check-box will set whether the DCP
should be encrypted or not. If this is ticked, the DCP will require a
KDM to play back. Encryption is discussed in <xref
diff --git a/doc/manual/screenshots/dcp-tab.png b/doc/manual/screenshots/dcp-tab.png
index e938aa63d..17208891a 100644
--- a/doc/manual/screenshots/dcp-tab.png
+++ b/doc/manual/screenshots/dcp-tab.png
Binary files differ
diff --git a/doc/manual/screenshots/timing-tab.png b/doc/manual/screenshots/timing-tab.png
index 122d01dc9..9b081e32e 100644
--- a/doc/manual/screenshots/timing-tab.png
+++ b/doc/manual/screenshots/timing-tab.png
Binary files differ