Update documentation and CLI UI with hint info

[dcpomatic.git] / doc / manual / dcpomatic.xml

diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 4c31128fee7a2928289ad6a9d7d15576e98d7ffa..81321a83d4954e20918266c7145b7a13d107338e 100644 (file)
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -320,7 +320,20 @@ making the DCP.</para>
 
 <para>
 Choose <guilabel>Make DCP</guilabel> from the
 
 <para>
 Choose <guilabel>Make DCP</guilabel> from the

-<guilabel>Jobs</guilabel> menu.  DCP-o-matic will encode your DCP.
+<guilabel>Jobs</guilabel> menu.  Before encoding your DCP, DCP-o-matic
+will run a series of checks on your film to look for various conditions
+that might cause problems when playing back the DCP.  If any potential
+problems are found, DCP-o-matic will show you a list of hints.
+Each hint describes the condition that was found and gives
+advice on how to resolve it.  If hints are found and reported, you can
+either <guilabel>Make DCP</guilabel> anyway (without adjusting any
+settings), or <guilabel>Go back</guilabel> in order to make
+adjustments before encoding the DCP.
+</para>
+
+<para>
+If no hints were found (or you pressed <guilabel>Make DCP</guilabel>
+after hints were displayed), DCP-o-matic will encode your DCP.

 This may take some time (many hours in some cases).  While the job is
 in progress, DCP-o-matic will update you on how it is getting on with
 the progress bar in the bottom of its window, as shown in <xref
 This may take some time (many hours in some cases).  While the job is
 in progress, DCP-o-matic will update you on how it is getting on with
 the progress bar in the bottom of its window, as shown in <xref


@@ -485,8 +498,8 @@ DCP-o-matic and allows them to create a KDM for you.
 <para>
 To get DCP-o-matic's decryption certificate, open the Preferences
 dialogue (see <xref linkend="ch-preferences"/>) and go to the
 <para>
 To get DCP-o-matic's decryption certificate, open the Preferences
 dialogue (see <xref linkend="ch-preferences"/>) and go to the

-<guilabel>Keys</guilabel> tab.  Click the <guilabel>Export DCP
-decryption certificate...</guilabel> button at the bottom of this tab
+<guilabel>Keys</guilabel> tab.  Click the <guilabel>Export KDM
+decryption leaf certificate...</guilabel> button at the top of this tab

 and save the certificate.  Send this certificate to the KDM creators
 and they can make a KDM to allow DCP-o-matic to decrypt the DCP.
 </para>
 and save the certificate.  Send this certificate to the KDM creators
 and they can make a KDM to allow DCP-o-matic to decrypt the DCP.
 </para>


@@ -1730,8 +1743,16 @@ generates and modify it, click <guilabel>Copy as name</guilabel> and
 the ISDCF name will be copied into the <guilabel>Name</guilabel> box.
 You can then edit it as you wish.  The DCP name should not matter (in
 that it should not affect how the DCP ingests or plays) but
 the ISDCF name will be copied into the <guilabel>Name</guilabel> box.
 You can then edit it as you wish.  The DCP name should not matter (in
 that it should not affect how the DCP ingests or plays) but

-projectionists will appreciate it if you use the standard naming
-scheme as it makes it easier to identify details of the content.
+projectionists will appreciate it if you use the
+<ulink url="https://registry-page.isdcf.com/illustratedguide/">standard naming scheme</ulink>
+as it makes it easier to identify details of the content.
+</para>
+
+<para>
+If there is spoken language in your project's audio you can tick the
+<guilabel>Audio Language</guilabel> checkbox and then specify the language
+of that audio.  This information will be used for the ISDCF name, written into
+the DCP cover sheet, and added as metadata to the audio MXF files in the DCP.

 </para>
 
 <para>
 </para>
 
 <para>


@@ -2375,7 +2396,6 @@ emailed to the appropriate cinema email addresses.  Click
 
 <section>
 <title>Creating KDMs using a DKDM</title>
 
 <section>
 <title>Creating KDMs using a DKDM</title>

-</section>

 
 <para>
 It can be inconvenient to need a whole DCP-o-matic project just to
 
 <para>
 It can be inconvenient to need a whole DCP-o-matic project just to


