[digikam-doc] digikam: apply new patch from Wolfgang about Setup Template section

[Gilles Caulier]

Git commit 14495a8a762ab017de0fb8adbbe2a243b9788db3 by Gilles Caulier.
Committed on 12/10/2016 at 11:47.
Pushed by cgilles into branch 'master'.

apply new patch from Wolfgang about Setup Template section

M  +74   -10   digikam/using-setup-templates.docbook

http://commits.kde.org/digikam-doc/14495a8a762ab017de0fb8adbbe2a243b9788db3

diff --git a/digikam/using-setup-templates.docbook b/digikam/using-setup-templates.docbook
index 689dd0b..567d76b 100644
--- a/digikam/using-setup-templates.docbook
+++ b/digikam/using-setup-templates.docbook
@@ -2,16 +2,51 @@
     <title>Templates Settings</title>
 
     <para>
-        This page contains the default identity and copyright data as shown on the printscreen below. The data will be automatically written into the respective IPTC data fields if so selected during the download from the <link linkend="using-camera-rename">camera interface</link>. Also, if you call for database synchronisation, these data will be written into the IPTC fields.
+        The Metadata Templates Manager is meant to create and manage metadata templates which can be used in
+        <itemizedlist>
+            <listitem><para>
+                the <guilabel>Information</guilabel> tab of the <guilabel>Captions</guilabel> view of the Right Sidebar
+            </para></listitem>
+
+            <listitem><para>
+                    the <guilabel>On the Fly Operations (JPEG only)</guilabel> section of the <guilabel>Settings</guilabel> view of the Right Sidebar in the
+                    <menuchoice>
+                        <guimenu>Import</guimenu>
+                        <guimenuitem>Cameras</guimenuitem>
+                        <guimenuitem>OneOfMyCameras</guimenuitem>
+                    </menuchoice> 
+                    Window.
+            </para></listitem>
+        </itemizedlist>
     </para>
 
+    <para></para>
+
     <para>
-        <inlinemediaobject><imageobject>
+        <mediaobject><imageobject>
             <imagedata fileref="&path;using-setup-template-rights.png" format="PNG" />
-        </imageobject></inlinemediaobject>
+        </imageobject></mediaobject>
+    </para>
+
+    <para>
+        The top part shows a list of the already existing templates. The first row shows the title of the template, the second row shows the name of the author(s) in the <quote>Author Names</quote> field of that very template. To the right you have three editing buttons, below an input field for the template title. To create a new template you type a title in the input field and click the <guilabel>Add...</guilabel> button. The new template will appear in the list. To edit an existing template you select it in the list, then you edit it's fields (see next paragraph) and finally you click the <guilabel>Replace...</guilabel> button. You can as well type in a new title for the edited template and save the new version with the <guilabel>Add...</guilabel> button. To delete a template, very obviously, you select it in the list and click the <guilabel>Remove</guilabel> button.
+    </para>
+
+    <warning><para>
+        Note that all the changes you made to the templates will only be stored in the template file if you exit the settings dialog with <guilabel>OK</guilabel>! The <guilabel>Add...</guilabel> and <guilabel>Replace...</guilabel> buttons only change the template list in the RAM.
+    </para></warning>
+
+    <tip><para>
+        The template file can be found in ~/.local/share/digikam/ for manual backup or for managing different template sets by means of the file system.
+    </para></tip>
+
+    <para>
+        The rest of the window is divided into four tabs, grouping the metadata fields into <guilabel>Rights</guilabel>, <guilabel>Location</guilabel>, <guilabel>Contact</guilabel> and <guilabel>Subjects</guilabel>.
     </para>
 
-    <para>This is an extract of the IPTC specifications:</para>
+    <para>
+        The <guilabel>Rights</guilabel> tab (see above) contains the default identity and copyright data. This is an extract of the IPTC specifications for these fields:
+    </para>
 
     <itemizedlist>
 
@@ -37,22 +72,51 @@
 
     </itemizedlist>
 
+    <para></para>
+
     <para>
-        <inlinemediaobject><imageobject>
+        <mediaobject><imageobject>
             <imagedata fileref="&path;using-setup-template-location.png" format="PNG" />
-        </imageobject></inlinemediaobject>
+        </imageobject></mediaobject>
     </para>
 
     <para>
-        <inlinemediaobject><imageobject>
+        The fields in the <guilabel>Location</guilabel> tab are self explaining by their title and the gray hints in the empty fields. An a little bit more elaborate description can be found under 
+        <menuchoice>
+            <guimenu>Settings</guimenu>
+            <guimenuitem>Configure &digikam;</guimenuitem>
+            <guimenuitem>Metadata</guimenuitem>
+            <guimenuitem>Views</guimenuitem>
+            <guimenuitem>IPTC viewer</guimenuitem>
+        </menuchoice>
+    </para>
+
+    <para></para>
+
+    <para>
+        <mediaobject><imageobject>
             <imagedata fileref="&path;using-setup-template-contact.png" format="PNG" />
-        </imageobject></inlinemediaobject>
+        </imageobject></mediaobject>
     </para>
 
     <para>
-        <inlinemediaobject><imageobject>
+        The data in the <guilabel>Contact</guilabel> tab refer to the (lead) photographer under <quote>Author Names</quote> in the <guilabel>Rights</guilabel> tab.
+    </para>
+
+    <para></para>
+
+    <para>
+        <mediaobject><imageobject>
             <imagedata fileref="&path;using-setup-template-subjects.png" format="PNG" />
-        </imageobject></inlinemediaobject>
+        </imageobject></mediaobject>
+    </para>
+
+    <para>
+        In the <guilabel>Subjects</guilabel> tab you can assign one or more Subject Codes according to the IPTC Photo Metadata Standard to the template. If the first option <quote>Use standard reference code</quote> is selected you can choose a code from the drop down field and the meaning of it will then appear in the fields of the <quote>Use custom definition</quote> section. If you don't know the code for the subject you want to assign this way is a bit tedious since there are 1400 subjects in the standard. A better way is to look for your subject in <ulink url="http://show.newscodes.org/index.html">this URL</ulink>. Here you select <quote>Subject Codes</quote> and your language (English recommended) and click <quote>Show</quote>. In the diagram you scroll and make additional levels of an item visible by clicking on one of the fields. In the field right of the diagram you can find the code of the selected subject.
+    </para>
+
+    <para>
+        In general the IPTC Subject Codes are quite comprehensive but on the other hand a bit un-complete in some fields, ⪚ under Lifestyle and Leisure/Games you find just Go, chess, bridge and shogi. So you may want to add own subjects, even though they always remain private (or company) subjects. A way to do that in &digikam; is to first check <quote>Use standard reference code</quote> and select 10001004 which brings you to Lifestyle and Leisure/Games/shogi - just to stay in our example. Then you check <quote>Use custom definition</quote> and change the last digit of <quote>Reference:</quote> to 5 and the text in the <quote>Detail:</quote> filed to - say <quote>domino</quote>. You save this custom definition to the template by clicking <guilabel>Add...</guilabel> at the right side of the subjects list. Then you type in a template title (if it is a new template) and save the template by clicking <guilabel>Add...</guilabel> at the right side of the templates list. Don't mix up these two!
     </para>
 
 </sect2>