[digikam-doc] /: split Using Sidebar sections
Gilles Caulier
caulier.gilles at gmail.com
Tue Aug 30 08:22:40 UTC 2016
Git commit 50af49d22d2a36ca46ddcbf43ab81d2a93a64553 by Gilles Caulier.
Committed on 30/08/2016 at 08:22.
Pushed by cgilles into branch 'master'.
split Using Sidebar sections
M +9 -0 TODO
M +13 -3 digikam/index.docbook
A +138 -0 digikam/using-sidebar-captions.docbook
A +222 -0 digikam/using-sidebar-colors.docbook
A +41 -0 digikam/using-sidebar-filters.docbook
A +54 -0 digikam/using-sidebar-intro.docbook
A +61 -0 digikam/using-sidebar-maps.docbook
A +241 -0 digikam/using-sidebar-metadata.docbook
A +52 -0 digikam/using-sidebar-properties.docbook
A +18 -0 digikam/using-sidebar-tools.docbook
M +8 -553 digikam/using-sidebar.docbook
M +10 -0 showfoto/index.docbook
http://commits.kde.org/digikam-doc/50af49d22d2a36ca46ddcbf43ab81d2a93a64553
diff --git a/TODO b/TODO
index a184546..17c301c 100644
--- a/TODO
+++ b/TODO
@@ -116,6 +116,15 @@ using-lighttable.docbook
using-mainwindow.docbook
using-setup.docbook
using-sidebar.docbook
+using-sidebar DONE DONE Gilles
+using-sidebar-intro
+using-sidebar-properties
+using-sidebar-metadata Missing XMP view description
+using-sidebar-colors
+using-sidebar-maps
+using-sidebar-captions issing Information view description
+using-sidebar-filters
+using-sidebar-tools Need to be created
using-tagsmngr.docbook Need to be created
--------------------------------------------------------------------------------------------------------------------------------------
diff --git a/digikam/index.docbook b/digikam/index.docbook
index c0923df..19c5eaa 100644
--- a/digikam/index.docbook
+++ b/digikam/index.docbook
@@ -20,10 +20,20 @@
<!-- Using Application Chapter -->
<!ENTITY doc-using-mainwindow SYSTEM "using-mainwindow.docbook">
+
<!ENTITY doc-using-sidebar SYSTEM "using-sidebar.docbook">
- <!ENTITY doc-using-lighttable SYSTEM "using-lighttable.docbook">
- <!ENTITY doc-using-bqm SYSTEM "using-bqm.docbook">
- <!ENTITY doc-using-tagsmngr SYSTEM "using-tagsmngr.docbook">
+ <!ENTITY doc-using-sidebar-intro SYSTEM "using-sidebar-intro.docbook">
+ <!ENTITY doc-using-sidebar-properties SYSTEM "using-sidebar-properties.docbook">
+ <!ENTITY doc-using-sidebar-metadata SYSTEM "using-sidebar-metadata.docbook">
+ <!ENTITY doc-using-sidebar-colors SYSTEM "using-sidebar-colors.docbook">
+ <!ENTITY doc-using-sidebar-maps SYSTEM "using-sidebar-maps.docbook">
+ <!ENTITY doc-using-sidebar-captions SYSTEM "using-sidebar-captions.docbook">
+ <!ENTITY doc-using-sidebar-filters SYSTEM "using-sidebar-filters.docbook">
+ <!ENTITY doc-using-sidebar-tools SYSTEM "using-sidebar-tools.docbook">
+
+ <!ENTITY doc-using-lighttable SYSTEM "using-lighttable.docbook">
+ <!ENTITY doc-using-bqm SYSTEM "using-bqm.docbook">
+ <!ENTITY doc-using-tagsmngr SYSTEM "using-tagsmngr.docbook">
<!ENTITY doc-using-dam SYSTEM "using-dam.docbook">
<!ENTITY doc-using-dam-intro SYSTEM "using-dam-intro.docbook">
diff --git a/digikam/using-sidebar-captions.docbook b/digikam/using-sidebar-captions.docbook
new file mode 100644
index 0000000..30966e4
--- /dev/null
+++ b/digikam/using-sidebar-captions.docbook
@@ -0,0 +1,138 @@
+<sect2 id="using-sidebar-captions">
+ <title>Captions</title>
+
+ <sect3>
+ <title>Introduction</title>
+
+ <para>
+ 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 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) 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.
+ </para>
+
+ <example>
+ <title>sidebar Comments & Tags example</title>
+ <screenshot>
+ <screeninfo>sidebar Comments & Tags Example</screeninfo>
+ <mediaobject><imageobject>
+ <imagedata fileref="&path;using-sidebar-captions.png" format="PNG" />
+ </imageobject></mediaobject>
+ </screenshot>
+ </example>
+
+ </sect3>
+
+ <sect3>
+ <title>Comment View</title>
+
+ <para>
+ The caption view can be used to type or paste in a caption 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 and IPTC fields to be used by other applications.
+ </para>
+
+ <caution><para>
+ 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.
+ </para></caution>
+
+ <para>
+ After commenting, either choose the <guibutton>Apply</guibutton> button or go straight to the next image, the captions will be saved.
+ </para>
+
+ <para>
+ Next to the Apply button there is the <guibutton>More</guibutton> 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).
+ </para>
+
+ </sect3>
+
+ <sect3>
+
+ <title>Date & Time</title>
+
+ <para>
+ In the Date & Time section, which reflects the time of taking the photograph, you can change all values. From the date combo-box a calender 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 <menuchoice><guimenuitem>Image</guimenuitem><guimenuitem>Adjust time & date...</guimenuitem></menuchoice>. Select the images to be changed in the main view and call the plugin.
+ </para>
+
+ </sect3>
+
+ <sect3>
+ <title>Rating</title>
+
+ <para>
+ 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 (right-click) to apply a common rating.
+ </para>
+
+ <para>
+ The rating is then transcribed into the IPTC 'urgency' data field. The transcoding follows the scheme in this table:
+ </para>
+
+ <informaltable><tgroup cols="2">
+
+ <thead><row>
+ <entry>&digikam; Rating</entry>
+ <entry>IPTC Urgency</entry>
+ </row></thead>
+
+ <tbody>
+ <row> <entry>-</entry> <entry>8</entry> </row>
+
+ <row> <entry>*</entry> <entry>7</entry> </row>
+
+ <row> <entry>*</entry> <entry>6</entry> </row>
+
+ <row> <entry>**</entry> <entry>5</entry> </row>
+
+ <row> <entry>***</entry> <entry>4</entry> </row>
+
+ <row> <entry>****</entry> <entry>3</entry> </row>
+
+ <row> <entry>****</entry> <entry>2</entry> </row>
+
+ <row> <entry>*****</entry> <entry>1</entry> </row>
+ </tbody>
+
+ </tgroup></informaltable>
+
+ </sect3>
+
+ <sect3>
+ <title>Tag Tree</title>
+
+ <para>
+ 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.
+ </para>
+
+ <para>
+ 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.
+ </para>
+
+ <para>
+ 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.
+ </para>
+
+ <para>
+ Otherwise tags are simply applied by checking the respective boxes in the tree. All tags of an image are transcribed into the IPTC 'keyword' data field.
+ </para>
+
+ <note><para>
+ 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 <link linkend="using-sidebar-filters">Filters</link> section.
+ </para></note>
+
+ </sect3>
+
+ <sect3>
+ <title>Information View</title>
+
+ <para>
+ TODO
+ </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/digikam/using-sidebar-colors.docbook b/digikam/using-sidebar-colors.docbook
new file mode 100644
index 0000000..2c3e9d9
--- /dev/null
+++ b/digikam/using-sidebar-colors.docbook
@@ -0,0 +1,222 @@
+<sect2 id="using-sidebar-colors">
+<title>Colors</title>
+
+ <para>
+ The colors sidebar has two sub tabs <guilabel>Color and 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 the Adjust Levels or Adjust Curves Image Editor plugin.
+ </para>
+
+ <example>
+ <title>The Histogram Viewer in Action</title>
+ <screenshot>
+ <screeninfo>The Histogram Viewer in Action</screeninfo>
+ <mediaobject><imageobject>
+ <imagedata fileref="&path;using-sidebar-histogramview.png" format="PNG" />
+ </imageobject></mediaobject>
+ </screenshot>
+ </example>
+
+ <para>
+ An image can be decomposed into <guilabel>Red</guilabel>, <guilabel>Green</guilabel>, <guilabel>Blue</guilabel>, <guilabel>Alpha</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 <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 on 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/digikam/using-sidebar-filters.docbook b/digikam/using-sidebar-filters.docbook
new file mode 100644
index 0000000..617eca3
--- /dev/null
+++ b/digikam/using-sidebar-filters.docbook
@@ -0,0 +1,41 @@
+<sect2 id="using-sidebar-filters">
+ <title>Tag Filters</title>
+
+ <para>
+ The tag filter sidebar is used to modify the set of images displayed in the main window view. Normally one uses the left sidebar with its Album, Date, Tags and Searches view. When additionally one or more tags on right sidebar tag filter is checked, only the cross-section of these two selections will be displayed. All created tags are available.
+ </para>
+
+ <para>
+ To give an example, suppose you have a tag called 'public' which tags all images except your private ones. Then you can check this 'public' tag in the right sidebar to hide the private images (all those not having 'public' tag). Whatever view mode you chose from the left sidebar, 'public' only image will be displayed. Another typical example is the selection of a subset of tags in a hierarchical tree. Suppose you want to display 'red' and 'green' from a tag tree containing 7 different colors as sub-tags. Simply click on the 'color' tag of the main view and check 'red' and 'green' from the right sidebar.
+ </para>
+
+ <para>
+ Another use is <emphasis>drag-and-drop tagging</emphasis>. Lets say you selected in the main view a number of images to tag them. If the tag already exists, simply drag it from the right sidebar onto the selection (any one of the highlighted images). A dialog will pop-up and ask if this tag should be applied.
+ </para>
+
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="&path;using-sidebar-filters.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Sidebar Tag Filters</phrase>
+ </textobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>
+ In the above example the main window shows the images from a calender date, the tag filter is set to 'not tagged', which reduces the set to 3 images. They have been selected with Ctrl+a, then a tag is dragged from the right tag tree over the selection and dropped. A pop-up dialog asks if the tag shall be applied.
+ </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/digikam/using-sidebar-intro.docbook b/digikam/using-sidebar-intro.docbook
new file mode 100644
index 0000000..737ec6a
--- /dev/null
+++ b/digikam/using-sidebar-intro.docbook
@@ -0,0 +1,54 @@
+<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 <guilabel>Image Editor</guilabel> view. It can be displayed by respectively clicking on one of the five 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, Rating, Tags.
+ </para></listitem>
+
+ <listitem><para>
+ <link linkend="using-sidebar-filters">Tag Filters</link> : Tag filters applied 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/digikam/using-sidebar-maps.docbook b/digikam/using-sidebar-maps.docbook
new file mode 100644
index 0000000..62cc8af
--- /dev/null
+++ b/digikam/using-sidebar-maps.docbook
@@ -0,0 +1,61 @@
+<sect2 id="using-sidebar-maps">
+ <title>Maps</title>
+
+ <sect3>
+ <title>Geolocate Images</title>
+
+ <para>
+ This tab is based on the world-map widget to display a rough map of orientation. You can zoom in and out with the mousewheel by either scrolling it or hold and drag it. Pan by holding down the left mouse button.
+ </para>
+
+ <example>
+ <title>The Geolocation tab</title>
+ <screenshot>
+ <screeninfo>For higher resolution maps choose "More Info"</screeninfo>
+ <mediaobject><imageobject>
+ <imagedata fileref="&path;using-sidebar-metadatagps.png" format="PNG" />
+ </imageobject></mediaobject>
+ </screenshot>
+ </example>
+
+ <para>
+ The left sidebar is a geo-search tool. Press the <keycombo action="press">&Ctrl;<keycap>left mouse button</keycap></keycombo> to pull-up a square as indicated. All images falling within the coordinates of that square will be shown.
+ </para>
+
+ <para>
+ On the right sidebar you will find a cross to indicate the GPS location and the selected image's name next to it. The GPS coordinates and the time information are displayed below the widget.
+ </para>
+
+ <para>
+ For higher resolution maps choose <guibutton>More Info</guibutton> button to open the detailed map service (choose before on the left scroll box) in a Internet browser.
+ </para>
+
+ <para>
+ The displayed positioning data are actually stored in the image's EXIF tags (and not yet in the database). That allows the location to be read by any other application that can understand EXIF GPS data.
+ </para>
+ </sect3>
+
+ <sect3>
+ <title>What is GPS</title>
+
+ <para>
+ The <ulink url="http://en.wikipedia.org/wiki/Global_Positioning_System">Global Positioning System</ulink> usually called GPS, is the only fully functional satellite navigation system. A constellation of more than two dozen GPS satellites broadcasts precise timing signals by radio, allowing any GPS receiver to accurately determine its location (longitude, latitude, and altitude) anywhere on Earth. GPS also provides an extremely precise time reference and gauge speed with a very high degree of accuracy.
+ </para>
+
+ <para>
+ GPS information can be stored in images directly by supported cameras or by synchronizing photographs with an external GPS device track. Look at this <ulink url="help:/digikam/using-camera.html#using-gps">section</ulink> for more information.
+ </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/digikam/using-sidebar-metadata.docbook b/digikam/using-sidebar-metadata.docbook
new file mode 100644
index 0000000..b41eebd
--- /dev/null
+++ b/digikam/using-sidebar-metadata.docbook
@@ -0,0 +1,241 @@
+<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/digikam/using-sidebar-properties.docbook b/digikam/using-sidebar-properties.docbook
new file mode 100644
index 0000000..4ce8de4
--- /dev/null
+++ b/digikam/using-sidebar-properties.docbook
@@ -0,0 +1,52 @@
+<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. This data is taken from the EXIF or XMP data fields if available.
+ </para></listitem>
+
+ <listitem><para>
+ &digikam; Properties: optionnal view to show a summary of the most important captions values set in &digikam; database.
+ </para></listitem>
+
+ </itemizedlist>
+
+ <example>
+
+ <title>Sidebar File Properties</title>
+ <screenshot>
+ <screeninfo>sidebar File Properties Example</screeninfo>
+ <mediaobject><imageobject>
+ <imagedata fileref="&path;using-sidebar-properties.png" format="PNG" />
+ </imageobject></mediaobject>
+ </screenshot>
+
+ </example>
+
+ </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/digikam/using-sidebar-tools.docbook b/digikam/using-sidebar-tools.docbook
new file mode 100644
index 0000000..14f593d
--- /dev/null
+++ b/digikam/using-sidebar-tools.docbook
@@ -0,0 +1,18 @@
+<sect2 id="using-sidebar-tools">
+ <title>Tools view</title>
+
+ <para>
+ TODO
+ </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/digikam/using-sidebar.docbook b/digikam/using-sidebar.docbook
index ded7b8f..fb6ede4 100644
--- a/digikam/using-sidebar.docbook
+++ b/digikam/using-sidebar.docbook
@@ -2,559 +2,14 @@
<title>&digikam; sidebar</title>
<anchor id="sidebar.anchor"/>
- <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 <guilabel>Image Editor</guilabel> view. It can be displayed by respectively clicking on one of the five 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, Rating, Tags.
- </para></listitem>
-
- <listitem><para>
- <link linkend="using-sidebar-filters">Tag Filters</link> : Tag filters applied 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>
-
- <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. This data is taken from the EXIF data fields if available</para></listitem>
-
- </itemizedlist>
-
- <example> <title>Sidebar File Properties</title>
- <screenshot><screeninfo>sidebar File Properties Example</screeninfo><mediaobject><imageobject><imagedata fileref="&path;using-sidebar-properties.png" format="PNG" /> </imageobject></mediaobject></screenshot>
- </example>
-
- </para>
-
- </sect2>
-
- <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-sidebarmetadataexif">
- <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-sidebarmetadatamakernote">
- <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-sidebarmetadataiptc">
- <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>
-
- </sect2>
-
- <sect2 id="using-sidebar-colors">
- <title>Colors</title>
- <para>
- The colors sidebar has two sub tabs <guilabel>Color and 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 the Adjust Levels or Adjust Curves Image Editor plugin.
- </para>
-
- <example> <title>The Histogram Viewer in Action</title>
- <screenshot><screeninfo>The Histogram Viewer in Action</screeninfo><mediaobject><imageobject><imagedata fileref="&path;using-sidebar-histogramview.png" format="PNG" /> </imageobject></mediaobject></screenshot>
- </example>
-
- <para>
- An image can be decomposed into <guilabel>Red</guilabel>, <guilabel>Green</guilabel>, <guilabel>Blue</guilabel>, <guilabel>Alpha</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 <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 on 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>
-
- <sect2 id="using-sidebar-maps">
- <title>Maps</title>
-
- <para>This tab is based on the marble widget to display a rough map of orientation. You can zoom in and out with the mousewheel by either scrolling it or hold and drag it. Pan by holding down the left mouse button.</para>
- <example> <title>The Geolocation tab</title>
- <screenshot><screeninfo>For higher resolution maps choose "More Info"</screeninfo><mediaobject><imageobject><imagedata fileref="&path;using-sidebar-metadatagps.png" format="PNG" /> </imageobject></mediaobject></screenshot>
- </example>
- <para>The left sidebar is a geo-search tool. Press the <keycombo action="press">&Ctrl;<keycap>left mouse button</keycap></keycombo> to pull-up a square as indicated. All images falling within the coordinates of that square will be shown. </para>
- <para>On the right sidebar you will find a cross to indicate the GPS location and the selected image's name next to it. The GPS coordinates and the time information are displayed below the widget. </para>
- <para>For higher resolution maps choose <guibutton>More Info</guibutton> button to open the detailed map service (choose before on the left scroll box) in a Internet browser.</para>
- <para>The displayed positioning data are actually stored in the image's EXIF tags (and not yet in the database). That allows the location to be read by any other application that can understand EXIF GPS data.</para>
-
- <sect3> <title>What is GPS?</title>
-
- <para>
- The <ulink url="http://en.wikipedia.org/wiki/Global_Positioning_System">Global Positioning System</ulink> usually called GPS, is the only fully functional satellite navigation system. A constellation of more than two dozen GPS satellites broadcasts precise timing signals by radio, allowing any GPS receiver to accurately determine its location (longitude, latitude, and altitude) anywhere on Earth. GPS also provides an extremely precise time reference and gauge speed with a very high degree of accuracy.
- </para>
- <para>
- GPS information can be stored in images directly by supported cameras or by synchronizing photographs with an external GPS device track. Look at this <ulink url="help:/digikam/using-camera.html#using-gps">section</ulink> for more information.
- </para>
- </sect3>
-
- </sect2>
-
- <sect2 id="using-sidebar-captions">
- <title>Captions</title>
- <para>
- 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 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) 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.
- </para>
-
- <example> <title>sidebar Comments & Tags example</title>
- <screenshot><screeninfo>sidebar Comments & Tags Example</screeninfo><mediaobject><imageobject><imagedata fileref="&path;using-sidebar-captions.png" format="PNG" /> </imageobject></mediaobject></screenshot>
- </example>
-
- <sect3>
- <title>Comment View</title>
- <para>
- The caption view can be used to type or paste in a caption 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 and IPTC fields to be used by other applications.
- </para>
- <caution><para>
- 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.
- </para></caution>
- <para>After commenting, either choose the <guibutton>Apply</guibutton> button or go straight to the next image, the captions will be saved.</para>
- <para>Next to the Apply button there is the <guibutton>More</guibutton> 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).</para>
-
- </sect3>
-
- <sect3>
- <title>Date & Time</title>
-
- <para>
- In the Date & Time section, which reflects the time of taking the photograph, you can change all values. From the date combo-box a calender 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 (requiring the Kipi-plugins). This latter option can be found under <menuchoice><guimenuitem>Image</guimenuitem><guimenuitem>Adjust time & date...</guimenuitem></menuchoice>. Select the images to be changed in the main view and call the plugin.
- </para>
- </sect3>
-
- <sect3>
- <title>Rating</title>
-
- <para>
- 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 (right-click) to apply a common rating.
- </para>
- <para>The rating is then transcribed into the IPTC 'urgency' data field. The transcoding follows the scheme in this table:
- </para>
-
- <informaltable><tgroup cols="2">
- <thead><row>
- <entry>&digikam; Rating</entry>
- <entry>IPTC Urgency</entry>
- </row></thead>
-
- <tbody>
- <row> <entry>-</entry> <entry>8</entry> </row>
-
- <row> <entry>*</entry> <entry>7</entry> </row>
-
- <row> <entry>*</entry> <entry>6</entry> </row>
-
- <row> <entry>**</entry> <entry>5</entry> </row>
-
- <row> <entry>***</entry> <entry>4</entry> </row>
-
- <row> <entry>****</entry> <entry>3</entry> </row>
-
- <row> <entry>****</entry> <entry>2</entry> </row>
-
- <row> <entry>*****</entry> <entry>1</entry> </row>
- </tbody>
-
- </tgroup></informaltable>
-
- </sect3>
-
- <sect3>
- <title>Tag Tree</title>
-
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
-
- <para>
- 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.
- </para>
-
- <para>
- Otherwise tags are simply applied by checking the respective boxes in the tree. All tags of an image are transcribed into the IPTC 'keyword' data field.
- </para>
- <note><para>
- 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 <link linkend="using-sidebar-filters">Filters</link> section.
- </para></note>
-
- </sect3>
-
- </sect2>
-
- <sect2 id="using-sidebar-filters">
- <title>Tag Filters</title>
- <para>
- The tag filter sidebar is used to modify the set of images displayed in the main window view. Normally one uses the left sidebar with its Album, Date, Tags and Searches view. When additionally one or more tags on right sidebar tag filter is checked, only the cross-section of these two selections will be displayed. All created tags are available.
- </para>
- <para>
- To give an example, suppose you have a tag called 'public' which tags all images except your private ones. Then you can check this 'public' tag in the right sidebar to hide the private images (all those not having 'public' tag). Whatever view mode you chose from the left sidebar, 'public' only image will be displayed. Another typical example is the selection of a subset of tags in a hierarchical tree. Suppose you want to display 'red' and 'green' from a tag tree containing 7 different colors as sub-tags. Simply click on the 'color' tag of the main view and check 'red' and 'green' from the right sidebar.
- </para>
- <para>Another use is <emphasis>drag-and-drop tagging</emphasis>. Lets say you selected in the main view a number of images to tag them. If the tag already exists, simply drag it from the right sidebar onto the selection (any one of the highlighted images). A dialog will pop-up and ask if this tag should be applied.
- </para>
-
- <para>
- <inlinemediaobject><imageobject><imagedata fileref="&path;using-sidebar-filters.png" format="PNG" /> </imageobject><textobject><phrase>Sidebar Tag Filters</phrase></textobject></inlinemediaobject>
- </para>
-
- <para>
- In the above example the main window shows the images from a calender date, the tag filter is set to 'not tagged', which reduces the set to 3 images. They have been selected with Ctrl+a, then a tag is dragged from the right tag tree over the selection and dropped. A pop-up dialog asks if the tag shall be applied.
- </para>
-
- </sect2>
-
- <sect2 id="using-sidebar-tools">
- <title>Tools view</title>
-
- <para>
- TODO
- </para>
-
- </sect2>
+ &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-filters;
+ &doc-using-sidebar-tools;
</sect1>
diff --git a/showfoto/index.docbook b/showfoto/index.docbook
index da926d9..fdc0ad2 100644
--- a/showfoto/index.docbook
+++ b/showfoto/index.docbook
@@ -10,7 +10,17 @@
<!ENTITY path "../digikam/"><!-- relative path to snapshots for showfoto -->
<!ENTITY doc-intro-imageformats SYSTEM "../digikam/intro-imageformats.docbook">
+
<!ENTITY doc-using-sidebar SYSTEM "../digikam/using-sidebar.docbook">
+ <!ENTITY doc-using-sidebar-intro SYSTEM "../digikam/using-sidebar-intro.docbook">
+ <!ENTITY doc-using-sidebar-properties SYSTEM "../digikam/using-sidebar-properties.docbook">
+ <!ENTITY doc-using-sidebar-metadata SYSTEM "../digikam/using-sidebar-metadata.docbook">
+ <!ENTITY doc-using-sidebar-colors SYSTEM "../digikam/using-sidebar-colors.docbook">
+ <!ENTITY doc-using-sidebar-maps SYSTEM "../digikam/using-sidebar-maps.docbook">
+ <!ENTITY doc-using-sidebar-captions SYSTEM "../digikam/using-sidebar-captions.docbook">
+ <!ENTITY doc-using-sidebar-filters SYSTEM "../digikam/using-sidebar-filters.docbook">
+ <!ENTITY doc-using-sidebar-tools SYSTEM "../digikam/using-sidebar-tools.docbook">
+
<!ENTITY doc-editor-photoediting SYSTEM "../digikam/editor-photoediting.docbook">
<!ENTITY doc-editor-color SYSTEM "../digikam/editor-color.docbook">
More information about the kde-doc-english
mailing list