Manual updates.
authorCarl Hetherington <cth@carlh.net>
Wed, 24 Aug 2016 09:46:18 +0000 (10:46 +0100)
committerCarl Hetherington <cth@carlh.net>
Wed, 24 Aug 2016 09:46:18 +0000 (10:46 +0100)
13 files changed:
doc/manual/dcpomatic.xml
doc/manual/screenshots/add-file.png
doc/manual/screenshots/audio-tab.png
doc/manual/screenshots/dcp-tab.png
doc/manual/screenshots/examine-content.png
doc/manual/screenshots/prefs-advanced.png
doc/manual/screenshots/prefs-defaults.png
doc/manual/screenshots/prefs-kdm-email.png
doc/manual/screenshots/prefs-keys.png
doc/manual/screenshots/prefs-servers.png
doc/manual/screenshots/subtitles-tab.png
doc/manual/screenshots/timing-tab.png
doc/manual/screenshots/video-tab.png

index faee0a8963ce98a3b97f7527a09e5a5c9d71fd82..1bd1516b077fd42458885d497c492d16ef610dac 100644 (file)
@@ -101,6 +101,12 @@ many parallel encoding threads (more than 4) on the 32-bit
 version.
 </para>
 
 version.
 </para>
 
+<para>
+If you are still using Windows XP, download the specific XP version as
+it should be more stable on your machine than the &lsquo;normal&rsquo;
+Windows version.
+</para>
+
 </section>
 
 
 </section>
 
 
@@ -139,7 +145,6 @@ depend on it.
   <listitem>Debian unstable (&lsquo;sid&rsquo;)</listitem>
   <listitem>Ubuntu 12.04 (&lsquo;Precise Pangolin&rsquo;)</listitem>
   <listitem>Ubuntu 14.04 (&lsquo;Trusty Tahr&rsquo;)</listitem>
   <listitem>Debian unstable (&lsquo;sid&rsquo;)</listitem>
   <listitem>Ubuntu 12.04 (&lsquo;Precise Pangolin&rsquo;)</listitem>
   <listitem>Ubuntu 14.04 (&lsquo;Trusty Tahr&rsquo;)</listitem>
-  <listitem>Ubuntu 15.10 (&lsquo;Wily Werewolf&rsquo;)</listitem>
   <listitem>Ubuntu 16.04 (&lsquo;Xenial Xerus&rsquo;)</listitem>
 </itemizedlist>
 
   <listitem>Ubuntu 16.04 (&lsquo;Xenial Xerus&rsquo;)</listitem>
 </itemizedlist>
 
@@ -623,7 +628,7 @@ DCP-o-matic will decode and then re-encode the JPEG2000 data.
 </section>
 
 
 </section>
 
 
-<section>
+<section xml:id="sec-overlay">
 <title>Making overlay files</title>
 
 <para>
 <title>Making overlay files</title>
 
 <para>
@@ -730,7 +735,7 @@ images which should be treated as the frames of a video.
 
 <listitem>Subtitle &mdash; a file containing subtitle which will be
 superimposed on the image of the DCP.  These can be
 
 <listitem>Subtitle &mdash; a file containing subtitle which will be
 superimposed on the image of the DCP.  These can be
-<guilabel>.srt</guilabel>, <guilabel>.ssa</guilabel> or <guilabel>.xml</guilabel>
+<guilabel>.srt</guilabel>, <guilabel>.ssa</guilabel>, <guilabel>.ass</guilabel> or <guilabel>.xml</guilabel>
 files.</listitem>
 
 <listitem>DCP &mdash; an existing DCP.</listitem>
 files.</listitem>
 
 <listitem>DCP &mdash; an existing DCP.</listitem>
@@ -828,12 +833,25 @@ The <guilabel>Video</guilabel> tab controls properties of the image, as shown in
 </figure>
 
 
 </figure>
 
 
+<!-- ============================================================== -->
+<section>
+<title>Refer to existing DCP</title>
+
+<para>
+This option is only applicable if the selected content is an existing
+DCP.  It allows you to get the video content from the existing DCP by
+referencing it (rather than copying).  See <xref
+linkend="sec-overlay"/>.
+</para>
+
+</section>
+
 <!-- ============================================================== -->
 <section>
 <title>Image type</title>
 
 <para>
 <!-- ============================================================== -->
 <section>
 <title>Image type</title>
 
 <para>
-The first option on this tab is the &lsquo;type&rsquo; of the video.
+The next option on this tab is the &lsquo;type&rsquo; of the video.
 This specifies how DCP-o-matic should interpret the video's image.
 <guilabel>2D</guilabel> is the default; this just takes the video
 image as a standard 2D frame.  The <guilabel>3D
 This specifies how DCP-o-matic should interpret the video's image.
 <guilabel>2D</guilabel> is the default; this just takes the video
 image as a standard 2D frame.  The <guilabel>3D
