[documentation/digikam-doc/sphinx] /: add captions view section
Gilles Caulier
null at kde.org
Sat Dec 17 16:09:22 GMT 2022
Git commit 9e5cee7d5d3dcf47aa61c9f4dba7b573a9a7dc02 by Gilles Caulier.
Committed on 17/12/2022 at 16:09.
Pushed by cgilles into branch 'sphinx'.
add captions view section
D +- -- attic/digikam/using-sidebar-captions.png
D +0 -220 attic/digikam/using-sidebar-colors.docbook
D +- -- attic/digikam/using-sidebar-histogramsample1.png
D +- -- attic/digikam/using-sidebar-histogramsample2.png
D +- -- attic/digikam/using-sidebar-histogramsample3.png
D +0 -58 attic/digikam/using-sidebar-intro.docbook
D +0 -66 attic/digikam/using-sidebar-maps.docbook
D +0 -241 attic/digikam/using-sidebar-metadata.docbook
D +0 -48 attic/digikam/using-sidebar-properties.docbook
D +0 -25 attic/digikam/using-sidebar.docbook
M +4 -0 index.rst
M +1 -0 right_sidebar.rst
A +82 -0 right_sidebar/captions_view.rst
A +- -- right_sidebar/images/using-sidebar-captions.png
A +- -- right_sidebar/images/using-sidebar-information.png
A +- -- right_sidebar/images/using-sidebar-tags.png
https://invent.kde.org/documentation/digikam-doc/commit/9e5cee7d5d3dcf47aa61c9f4dba7b573a9a7dc02
diff --git a/attic/digikam/using-sidebar-captions.png b/attic/digikam/using-sidebar-captions.png
deleted file mode 100644
index ab2809f..0000000
Binary files a/attic/digikam/using-sidebar-captions.png and /dev/null differ
diff --git a/attic/digikam/using-sidebar-colors.docbook b/attic/digikam/using-sidebar-colors.docbook
deleted file mode 100644
index 7277c77..0000000
--- a/attic/digikam/using-sidebar-colors.docbook
+++ /dev/null
@@ -1,220 +0,0 @@
-<sect2 id="using-sidebar-colors">
-<title>Colors</title>
-
- <para>
- The colors sidebar has two sub tabs <guilabel>Color</guilabel> and <guilabel>ICC Profile</guilabel>. Here are more details about <link linkend="using-iccprofile">Color Management</link>
- </para>
-
- <sect3 id="using-histogramviewer">
- <title>Histogram Viewer</title>
-
- <anchor id="histogramviewer.anchor"/>
-
- <para>
- The histogram for an image shows the amount of each color that is present and their different amplitudes within the image. If your photograph has a color cast you might be able to see what is wrong by looking at the histogram.
- </para>
-
- <para>
- The Histogram Viewer shows the statistical distribution of color values in the current image. It is purely informational: nothing you do with it will cause any change to the image. If you want to perform a histogram based color correction, use for example Color Balance, Levels Adjust or Curves Adjust in the Image Editor.
- </para>
-
- <para>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="&path;using-sidebar-histogramview.png" format="PNG" />
- </imageobject>
- </inlinemediaobject>
- </para>
-
- <para>
- An image can be decomposed into <guilabel>Red</guilabel>, <guilabel>Green</guilabel> and <guilabel>Blue</guilabel> color channels. <guilabel>Alpha</guilabel> channel is a Layer in the image that supports transparency (like PNG or &GIF; images). Each channel supports a range of intensity levels from 0 to 255 (integer valued). Thus, a black pixel is encoded by 0 on all color channels; a white pixel by 255 on all color channels. A transparent pixel is encoded by 0 on the alpha channel; an opaque pixel by 255.
- </para>
-
- <para>
- The Histogram Viewer allows you to view each channel separately:
-
- <itemizedlist>
-
- <listitem><para>
- <guilabel>Luminosity</guilabel>: shows the distribution of brightness values.
- </para></listitem>
-
- <listitem><para>
- <guilabel>Red</guilabel>, <guilabel>Green</guilabel>, <guilabel>Blue</guilabel>: show the distribution of intensity levels for the Red, Green, or Blue channels respectively.
- </para></listitem>
-
- <listitem><para>
- <guilabel>Alpha</guilabel>: shows the distribution of opacity levels. If the layer is completely opaque or completely transparent, the histogram will consist of a single bar on the left or right edge.
- </para></listitem>
-
- <listitem><para>
- <guilabel>Colors</guilabel>: shows the <guilabel>Red</guilabel>, <guilabel>Green</guilabel>, and <guilabel>Blue</guilabel> histograms superposed, so that you can see all of the color distribution information in a single view.
- </para></listitem>
-
- </itemizedlist>
-
- </para>
-
- <para>
- With the <guilabel>Scale</guilabel> option you can determine whether the histogram will be displayed using a linear or logarithmic Y axis. For images taken with a digital camera, the <guilabel>Linear</guilabel> mode is usually the most useful. However, for images that contain substantial areas of constant color a <guilabel>Linear</guilabel> histogram will often be dominated by a single bar. In this case a <guilabel>Logarithmic</guilabel> histogram will be more useful.
- </para>
-
- <para>
- You can restrict the analysis of the <guilabel>Statistics</guilabel> field shown at the bottom of the dialog to a limited range of values if you wish. You can set the range in one of two ways:
-
- <itemizedlist>
-
- <listitem><para>
- Click and drag the pointer across the histogram display area, from the lowest level to the highest level of the range you want.
- </para></listitem>
-
- <listitem><para>
- Use the spin button entries below the histogram area. Left entry is bottom of range and right entry is top of range.
- </para></listitem>
-
- </itemizedlist>
-
- </para>
-
- <para>
- The statistics shown at the bottom of the Histogram Viewer describe the distribution of channel values, restricted to the selected range. These are:
-
- <itemizedlist>
-
- <listitem><para>
- The number of pixels in the image.
- </para></listitem>
-
- <listitem><para>
- The number whose values fall within the selected range.
- </para></listitem>
-
- <listitem><para>
- The mean.
- </para></listitem>
-
- <listitem><para>
- The standard deviation.
- </para></listitem>
-
- <listitem><para>
- The median of the selected histogram portion.
- </para></listitem>
-
- <listitem><para>
- The percentage whose values fall within the selected range.
- </para></listitem>
-
- <listitem><para>
- The color depth of the image.
- </para></listitem>
-
- <listitem><para>
- Alpha channel in the image.
- </para></listitem>
-
- <listitem><para>
- The source of the histogram, either <guilabel>Full Image</guilabel> or <guilabel>Image Region</guilabel> if you have selected an area of the image in the Editor.
- </para></listitem>
-
- </itemizedlist>
-
- </para>
-
- </sect3>
-
- <sect3 id="using-histogram">
- <title>How To Use an Histogram</title>
-
- <para>
- Histograms are a graphical means to assess the accuracy of an image shown on the screen. The graph represents the 3 regions of the photograph brightness:
-
- <itemizedlist>
-
- <listitem><para>
- (1) : the shadows-tone on the left.
- </para></listitem>
-
- <listitem><para>
- (2) : the middle-tone in the middle.
- </para></listitem>
-
- <listitem><para>
- (3) : the highlights-tone on the right.
- </para></listitem>
-
- </itemizedlist>
-
- <example>
- <title>An Image Histogram in All Colors Mode</title>
- <screenshot>
- <screeninfo>An Image Histogram in All Colors Mode</screeninfo>
- <mediaobject><imageobject>
- <imagedata fileref="&path;using-sidebar-histogramdescription.png" format="PNG" />
- </imageobject></mediaobject>
- </screenshot>
- </example>
-
- The distribution of the graph, where the spikes and bulges are clustered, indicates whether the image is too dark, too bright, or well-balanced.
- </para>
-
- <para>
- With an under exposed photograph, the histogram will have a distribution of brightness that tends to be mostly on the left of the graph.
-
- <example>
- <title>An Under Exposed Photograph</title>
- <screenshot>
- <screeninfo>An Under Exposed Photograph</screeninfo>
- <mediaobject><imageobject>
- <imagedata fileref="&path;using-sidebar-histogramsample1.png" format="PNG" />
- </imageobject></mediaobject>
- </screenshot>
- </example>
-
- With an over exposed photograph, the histogram will have the bulge showing the brightness distributed mostly towards the right of the graph.
-
- <example>
- <title>An Over Exposed Photograph</title>
- <screenshot>
- <screeninfo>An Over Exposed Photograph</screeninfo>
- <mediaobject><imageobject>
- <imagedata fileref="&path;using-sidebar-histogramsample3.png" format="PNG" />
- </imageobject></mediaobject>
- </screenshot>
- </example>
-
- With a correctly exposed photograph, the histogram will have a distribution of brightness that will be most prominent near the center part of the graph.
-
- <example>
- <title>A Correctly Exposed Photograph</title>
- <screenshot>
- <screeninfo>A Correctly Exposed Photograph</screeninfo>
- <mediaobject><imageobject>
- <imagedata fileref="&path;using-sidebar-histogramsample2.png" format="PNG" />
- </imageobject></mediaobject>
- </screenshot>
- </example>
-
- </para>
-
- <para>
- Important: not all photographs have to exhibit this bulge in the center part of their histogram. Much depends on the subject of the photograph. In some cases, it might be appropriate for the histogram to show a peak at one end or the other, or both.
- </para>
-
- <para>
- The histogram is a reliable way of deciding whether or not a photograph is correctly exposed. Should the histogram show an over or under exposure, an <link linkend="editor-color-exposure">Exposure Correction Tool</link> should be used to fix the photograph.
- </para>
-
- </sect3>
-
-</sect2>
-
-<!--
-Local Variables:
-mode: sgml
-sgml-minimize-attributes:nil
-sgml-general-insert-case:lower
-sgml-indent-step:0
-sgml-indent-data:nil
-End:
--->
diff --git a/attic/digikam/using-sidebar-histogramsample1.png b/attic/digikam/using-sidebar-histogramsample1.png
deleted file mode 100644
index 41d557b..0000000
Binary files a/attic/digikam/using-sidebar-histogramsample1.png and /dev/null differ
diff --git a/attic/digikam/using-sidebar-histogramsample2.png b/attic/digikam/using-sidebar-histogramsample2.png
deleted file mode 100644
index c1cd83b..0000000
Binary files a/attic/digikam/using-sidebar-histogramsample2.png and /dev/null differ
diff --git a/attic/digikam/using-sidebar-histogramsample3.png b/attic/digikam/using-sidebar-histogramsample3.png
deleted file mode 100644
index 8169819..0000000
Binary files a/attic/digikam/using-sidebar-histogramsample3.png and /dev/null differ
diff --git a/attic/digikam/using-sidebar-intro.docbook b/attic/digikam/using-sidebar-intro.docbook
deleted file mode 100644
index dfaf896..0000000
--- a/attic/digikam/using-sidebar-intro.docbook
+++ /dev/null
@@ -1,58 +0,0 @@
-<sect2 id="using-sidebar-intro">
-<title>Introduction to the Right Sidebar</title>
-
- <para>
- The &digikam; main window has a sidebar at the right border providing important information and actions of the selected images. This same sidebar is also available in the &digikam; Image Editor (except the <guilabel>Filters</guilabel> tab). It can be displayed by respectively clicking on one of the eight tabs:
- </para>
-
- <para>
- <itemizedlist>
-
- <listitem><para>
- <link linkend="using-sidebar-properties">Properties</link> : File and image properties, key shooting parameters.
- </para></listitem>
-
- <listitem><para>
- <link linkend="using-sidebar-metadata">Metadata</link> : EXIF, Makernotes, IPTC and XMP data.
- </para></listitem>
-
- <listitem><para>
- <link linkend="using-sidebar-colors">Colors</link> : Histograms and embedded ICC profiles.
- </para></listitem>
-
- <listitem><para>
- <link linkend="using-sidebar-maps">Maps</link> : Marble widget shows GPS location.
- </para></listitem>
-
- <listitem><para>
- <link linkend="using-sidebar-captions">Captions</link> : Comments, Date & Time setting, Labels, Rating, Tags, selected metadata.
- </para></listitem>
-
- <listitem><para>
- <link linkend="using-sidebar-versions">Versions</link> : Image history.
- </para></listitem>
-
- <listitem><para>
- <link linkend="using-sidebar-filters">Filters</link> : Filters to apply to main window selection.
- </para></listitem>
-
- <listitem><para>
- <link linkend="using-sidebar-tools">Tools</link> : An optional contextual view dedicated to group by categories all main tools available.
- </para></listitem>
-
- </itemizedlist>
-
- Clicking successively onto the same tab will make the sidebar pop up or fold back into the border.
- </para>
-
-</sect2>
-
-<!--
-Local Variables:
-mode: sgml
-sgml-minimize-attributes:nil
-sgml-general-insert-case:lower
-sgml-indent-step:0
-sgml-indent-data:nil
-End:
--->
diff --git a/attic/digikam/using-sidebar-maps.docbook b/attic/digikam/using-sidebar-maps.docbook
deleted file mode 100644
index 7fdbc40..0000000
--- a/attic/digikam/using-sidebar-maps.docbook
+++ /dev/null
@@ -1,66 +0,0 @@
-<sect2 id="using-sidebar-maps">
- <title>Maps</title>
-
- <para>
- There are four tools regarding geolocation in &digikam-app; and two in &showfoto;:
- </para>
- <orderedlist numeration="arabic">
-
- <listitem><para>
- The Map mode of the Image Area which displays images with GPS data on a map depending on the selection on the Left Sidebar, ⪚ the images in the album you selected in the Album View, the images with a certain tag assigned (selected in the Tag View), with a certain label and so on. This is only available in &digikam-app;.
- </para></listitem>
-
- <listitem><para>
- The Map View on the Left Sidebar of &digikam-app; which is the search tool for finding images by their GPS data. This is also only available in &digikam-app;.
- </para></listitem>
-
- <listitem><para>
- The <link linkend="tool-geolocationeditor">Geolocation Editor</link> which is accessible via <menuchoice><shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>G</keycap></keycombo></shortcut><guimenu>Item</guimenu><guimenuitem>Edit Geolocation...</guimenuitem></menuchoice>
- (<menuchoice><guimenu>File</guimenu><guimenuitem>Edit Geolocation...</guimenuitem></menuchoice> in &showfoto;) and allows to set and to edit GPS data.
- </para></listitem>
-
- <listitem><para>
- The Map tab on the Right Sidebar we are talking about here which shows the location of the image on a map and is purely informative.
- </para></listitem>
-
- </orderedlist>
- <para>
- All four are based on the &marble; widget.
- </para>
-
- <para>
- This tab shows a map of orientation where you will find a marker or a thumbnail to indicate the GPS location of the selected image. The GPS coordinates and the time information are displayed below the widget. You can zoom in and out with the mouse wheel by either scrolling it or hold and drag it. Pan by holding down the left mouse button.
- </para>
-
- <para>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="&path;using-sidebar-metadatagps.png" format="PNG"/>
- </imageobject>
- </inlinemediaobject>
- </para>
-
- <para>
- For navigating on the map refer to &marble; handbook, Chapter 2. The meaning of <quote>GPS</quote> and functions and buttons that apply to all three geolocation parts are described in the <link linkend="tool-geolocationeditor">Geolocation Editor</link> chapter of this handbook. This applies to the context menu on the map and the line of buttons under the map except the last one.
- </para>
-
- <para>
- For information about the different map services you can use the drop-down field under the line of buttons. Choose a service here and then click the See-more-information-on-the-Internet button to the right.
- </para>
-
- <para>
- The displayed positioning data are actually stored in the image's EXIF tags. That allows the location to be read by any other application that can understand EXIF GPS data.
- </para>
-
-
-</sect2>
-
-<!--
-Local Variables:
-mode: sgml
-sgml-minimize-attributes:nil
-sgml-general-insert-case:lower
-sgml-indent-step:0
-sgml-indent-data:nil
-End:
--->
diff --git a/attic/digikam/using-sidebar-metadata.docbook b/attic/digikam/using-sidebar-metadata.docbook
deleted file mode 100644
index b41eebd..0000000
--- a/attic/digikam/using-sidebar-metadata.docbook
+++ /dev/null
@@ -1,241 +0,0 @@
-<sect2 id="using-sidebar-metadata">
-<title>Metadata</title>
-
- <para>
- Metadata are data about the images or files, like technical data of camera setting during shooting, author info, copyrights, keywords, captions, and coordinates of location.
- </para>
-
- <para>
- The metadata sidebar is composed of four sub tabs <guilabel>EXIF</guilabel>, <guilabel>Makernote</guilabel>, <guilabel>IPTC</guilabel> and <guilabel>XMP</guilabel> data. On the left, two buttons let you choose between full and simplified data display. In the middle you will find a disk icon to save the metadata to the disk. Next to it are a printer and copy icon - they do just that: print or copy the respective tab metadata to the clipboard.
- </para>
-
- <para>
- A really nice feature is the live search box on the lower end of the metadata tabs. As you type in a keyword, the metadata on top of it will be successively filtered until you narrow down and what you are looking for. It is a quick way of accessing specific information.
- </para>
-
- <para>
- Metadata, as shown in these four tabs, can be modified and enhanced in a number of ways elsewhere:
-
- <itemizedlist>
-
- <listitem><para>
- with the <ulink url="help:/digikam/using-camera.html">camera interface</ulink>
- </para></listitem>
-
- <listitem><para>
- the <link linkend="tool-metadataeditor">Metadata Editor</link>
- </para></listitem>
-
- <listitem><para>
- the <link linkend="tool-geolocationeditor">Geolocation tool</link>
- </para></listitem>
-
- <listitem><para>
- <ulink url="help:/menu-descriptions#synchronize-metadata">copying</ulink> database metadata to files
- </para></listitem>
-
- <listitem><para>
- <ulink url="help:/menu-descriptions#update-db-metadata">copying</ulink> file's metadata to the database
- </para></listitem>
-
- </itemizedlist>
- </para>
-
- <para>
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="&path;using-sidebar-metadata.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>The Metadata Tabs</phrase>
- </textobject>
- </inlinemediaobject>
-
- </para>
-
- <sect3 id="using-sidebar-exif">
- <title>EXIF Tags</title>
-
- <anchor id="exiftab.anchor"/>
-
- <sect4>
- <title>What is EXIF</title>
-
- <para>
- EXIF stands for <ulink url="https://en.wikipedia.org/wiki/Exif">Exchangeable image file format</ulink>. It was designed specifically for digital cameras. It allows a large amount of information about the photograph to be stored. This information describes the camera which took the image along with the settings (including date and time) in use when the image was taken. An in-line thumbnail can be included.
- </para>
-
- <para>
- EXIF format contains a set of marker sections named <emphasis>Image File Directories</emphasis> (IFD). The sections likely to be found in a normal EXIF file are as follows:
-
- <itemizedlist>
-
- <listitem><para>
- <guilabel>Image Information</guilabel>: contains general information about the image.
- </para></listitem>
-
- <listitem><para>
- <guilabel>Embedded Thumbnail</guilabel>: contains information about the embedded thumbnail image.
- </para></listitem>
-
- <listitem><para>
- <guilabel>Photograph Information</guilabel>: contains extended information about the photograph.
- </para></listitem>
-
- <listitem><para>
- <guilabel>Interoperability</guilabel>: contains information to support interoperability between different EXIF implementations.
- </para></listitem>
-
- </itemizedlist>
-
- </para>
-
- </sect4>
-
- <sect4>
- <title>How to Use EXIF Viewer</title>
-
- <para>
- You can review embedded EXIF information for the selected image from the first sidebar tab. The EXIF Viewer is purely informational: nothing you do with it will cause any change to the EXIF sections. If there are more entries than space available, just scroll down with the mouse wheel.
- </para>
-
- <para>
- You can use two different levels to display EXIF marker sections:
-
- <itemizedlist>
-
- <listitem><para>
- <guilabel>Simple</guilabel>: display only more important EXIF marker for photograph.
- </para></listitem>
-
- <listitem><para>
- <guilabel>Full</guilabel>: display all EXIF markers.
- </para></listitem>
-
- </itemizedlist>
-
- </para>
-
- <para>
- Some vendors add additional EXIF sections, such as Canon, Fujifilm, Nikon, Minolta, and Sigma. These sections contain vendor and model specific notes. These will be displayed on the <guilabel>Makernote</guilabel> tab.
- </para>
-
- </sect4>
-
- </sect3>
-
- <sect3 id="using-sidebar-makernote">
- <title>Makernote Tags</title>
-
- <sect4>
- <title>What is Makernote</title>
-
- <para>
- The EXIF standard defines a Makernote tag, which allows camera manufacturers to place any custom format metadata in the file. This is used increasingly by camera manufacturers to store a myriad of camera settings not listed in the EXIF standard, such as shooting modes, post-processing settings, serial number, focusing modes, &etc; but this tag format is proprietary and manufacturer specific.
- </para>
-
- </sect4>
-
- <sect4>
- <title>How to Use Makernote Viewer</title>
-
- <para>
- You can review embedded Makernote information for the selected image in this sidebar tab. The Makernote Viewer is purely informational: nothing you do with it will cause any change to the Makernote sections.
- </para>
-
- <para>
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="&path;using-sidebar-metadatamakernote.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>The Makernote Viewer in Action</phrase>
- </textobject>
- </inlinemediaobject>
-
- </para>
-
- </sect4>
-
- </sect3>
-
- <sect3 id="using-sidebar-iptc">
- <title>IPTC Tags</title>
-
- <sect4>
- <title>What is IPTC</title>
-
- <para>
- The <ulink url="http://www.iptc.org">International Press Telecommunications Council</ulink>, is a consortium of the world's major news agencies and news industry vendors. It develops and maintains technical standards for improved news exchange that are used by virtually every major news organization in the world.
- </para>
-
- <para>
- The IPTC was established in 1965 by a group of news organizations to safeguard the telecommunications interests of the world's press. Since the late 1970s IPTC's activities have primarily focused on developing and publishing industry standards for the interchange of news data.
- </para>
-
- <para>
- In particular, the IPTC defined a set of metadata attributes that can be applied to images. These were defined originally in 1979, and revised significantly in 1991 to be the "Information Interchange Model" (IIM), but the concept really advanced in 1994 when Adobe defined a specification for actually embedding the metadata into digital image files - known as "IPTC headers".
- </para>
-
- </sect4>
-
- <sect4>
- <title>How to Use IPTC Viewer</title>
-
- <para>
- You can review embedded IPTC information for the selected image in this sidebar tab. The IPTC Viewer is purely informational: nothing you do with it will cause any change to the IPTC sections.
- </para>
-
- <para>
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="&path;using-sidebar-metadataiptc.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>The IPTC Viewer in Action</phrase>
- </textobject>
- </inlinemediaobject>
-
- </para>
-
- </sect4>
-
- </sect3>
-
- <sect3 id="using-sidebar-xmp">
- <title>XMP Tags</title>
-
- <sect4>
- <title>What is XMP</title>
-
- <para>
- TODO
- </para>
-
- </sect4>
-
- <sect4>
- <title>How to Use XMP Viewer</title>
-
- <para>
- TODO
- </para>
-
- </sect4>
-
- </sect3>
-
-</sect2>
-
-<!--
-Local Variables:
-mode: sgml
-sgml-minimize-attributes:nil
-sgml-general-insert-case:lower
-sgml-indent-step:0
-sgml-indent-data:nil
-End:
--->
diff --git a/attic/digikam/using-sidebar-properties.docbook b/attic/digikam/using-sidebar-properties.docbook
deleted file mode 100644
index 4d30c8f..0000000
--- a/attic/digikam/using-sidebar-properties.docbook
+++ /dev/null
@@ -1,48 +0,0 @@
-<sect2 id="using-sidebar-properties">
-<title>Properties</title>
-
- <para>
-
- The properties sidebar shows the essential information about the selected image which are largely self-explanatory. It is grouped into the following sections:
-
- <itemizedlist>
-
- <listitem><para>
- File Properties: these are file system related information
- </para></listitem>
-
- <listitem><para>
- Image Properties: shows the image and format properties like dimension, compression, color-depth, &etc;
- </para></listitem>
-
- <listitem><para>
- Photograph Properties: shows a summary of the most important parameters when taking the photograph. These data are taken from the EXIF or XMP data fields if available.
- </para></listitem>
-
- <listitem><para>
- &digikam; Properties: optional view to show a summary of the most important values set in &digikam; database.
- </para></listitem>
-
- </itemizedlist>
-
- </para>
-
- <para>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="&path;using-sidebar-properties.png" format="PNG" />
- </imageobject>
- </inlinemediaobject>
- </para>
-
-</sect2>
-
-<!--
-Local Variables:
-mode: sgml
-sgml-minimize-attributes:nil
-sgml-general-insert-case:lower
-sgml-indent-step:0
-sgml-indent-data:nil
-End:
--->
diff --git a/attic/digikam/using-sidebar.docbook b/attic/digikam/using-sidebar.docbook
deleted file mode 100644
index f607c9e..0000000
--- a/attic/digikam/using-sidebar.docbook
+++ /dev/null
@@ -1,25 +0,0 @@
-<sect1 id="using-sidebar">
- <title>The &digikam; Right Sidebar</title>
- <anchor id="sidebar.anchor"/>
-
- &doc-using-sidebar-intro;
- &doc-using-sidebar-properties;
- &doc-using-sidebar-metadata;
- &doc-using-sidebar-colors;
- &doc-using-sidebar-maps;
- &doc-using-sidebar-captions;
- &doc-using-sidebar-versions;
- &doc-using-sidebar-filters;
- &doc-using-sidebar-tools;
-
-</sect1>
-
-<!--
-Local Variables:
-mode: sgml
-sgml-minimize-attributes:nil
-sgml-general-insert-case:lower
-sgml-indent-step:0
-sgml-indent-data:nil
-End:
--->
diff --git a/index.rst b/index.rst
index a1d7ec5..7ab46a2 100644
--- a/index.rst
+++ b/index.rst
@@ -137,6 +137,10 @@ The Right Sidebar
:ref:`maps_view`
+ .. container:: tile no-descr
+
+ :ref:`captions_view`
+
.. toctree::
:maxdepth: 2
:hidden:
diff --git a/right_sidebar.rst b/right_sidebar.rst
index ba6bd65..2565a87 100644
--- a/right_sidebar.rst
+++ b/right_sidebar.rst
@@ -26,3 +26,4 @@ Using the digiKam right sidebar
right_sidebar/metadata_view.rst
right_sidebar/colors_view.rst
right_sidebar/maps_view.rst
+ right_sidebar/captions_view.rst
diff --git a/right_sidebar/captions_view.rst b/right_sidebar/captions_view.rst
new file mode 100644
index 0000000..e9f408f
--- /dev/null
+++ b/right_sidebar/captions_view.rst
@@ -0,0 +1,82 @@
+.. meta::
+ :description: digiKam Right Sidebar Captions View
+ :keywords: digiKam, documentation, user manual, photo management, open source, free, learn, easy
+
+.. metadata-placeholder
+
+ :authors: - Gilles Caulier <caulier dot gilles at gmail dot com>
+
+ :license: Creative Commons License SA 4.0
+
+.. _captions_view:
+
+Captions View
+=============
+
+.. contents::
+
+Overview
+~~~~~~~~
+
+This sidebar tab serves to apply and edit image attributes like captions, rating, date and tags. The attributes are stored in the associated database, in the IPTC, XMP, and EXIF data fields and become part of the image. All attributes are accessible in one sidebar view as shown in the screenshot below. During image reading the order of priority is a) database b) XMP/IPTC and c) EXIF. So if there is a discrepancy between any of the three, this priority will take effect and a synchronization will take place. This sidebar has a first-previous-next-last arrow navigator field on top if shown in the main application.
+
+.. figure:: images/using-sidebar-captions.png
+
+Comment Editors
+~~~~~~~~~~~~~~~
+
+The descriptions view can be used to type or paste in a title and/or a captions of unlimited size (see note below). The text is UTF-8 compatible, meaning that all special characters are allowed. The captions are copied to EXIF, IPTC, and XMP fields to be used by other applications.
+
+.. caution::
+
+ IPTC data only supports ASCII characters and is limited to 2000 characters (old American norm). All texts will be truncated after 2000 chars, and special characters will be malformed. If you intend to use the IPTC caption field in other applications you should be compliant with these restrictions.
+
+Title and caption editors are powerful tool which supports:
+
+ - Multiple alternative language strings.
+ - Translate strings online to another language.
+ - Author strings definition.
+
+The default language from an alternative strings stack is **x-default** and must be written by preference in English. If one strings must be enter in the stack, the x-default must be present in prior.
+
+After commenting, either choose the Apply button or go straight to the next image, the descriptions will be saved.
+
+Next to the Apply button there is the More button. From it you can either choose to read metadata from the selected file to the database, or the other way around, to write metadata to the files (the latter take place anyway if you chose a metadata setting so that all metadata is always saved to the images).
+
+Date and Time
+~~~~~~~~~~~~~
+
+In the Date and Time section, which reflects the time of taking the photograph, you can change all values. From the date combo-box a calendar opens, and the time setting spin-box can also be written by directly typing the time. The dating is copied to the EXIF 'Date and Time' field. If you need to change a number of images for their creating time & date, there is a more comfortable method available in Batch Queue Manager. This latter option can be found under Image → Adjust time & date.... Select the images to be changed in the main view and call the tool.
+
+Labels
+~~~~~~
+
+The Rating section displays a 0...5 star rating scheme that can be used in searches and sort orders. It can be applied by a single mouse click to the 5 stars in the sidebar or with a keyboard short-cut Ctrl+0...5. The rating from the sidebar is always applied to one image at a time. To rate a number of images, select them and pop-up the context menu (click with the right mouse button) to apply a common rating.
+
+The labels view allow to assign also the Color and the Pick tags that you can use in your workflow to classify items.
+
+Tag Tree
+~~~~~~~~
+
+The tag view shows an adaptive filter tag search box, the tag tree and a combo-box containing the tags previously applied in this digiKam session.
+
+.. figure:: images/using-sidebar-tags.png
+
+The tag tree will be adapted dynamically as a function of the search word as you type into the box. So it is easy to quickly reduce the number of possibilities when searching for a tag. Of course, this feature is only useful if you have many tags.
+
+The combo-box at the bottom is another ergonomic feature for easy tagging of an image series. As you apply different tags they will be memorized in this box for quick access.
+
+Otherwise tags are simply applied by checking the respective boxes in the tree. All tags of an image are transcribed into the XMP/IPTC 'keyword' data field.
+
+.. note::
+
+ In case you have selected a number of images in the main view and you check a tag in the tag tree, this one is only applied to the highlighted image, and not to the whole selection. If you want to tag selections, refer to the Filters section.
+
+Information View
+~~~~~~~~~~~~~~~~
+
+.. figure:: images/using-sidebar-information.png
+
+The Information view allows to assign a template of textuals information to items in one pass. These information can be pupolated in Setup/Template dialog. They contains all strings decripting the contents, the scene, the authors, the rights, the place etc.
+
+For more details about Template, see the description of the Template management section.
diff --git a/right_sidebar/images/using-sidebar-captions.png b/right_sidebar/images/using-sidebar-captions.png
new file mode 100644
index 0000000..1c8a31e
Binary files /dev/null and b/right_sidebar/images/using-sidebar-captions.png differ
diff --git a/right_sidebar/images/using-sidebar-information.png b/right_sidebar/images/using-sidebar-information.png
new file mode 100644
index 0000000..8e97d7b
Binary files /dev/null and b/right_sidebar/images/using-sidebar-information.png differ
diff --git a/right_sidebar/images/using-sidebar-tags.png b/right_sidebar/images/using-sidebar-tags.png
new file mode 100644
index 0000000..97f09bd
Binary files /dev/null and b/right_sidebar/images/using-sidebar-tags.png differ
More information about the kde-doc-english
mailing list