[documentation/digikam-doc/sphinx] /: add filters section

Gilles Caulier null at kde.org
Sat Dec 17 18:26:01 GMT 2022


Git commit e23544eb33648ef306891326d39f6bd654c65dd7 by Gilles Caulier.
Committed on 17/12/2022 at 18:25.
Pushed by cgilles into branch 'sphinx'.

add filters section

D  +0    -53   attic/digikam/using-sidebar-filters.docbook
D  +-    --    attic/digikam/using-sidebar-filters.png
M  +4    -0    index.rst
M  +1    -0    right_sidebar.rst
A  +32   -0    right_sidebar/filters_view.rst
A  +-    --    right_sidebar/images/using-sidebar-filters.png

https://invent.kde.org/documentation/digikam-doc/commit/e23544eb33648ef306891326d39f6bd654c65dd7

diff --git a/attic/digikam/using-sidebar-filters.docbook b/attic/digikam/using-sidebar-filters.docbook
deleted file mode 100644
index cfa1d9a..0000000
--- a/attic/digikam/using-sidebar-filters.docbook
+++ /dev/null
@@ -1,53 +0,0 @@
-<sect2 id="using-sidebar-filters">
-    <title>Filters</title>
-
-        <para>
-            The <guilabel>Filters</guilabel> tab is used to limit the set of images displayed in the Image Area. Normally one uses the Left Sidebar with its different views to confine the images displayed for example to the content of an album or to images with a certain label assigned to them. The <guilabel>Filters</guilabel> tab on the Right Sidebar offers a number of filters and if one of these are filled in, selected or checked only the cross-section of these two selections will be displayed in the Image Area.
-        </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, only 'public' images 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>
-            You can also use a combination of the filters but here we have to look a little bit closer: The main filters and also the different types of labels in the Labels Filter (color, pick, rating) are connected with boolean AND which means that <emphasis>all</emphasis> selected filters have to fit for the images to be displayed. If you select 'JPG' in the MIME type filter and 'red' in the labels filter only those photographs from the selection on the Left Sidebar will be displayed that have JPG format AND are labeled 'red'.
-        </para>
-        
-        <para>
-            On the other hand the tags in the tag filter and the individual labels within one type of labels are connected with boolean OR as you might have noticed already in the public/private example above. That means if you check more than one tag in the Tags Filter all images with at least one of these tags applied will show up (as long as they are not ruled out by one of the other filters).
-        </para>
-
-        <para>
-            Another use of this tab of the Right Sidebar is <emphasis>drag-and-drop tagging</emphasis>. Lets say you chose with the help of the Left Sidebar a number of images to tag them and they are now displayed in the Image Area. If the tag already exists, simply drag it from the Right Sidebar onto one of the icons. A dialog will pop-up and ask if this tag should be applied to this item only, to all items or, if there is more than one icon selected (highlighted), to the selected items.
-        </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 calendar date, the tag filter is set to 'Oldtimer', which reduces the set to 3 images. In the Text Filter I typed <quote>Funeral</quote> which leaves only one picture of the only funeral car oldtimer in my collections. Then a tag is dragged from the Tag Filter over the icon and dropped. A pop-up dialog asks if the tag shall be applied to this item only or to all (displayed) items.
-        </para>
-        
-        <para>
-            Note that the Text Filter has a little drop-down menu to select which image information should be included in the search and the rating group in the Labels Filter has one to choose whether you want a certain rating or a range.
-        </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-filters.png b/attic/digikam/using-sidebar-filters.png
deleted file mode 100644
index f567451..0000000
Binary files a/attic/digikam/using-sidebar-filters.png and /dev/null differ
diff --git a/index.rst b/index.rst
index 88aa4fe..e37250c 100644
--- a/index.rst
+++ b/index.rst
@@ -145,6 +145,10 @@ The Right Sidebar
 
         :ref:`versions_view`
 
+    .. container:: tile no-descr
+
+        :ref:`filters_view`
+
 .. toctree::
    :maxdepth: 2
    :hidden:
diff --git a/right_sidebar.rst b/right_sidebar.rst
index dbac9b3..23c41e2 100644
--- a/right_sidebar.rst
+++ b/right_sidebar.rst
@@ -28,3 +28,4 @@ Using the digiKam right sidebar
    right_sidebar/maps_view.rst
    right_sidebar/captions_view.rst
    right_sidebar/versions_view.rst
+   right_sidebar/filters_view.rst
diff --git a/right_sidebar/filters_view.rst b/right_sidebar/filters_view.rst
new file mode 100644
index 0000000..01b582d
--- /dev/null
+++ b/right_sidebar/filters_view.rst
@@ -0,0 +1,32 @@
+.. meta::
+   :description: digiKam Right Sidebar Filters 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
+
+.. _filters_view:
+
+Filters View
+=============
+
+.. contents::
+
+The Filters tab is used to limit the set of images displayed in the Image Area. Normally one uses the Left Sidebar with its different views to confine the images displayed for example to the content of an album or to images with a certain label assigned to them. The Filters tab on the Right Sidebar offers a number of filters and if one of these are filled in, selected or checked only the cross-section of these two selections will be displayed in the Image Area.
+
+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, only 'public' images 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.
+
+You can also use a combination of the filters but here we have to look a little bit closer: The main filters and also the different types of labels in the Labels Filter (color, pick, rating) are connected with boolean AND which means that all selected filters have to fit for the images to be displayed. If you select 'JPG' in the MIME type filter and 'red' in the labels filter only those photographs from the selection on the Left Sidebar will be displayed that have JPG format AND are labeled 'red'.
+
+On the other hand the tags in the tag filter and the individual labels within one type of labels are connected with boolean OR as you might have noticed already in the public/private example above. That means if you check more than one tag in the Tags Filter all images with at least one of these tags applied will show up (as long as they are not ruled out by one of the other filters).
+
+Another use of this tab of the Right Sidebar is drag-and-drop tagging. Lets say you chose with the help of the Left Sidebar a number of images to tag them and they are now displayed in the Image Area. If the tag already exists, simply drag it from the Right Sidebar onto one of the icons. A dialog will pop-up and ask if this tag should be applied to this item only, to all items or, if there is more than one icon selected (highlighted), to the selected items.
+
+.. figure:: images/using-sidebar-filters.png
+
+In the above example the main window shows the images from a calendar date, the tag filter is set to 'Oldtimer', which reduces the set to 3 images. In the Text Filter I typed “Funeral” which leaves only one picture of the only funeral car oldtimer in my collections. Then a tag is dragged from the Tag Filter over the icon and dropped. A pop-up dialog asks if the tag shall be applied to this item only or to all (displayed) items.
+
+Note that the Text Filter has a little drop-down menu to select which image information should be included in the search and the rating group in the Labels Filter has one to choose whether you want a certain rating or a range.
diff --git a/right_sidebar/images/using-sidebar-filters.png b/right_sidebar/images/using-sidebar-filters.png
new file mode 100644
index 0000000..571e3b4
Binary files /dev/null and b/right_sidebar/images/using-sidebar-filters.png differ


More information about the kde-doc-english mailing list