@@ -1051,7 +1069,6 @@ The <guilabel>Audio</guilabel> tab controls properties of the image, as shown in
   </mediaobject>
 </figure>
 
   </mediaobject>
 </figure>
 
-
 <!-- ============================================================== -->
 <section>
 <title>The audio map</title>
 <!-- ============================================================== -->
 <section>
 <title>The audio map</title>
@@ -1156,7 +1173,20 @@ shows the mapping of a 5.1 source into a 5.1 DCP.
 
 <!-- ============================================================== -->
 <section>
 
 <!-- ============================================================== -->
 <section>
-<title>Other controls</title>
+  <title>Other controls</title>
+
+<para>
+The <guilabel>Refer to existing DCP</guilabel> checkbox isonly
+applicable if the selected content is an existing DCP.  It allows you
+to get the audio content from the existing DCP by referencing it
+(rather than copying).  See <xref linkend="sec-overlay"/>.
+</para>
+
+<para>
+<guilabel>Show graphs of audio levels</guilabel> will analyse the
+audio of the selected content and plot it on a graph.  See <xref
+linkend="sec-show-audio"/> for more details.
+</para>
 
 <para>
 &lsquo;Audio Gain&rsquo; is used to alter the volume of the
 
 <para>
 &lsquo;Audio Gain&rsquo; is used to alter the volume of the
@@ -1317,6 +1347,11 @@ frame) than those typically used for DCP, so it is often useful to
 scale such subtitles down using these controls.
 </para>
 
 scale such subtitles down using these controls.
 </para>
 
+<para>
+The <guilabel>Line spacing</guilabel> control adjusts the line spacing
+of the subtitles.  This only works for non-embedded (text) subtitles.
+</para>
+
 <para>
 The <guilabel>Stream</guilabel> control changes the subtitle stream
 that is used when the content has more than one.
 <para>
 The <guilabel>Stream</guilabel> control changes the subtitle stream
 that is used when the content has more than one.
@@ -1385,11 +1420,17 @@ should be displayed using this control.
 </para>
 
 <para>
 </para>
 
 <para>
-<guilabel>Trim from start</guilabel> specifies the amount that should be trimmed from the start of the content.
+<guilabel>Trim from start</guilabel> specifies the amount that should
+be trimmed from the start of the content.  You can set this amount to
+trim up to the current preview position by clicking <guilabel>Trim up
+to current position</guilabel>.
 </para>
 
 <para>
 </para>
 
 <para>
-<guilabel>Trim from end</guilabel> specifies the amount that should be trimmed from the end of the content.
+<guilabel>Trim from end</guilabel> specifies the amount that should be
+trimmed from the end of the content.  You can set this amount to trim
+after the current preview position by clicking <guilabel>Trim after to
+current position</guilabel>.
 </para>
 
 <para>
 </para>
 
 <para>
@@ -1804,7 +1845,7 @@ you must specify a reel length in Gb.  Then no file in the DCP will be larger th
 
 
 <!-- ============================================================== -->
 
 
 <!-- ============================================================== -->
-<section>
+<section xml:id="sec-show-audio">
 <title>Show audio</title>
 
 <para>
 <title>Show audio</title>
 
 <para>
@@ -2004,7 +2045,7 @@ linkend="fig-kdm"/>.
   <title>KDM dialog</title>
   <mediaobject>
     <imageobject>
   <title>KDM dialog</title>
   <mediaobject>
     <imageobject>
-      <imagedata fileref="screenshots/kdm&scs;"/>
+      <imagedata scale="40" fileref="screenshots/kdm&scs;"/>
     </imageobject>
   </mediaobject>
 </figure>
     </imageobject>
   </mediaobject>
 </figure>
@@ -2144,7 +2185,7 @@ DCP-o-matic.  Its window is shown in <xref linkend="fig-kdm-creator"/>.
   <title>The KDM creator</title>
   <mediaobject>
     <imageobject>
   <title>The KDM creator</title>
   <mediaobject>
     <imageobject>
-      <imagedata fileref="screenshots/kdm-creator&scs;"/>
+      <imagedata scale="35" fileref="screenshots/kdm-creator&scs;"/>
     </imageobject>
   </mediaobject>
 </figure>
     </imageobject>
   </mediaobject>
 </figure>
@@ -2431,13 +2472,19 @@ be used when targeting a KDM at DCP-o-matic.
 If you want to import an encrypted DCP you will need to give the
 decryption certificate to the distributor of the DCP so that they can
 generate a DKDM for you.  You can save this certificate to disk by
 If you want to import an encrypted DCP you will need to give the
 decryption certificate to the distributor of the DCP so that they can
 generate a DKDM for you.  You can save this certificate to disk by