@@ -2442,11 +2462,73 @@ a target certificate.  You can get DCP-o-matic's target certificate by
 opening <guilabel>Preferences</guilabel> and clicking <guilabel>Export
 DCP decryption certificate...</guilabel> in the <guilabel>Keys</guilabel>
 tab.
 opening <guilabel>Preferences</guilabel> and clicking <guilabel>Export
 DCP decryption certificate...</guilabel> in the <guilabel>Keys</guilabel>
 tab.

+</para>
+
+</section>
+
+<section>
+<title>Creating KDMs for a distributor</title>
+
+<para>
+Sometimes you have an encrypted DCP and you want to allow somebody else
+(for example, a distributor) to make KDMs for the DCP on your behalf.
+</para>
+
+<para>
+The normal way to do this is to send the distributor a KDM which they
+can use with their own KDM creation system.  Such a KDM is often called
+a DKDM (the &lsquo;D&rsquo; stands for <emphasis>Distribution</emphasis>).
+It is the same as a normal KDM except that it is made to work with another
+computer, rather than with a projection system.
+</para>
+
+<para>
+To make a DKDM for a distributor you will first need to ask them to send you
+a decryption certificate.  This should be a small file, usually with the extension
+<code>.pem</code>.
+</para>
+
+<para>
+Once you have the certificate, you will need to add a &lsquo;fake&rsquo; cinema
+and screen to the list in DCP-o-matic.  This is because making a KDM for another
+computer uses the same process internally as making one for a projection system,
+it's just that DCP-o-matic does not have a nice way to present that.
+</para>
+
+<para>
+In either the KDM window in the main DCP-o-matic, or the KDM creator, first add
+a new cinema by clicking <guilabel>Add Cinema...</guilabel>, giving it a name
+(perhaps the name of the distributor).
+</para>

 
 

+<para>
+Then select this new cinema and click <guilabel>Add Screen...</guilabel> to open
+the screen dialog box, as shown in <xref linkend="fig-add-screen"/>.
+</para>
+
+<figure id="fig-add-screen">
+  <title>Adding a screen</title>
+  <mediaobject>
+    <imageobject>
+      <imagedata scale="30" fileref="screenshots/add-screen&scs;"/>
+    </imageobject>
+  </mediaobject>
+</figure>
+
+<para>
+Here you can give any name (perhaps just &lsquo;DKDM&rsquo;).  Then click <guilabel>Get from file...</guilabel>
+and choose the certificate file that the distributor gave you.  Finally, click <guilabel>OK</guilabel>.
+</para>
+
+<para>
+Now you can create a KDM for this screen, and send it to the distributor.  Using that KDM the distributor
+can then make KDMs for your DCP for anybody (and also, of course, decrypt the DCP if they wanted to).

 </para>
 
 </section>
 
 </para>
 
 </section>
 

+</section>
+

 <section>
 <title>Encryption keys</title>
 
 <section>
 <title>Encryption keys</title>
 


@@ -2932,9 +3014,15 @@ KDM that is being sent; these strings are shown in <xref linkend="tab-kdm-magic"
 <entry><code>$CPL_NAME</code></entry><entry>DCP title</entry>
 </row>
 <row>
 <entry><code>$CPL_NAME</code></entry><entry>DCP title</entry>
 </row>
 <row>

+<entry><code>$CPL_FILENAME</code></entry><entry>Filename of the CPL</entry>
+</row>
+<row>

 <entry><code>$CINEMA_NAME</code></entry><entry>Cinema name</entry>
 </row>
 <row>
 <entry><code>$CINEMA_NAME</code></entry><entry>Cinema name</entry>
 </row>
 <row>

+<entry><code>$CINEMA_SHORT_NAME</code></entry><entry>First 14 characters of the cinema name</entry>
+</row>
+<row>

 <entry><code>$SCREENS</code></entry><entry>Name of screen or screens that KDMs are being generated for</entry>
 </row>
 <row>
 <entry><code>$SCREENS</code></entry><entry>Name of screen or screens that KDMs are being generated for</entry>
 </row>
 <row>