Some label copy-editing and more manual work.
authorCarl Hetherington <cth@carlh.net>
Mon, 14 Jan 2019 00:20:07 +0000 (00:20 +0000)
committerCarl Hetherington <cth@carlh.net>
Mon, 14 Jan 2019 00:20:07 +0000 (00:20 +0000)
16 files changed:
doc/manual/Makefile
doc/manual/dcpomatic.xml
doc/manual/screenshots/prefs-accounts.png
doc/manual/screenshots/prefs-advanced.png
doc/manual/screenshots/prefs-colour-conversions.png [deleted file]
doc/manual/screenshots/prefs-cover-sheet.png
doc/manual/screenshots/prefs-defaults.png
doc/manual/screenshots/prefs-email.png
doc/manual/screenshots/prefs-general.png
doc/manual/screenshots/prefs-kdm-email.png
doc/manual/screenshots/prefs-keys.png
doc/manual/screenshots/prefs-metadata.png [deleted file]
doc/manual/screenshots/prefs-notifications.png
doc/manual/screenshots/prefs-servers.png
doc/manual/screenshots/prefs-tms.png
src/wx/full_config_dialog.cc

index 9e74b4d..cb8c9bc 100644 (file)
@@ -9,7 +9,7 @@ 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 colour-conversion.png \
-               prefs-kdm-email.png prefs-colour-conversions.png prefs-metadata.png prefs-general.png prefs-tms.png \
+               prefs-kdm-email.png prefs-general.png prefs-tms.png \
                prefs-advanced.png prefs-defaults.png prefs-servers.png prefs-keys.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 \
index 1b9418c..1ee817b 100644 (file)
@@ -2769,10 +2769,37 @@ Note that for this to work on Doremi servers you will need to set the
 
 <!-- ============================================================== -->
 <section>
+<title>Email</title>
+
+<para>
+The Email tab is shown in <xref linkend="fig-prefs-email"/>.
+</para>
+
+<figure id="fig-prefs-email">
+  <title>Email preferences</title>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="screenshots/prefs-email&scs;"/>
+    </imageobject>
+  </mediaobject>
+</figure>
+
+<para>
+These settings are used when DCP-o-matic sends emails.
+</para>
+
+<para>
+  <guilabel>Outgoing mail server</guilabel> should be the host name of a mail (SMTP) server that DCP-o-matic can use.  You can also specify the port that DCP-o-matic should use.  <guilabel>User name</guilabel> and <guilabel>Password</guilabel> are the credentials that are required to send email through the server you have specified.
+</para>
+
+</section>
+
+<!-- ============================================================== -->
+<section>
 <title>KDM email</title>
 
 <para>
-The KDM email is shown in <xref linkend="fig-prefs-kdm-email"/>.
+The KDM email tab is shown in <xref linkend="fig-prefs-kdm-email"/>.
 </para>
 
 <figure id="fig-prefs-kdm-email">
@@ -2823,6 +2850,68 @@ The <guilabel>Reset to default text</guilabel> will replace the current KDM emai
 
 <!-- ============================================================== -->
 <section>
+<title>Accounts</title>
+
+<para>
+The Accounts tab is shown in <xref linkend="fig-prefs-accounts"/>.
+</para>
+
+<figure id="fig-prefs-accounts">
+  <title>Accounts preferences</title>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="screenshots/prefs-accounts&scs;"/>
+    </imageobject>
+  </mediaobject>
+</figure>
+
+<para>
+DCP-o-matic can download projector certificates from the Barco and
+Christie websites if you have the appropriate credentials.  Enter your
+usernames and passwords.
+</para>
+
+</section>
+
+
+<!-- ============================================================== -->
+<section>
+<title>Notifications</title>
+
+<para>
+The Notifications tab is shown in <xref linkend="fig-prefs-notifications"/>.
+</para>
+
+<figure id="fig-prefs-notifications">
+  <title>Notifications preferences</title>
+  <mediaobject>
+    <imageobject>
+      <imagedata fileref="screenshots/prefs-notifications&scs;"/>
+    </imageobject>
+  </mediaobject>
+</figure>
+
+<para>
+DCP-o-matic can notify the user when jobs have completed.  These
+notifications can be either or both of a message box on-screen (if
+<guilabel>Message box</guilabel> is ticked) and email (if
+<guilabel>Email</guilabel> is ticked).  If you enable email
+notifications you can fill in the details of the emails you want to
+send.
+</para>
+
+<para>
+The bottom box in the tab is the contents of the email that should
+be sent.  DCP-o-matic will replace the &lsquo;magic&rsquo; strings
+<code>$JOB_NAME</code> and <code>$JOB_STATUS</code> in the with the
+details of the job that has completed.
+</para>
+
+</section>
+
+
+<!-- ============================================================== -->
+<section>
 <title>Cover sheet</title>
 
 <para>
