Document advanced preferences.

diff --git a/doc/manual/Makefile b/doc/manual/Makefile
index eb10af245a8005178eda2a3629e2b8acc6336b54..2e37c96be947144dacb3b218b8dd0215c556dbb8 100644 (file)
--- a/doc/manual/Makefile
+++ b/doc/manual/Makefile
@@ -8,6 +8,7 @@ SCREENSHOTS := file-new.png video-new-film.png still-new-film.png video-select-c
                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 \
                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 \

+               prefs-advanced.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
 
                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
 

diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index 8460c2cbcba632207c8c2b1b1addc496857a5572..dd0d3bf0cd2b858d038f28b8f40ef137e65b723d 100644 (file)
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -375,7 +375,7 @@ linkend="ch-files"/> for details about the files that DCP-o-matic creates.
 <para>
 Alternatively, if you have a projector or TMS that is accessible via
 SCP across your network, you can upload the content directly from
 <para>
 Alternatively, if you have a projector or TMS that is accessible via
 SCP across your network, you can upload the content directly from

-DCP-o-matic.  See the preferences in <xref linkend="sec-prefs-tms"/>.
+DCP-o-matic.  See the <xref linkend="sec-prefs-tms" endterm="sec-prefs-tms-short"/>.

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


@@ -1411,6 +1411,7 @@ into the DCP.  The default values should cause no problems.
 
 <section xml:id="sec-prefs-tms">
 <title>TMS</title>
 
 <section xml:id="sec-prefs-tms">
 <title>TMS</title>

+<titleabbrev xml:id="sec-prefs-tms-short">TMS preferences</titleabbrev>

 
 <para>
 The TMS tab (shown in <xref linkend="fig-prefs-tms"/>) gives some
 
 <para>
 The TMS tab (shown in <xref linkend="fig-prefs-tms"/>) gives some


@@ -1463,8 +1464,56 @@ DCP's title.
 </para>
 
 </section>
 </para>
 
 </section>

-</section>

 
 

+<section xml:id="sec-prefs-advanced">
+<title>Advanced</title>
+<titleabbrev xml:id="sec-prefs-advanced-short">Advanced preferences</titleabbrev>
+
+<para>
+The advanced preferences are shown in <xref linkend="fig-prefs-advanced"/>.
+</para>
+
+<figure id="fig-prefs-advanced"> 
+  <title>Advanced preferences</title> 
+  <mediaobject>
+    <imageobject> 
+      <imagedata fileref="screenshots/prefs-advanced&scs;"/>
+    </imageobject> 
+  </mediaobject>
+</figure>
+
+<para>
+<guilabel>Maximum JPEG2000 bandwidth</guilabel> specifies the maximum
+bit-rate of JPEG2000 that DCP-o-matic will allow you to create.  You
+are advised to leave this at 250Mbit/s in normal use for maximum DCP
+compatibility.
+</para>
+
+<para>
+<guilabel>Allow any DCP frame rate</guilabel> removes the limits on
+the DCP video frame rates that DCP-o-matic will create.  This may be
+useful for experimentation.  Again, you are strongly advised to leave
+this unticked for normal use.
+</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
+DCP.  It is useful to leave <guilabel>General</guilabel>,
+<guilabel>Warnings</guilabel> and <guilabel>Errors</guilabel> ticked
+as this makes the log files useful for tracking down bugs.
+</para>
+
+<para>
+The <guilabel>Timing</guilabel> checkbox will enable extra log entries
+to allow developers to investigate and optimize the speed of
+DCP-o-matic.  It will significantly increase the size of the log files
+that are generated, so in normal use it is best to leave this
+unticked.
+</para>
+
+</section>
+</section>

 </chapter>
 
 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" xml:id="ch-frame-rates">
 </chapter>
 
 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en" xml:id="ch-frame-rates">


@@ -1477,12 +1526,12 @@ however, always possible.
 </para>
 
 <section>
 </para>
 
 <section>

-<title>DCP rate limitations</title>
+<title>DCP frame rate limitations</title>

 
 <para>
 
 <para>

-There are some limitations to video and audio rates in DCPs.  This is
+There are some limitations to video and audio frame rates in DCPs.  This is

 complicated by the fact that not all projectors will play DCPs at the
 complicated by the fact that not all projectors will play DCPs at the

-same rates.  It is possible to create a DCP which one projector will
+same frame rates.  It is possible to create a DCP which one projector will

 play fine, but another (of a different type) will refuse to play, or
 even refuse to ingest.
 </para>
 play fine, but another (of a different type) will refuse to play, or
 even refuse to ingest.
 </para>


@@ -1567,6 +1616,15 @@ content will give a summary of what DCP-o-matic is doing with that
 content.
 </para>
 
 content.
 </para>
 

+<para>
+If you want to experiment with other non-standard frame rates, you can
+do so by ticking the <guilabel>Allow any DCP frame rate</guilabel> in
+the <guilabel>Advanced</guilabel> tab of the preferences dialogue (see the
+<xref linkend="sec-prefs-advanced" endterm="sec-prefs-advanced-short"/>).  You are strongly advised to
+use this only on your own equipment, and only for experimentation
+purposes.
+</para>
+

 </section>
 
 </chapter>
 </section>
 
 </chapter>

diff --git a/doc/manual/screenshots/prefs-advanced.png b/doc/manual/screenshots/prefs-advanced.png
new file mode 100644 (file)
index 0000000..b8db5f4
Binary files /dev/null and b/doc/manual/screenshots/prefs-advanced.png differ