-clicking <guilabel>Export DCP decryption certificate...</guilabel>.  As
-with the signing chain, DCP-o-matic will create a certificate chain
+clicking <guilabel>Export DCP decryption certificate...</guilabel>.
+As with the signing chain, DCP-o-matic will create a certificate chain
 and private key for you.  You can also choose to load your own
 certificates and key or re-make the chain and key with new, random
 values.
 </para>
 
 and private key for you.  You can also choose to load your own
 certificates and key or re-make the chain and key with new, random
 values.
 </para>
 
+<para>
+Clicking <guilabel>Export DCP decryption chain...</guilabel> will
+export the whole certificate chain, rather than just the leaf
+certificate.
+</para>
+
 </section>
 
 <!-- ============================================================== -->
 </section>
 
 <!-- ============================================================== -->
@@ -2580,6 +2627,14 @@ JPEG2000 data only on encoding servers and not on the host.  We
 suggest you leave this un-ticked unless you have a good reason to do otherwise.
 </para>
 
 suggest you leave this un-ticked unless you have a good reason to do otherwise.
 </para>
 
+<para>
+With the filename format fields you can adjust the filenames that are
+used for metadata (CPL and PKL files) and assets (MXF and subtitle
+files).  Below each field there is a list of the &lsquo;magic&rsquo;
+values that you can use in the format and an example of a filename
+that you might see with your current settings.
+</para>
+
 <para>
 The four checkboxes labelled <guilabel>Log</guilabel> control what
 sort of messages DCP-o-matic writes to its log file when creating a
 <para>
 The four checkboxes labelled <guilabel>Log</guilabel> control what
 sort of messages DCP-o-matic writes to its log file when creating a
index 53170e0e2b1d0d99f50e7c58d1547b5719f2560c..467c353035e629ce1c7e84e54de7d9a59b59ea8b 100644 (file)
Binary files a/doc/manual/screenshots/add-file.png and b/doc/manual/screenshots/add-file.png differ
index 329127bf582c15527af3c87076fbe62e4e7a1f8b..798d91e7c9381567098b35c4c6536ce3d1eef6bd 100644 (file)
Binary files a/doc/manual/screenshots/audio-tab.png and b/doc/manual/screenshots/audio-tab.png differ
index 21b0c6e3979988379da58bd0f9a8aae5912837df..9851e6760447159641a624a12d5ace16597ff045 100644 (file)
Binary files a/doc/manual/screenshots/dcp-tab.png and b/doc/manual/screenshots/dcp-tab.png differ
index fecc4b6bc54ae12e7db8a86a675dd1897e46ea2b..a03de7d8c32294a34fc523fcd8196ad964d1fbb4 100644 (file)
Binary files a/doc/manual/screenshots/examine-content.png and b/doc/manual/screenshots/examine-content.png differ
index 54eb670db8cfda986b9d19bb14cdb4f80a2ba01d..cbedb1ea7a035ad79aa90405b2cfcd424651edbb 100644 (file)
Binary files a/doc/manual/screenshots/prefs-advanced.png and b/doc/manual/screenshots/prefs-advanced.png differ
index 53b9589beaf2b263da808f271f351ff6dc5051c8..969d44833a06734d6495e00f10badf75f8a1ba81 100644 (file)
Binary files a/doc/manual/screenshots/prefs-defaults.png and b/doc/manual/screenshots/prefs-defaults.png differ
index 15281cff5ebbea69691d9566141febf16dead7c9..ed9ba60a5e59a3216999da042dccbfda25f1d391 100644 (file)
Binary files a/doc/manual/screenshots/prefs-kdm-email.png and b/doc/manual/screenshots/prefs-kdm-email.png differ
index 6c552429466526a17c3ef45e079174d74e3d043c..9be07e71f91f06b8e604f4e67f25ea861a51701e 100644 (file)
Binary files a/doc/manual/screenshots/prefs-keys.png and b/doc/manual/screenshots/prefs-keys.png differ
index ae0ab66abdb165729c98d3dd680af3349f93f35f..95621b4a5084e28bde26a0babb34e20cc0993281 100644 (file)
Binary files a/doc/manual/screenshots/prefs-servers.png and b/doc/manual/screenshots/prefs-servers.png differ
index 0dbeb9bb060e3ebd1f18af02f67e3d80110f7284..00643c3d87d46b8e6faed8cefebcc6d1c3446f68 100644 (file)
Binary files a/doc/manual/screenshots/subtitles-tab.png and b/doc/manual/screenshots/subtitles-tab.png differ
index 94d60ca43eebc443dcecc3e19c12041d6cca8a11..2b5b314f31fbd53982edd5b2dfd16c0ac821ea61 100644 (file)
Binary files a/doc/manual/screenshots/timing-tab.png and b/doc/manual/screenshots/timing-tab.png differ
index 99bb4790a51fcf859892e77fc19f3824906d082d..fb6030708f17a94110ed4f70c1113a0b2f0d4bb6 100644 (file)
Binary files a/doc/manual/screenshots/video-tab.png and b/doc/manual/screenshots/video-tab.png differ