index e9ab537..e919e6a 100644 (file)
Binary files a/doc/manual/screenshots/prefs-accounts.png and b/doc/manual/screenshots/prefs-accounts.png differ
index 538dfc1..2bc76a2 100644 (file)
Binary files a/doc/manual/screenshots/prefs-advanced.png and b/doc/manual/screenshots/prefs-advanced.png differ
diff --git a/doc/manual/screenshots/prefs-colour-conversions.png b/doc/manual/screenshots/prefs-colour-conversions.png
deleted file mode 100644 (file)
index 93b0dcf..0000000
Binary files a/doc/manual/screenshots/prefs-colour-conversions.png and /dev/null differ
index c1103a5..b6daa26 100644 (file)
Binary files a/doc/manual/screenshots/prefs-cover-sheet.png and b/doc/manual/screenshots/prefs-cover-sheet.png differ
index 476db85..a1e9559 100644 (file)
Binary files a/doc/manual/screenshots/prefs-defaults.png and b/doc/manual/screenshots/prefs-defaults.png differ
index 122540f..5fd7f5c 100644 (file)
Binary files a/doc/manual/screenshots/prefs-email.png and b/doc/manual/screenshots/prefs-email.png differ
index b726df1..211c4ce 100644 (file)
Binary files a/doc/manual/screenshots/prefs-general.png and b/doc/manual/screenshots/prefs-general.png differ
index 6627c2e..b23d797 100644 (file)
Binary files a/doc/manual/screenshots/prefs-kdm-email.png and b/doc/manual/screenshots/prefs-kdm-email.png differ
index d9b1387..2cb6644 100644 (file)
Binary files a/doc/manual/screenshots/prefs-keys.png and b/doc/manual/screenshots/prefs-keys.png differ
diff --git a/doc/manual/screenshots/prefs-metadata.png b/doc/manual/screenshots/prefs-metadata.png
deleted file mode 100644 (file)
index c2492c7..0000000
Binary files a/doc/manual/screenshots/prefs-metadata.png and /dev/null differ
index 79b45f5..3988a33 100644 (file)
Binary files a/doc/manual/screenshots/prefs-notifications.png and b/doc/manual/screenshots/prefs-notifications.png differ
index f50227c..15bab4f 100644 (file)
Binary files a/doc/manual/screenshots/prefs-servers.png and b/doc/manual/screenshots/prefs-servers.png differ
index 4e0ba55..2ebb22d 100644 (file)
Binary files a/doc/manual/screenshots/prefs-tms.png and b/doc/manual/screenshots/prefs-tms.png differ
index 2f1db11..4a1561b 100644 (file)
@@ -769,11 +769,11 @@ private:
                        table->Add (s, 1, wxEXPAND | wxALL);
                }
 
-               add_label_to_sizer (table, _panel, _("Mail user name"), true);
+               add_label_to_sizer (table, _panel, _("User name"), true);
                _user = new wxTextCtrl (_panel, wxID_ANY);
                table->Add (_user, 1, wxEXPAND | wxALL);
 
-               add_label_to_sizer (table, _panel, _("Mail password"), true);
+               add_label_to_sizer (table, _panel, _("Password"), true);
                _password = new wxTextCtrl (_panel, wxID_ANY);
                table->Add (_password, 1, wxEXPAND | wxALL);
 
@@ -965,7 +965,7 @@ public:
                table->AddGrowableCol (1, 1);
                _panel->GetSizer()->Add (table, 1, wxEXPAND | wxALL, _border);
 
-               add_label_to_sizer (table, _panel, _("certificates.barco.com username"), true);
+               add_label_to_sizer (table, _panel, _("certificates.barco.com user name"), true);
                _barco_username = new wxTextCtrl (_panel, wxID_ANY);
                table->Add (_barco_username, 1, wxEXPAND | wxALL);
 
@@ -973,7 +973,7 @@ public:
                _barco_password = new wxTextCtrl (_panel, wxID_ANY);
                table->Add (_barco_password, 1, wxEXPAND | wxALL);
 
-               add_label_to_sizer (table, _panel, _("certificates.christiedigital.com username"), true);
+               add_label_to_sizer (table, _panel, _("certificates.christiedigital.com user name"), true);
                _christie_username = new wxTextCtrl (_panel, wxID_ANY);
                table->Add (_christie_username, 1, wxEXPAND | wxALL);