Git commit 9fc5dea36eae3d5c2698cc9df2fffe94703617f5 by Gilles Caulier. Committed on 23/08/2016 at 10:26. Pushed by cgilles into branch 'master'.
start to split "using" chapter M +6 -561 digikam/index.docbook A +582 -0 digikam/using-mainwindow.docbook R +0 -0 digikam/using-sidebar.docbook [from: digikam/sidebar.docbook - 100% similarity] M +2 -2 showfoto/index.docbook http://commits.kde.org/digikam-doc/9fc5dea36eae3d5c2698cc9df2fffe94703617f5 diff --git a/digikam/index.docbook b/digikam/index.docbook index 15f940a..99ccdb0 100644 --- a/digikam/index.docbook +++ b/digikam/index.docbook @@ -7,13 +7,15 @@ <!ENTITY digikam '<application>digiKam</application>'> <!-- relative path to snapshots for digikam and showfoto --> <!ENTITY path ""> - <!ENTITY doc-sidebar SYSTEM "sidebar.docbook"> <!-- introduction --> <!ENTITY doc-intro-background SYSTEM "intro-background.docbook"> <!ENTITY doc-intro-firstrun SYSTEM "intro-firstrun.docbook"> <!ENTITY doc-intro-fileformats SYSTEM "intro-fileformats.docbook"> <!ENTITY doc-intro-camerasupport SYSTEM "intro-camerasupport.docbook"> <!ENTITY doc-intro-pluginsupport SYSTEM "intro-pluginsupport.docbook"> +<!-- using application --> + <!ENTITY doc-using-mainwindow SYSTEM "using-mainwindow.docbook"> + <!ENTITY doc-using-sidebar SYSTEM "using-sidebar.docbook"> <!-- image editor --> <!ENTITY doc-photo-editing SYSTEM "photo-editing.docbook"> <!ENTITY doc-editor-color SYSTEM "editor-color.docbook"> @@ -104,566 +106,9 @@ <!-- *********************************************************************** --> -<chapter id="using-kapp"> <title>Using &digikam;</title> +<chapter id="using-digikam"> <title>Using &digikam;</title> - - <sect1 id="using-mainwindow"> <title>The Main &digikam; Window</title> - - <sect2 id="using-mainwindow-intro"> - <title>Introduction to the Main Window</title> - - <para> - <inlinemediaobject><imageobject><imagedata fileref="&path;maininterfacepreview.png" format="PNG" /> </imageobject> - </inlinemediaobject> - </para> - - <para>&digikam;'s main window has four areas. The first one is a sidebar in the left margin that lets you switch between 4 views: <guibutton>Albums</guibutton>, <guibutton>Dates</guibutton>, <guibutton>Tags</guibutton> and <guibutton>Searches</guibutton>. Then there is a tree navigator panel showing the selected view. The main image window is right in the center. And on the right hand side there is another <link linkend="using-sidebar">sidebar</link> shown. This one can be used to show all information about your images. You can use all these views to organize and find your photographs. - </para> - <para>To unclutter the interface, either toggle the sidebars away with a &LMB;, or use the full screen view mode (F11, Ctrl+Shift+F).</para> - <para>Drag and Drop of images works about everywhere: d&d an image into another branch of the album tree, across the horizontal album separation line, or to another application window. The only restriction is that you cannot d&d into tag, date or searches.</para> - - <anchor id="maininterface-statusbar"/> - <para>The status bar at the bottom shows in all four views: - <itemizedlist> - <listitem><para>the file name when selecting a single file</para></listitem> - <listitem><para>selection information when several items are selected</para></listitem> - <listitem><para>progress bar for batch processes, ⪚ assigning tags</para></listitem> - <listitem><para>Quick filters:</para> - <para>- search string field: live filter on file names, captions (comments), and tags</para> - <para>- a file type selector lets you single out the most common ones: JPEG, PNG, TIFF, RAW, movies and audio</para> - <para>- a rating filter to select images rated with the clicked number of stars</para> - </listitem> - <listitem><para>a thumbnail size slider</para></listitem> - <listitem><para>a navigation bar that leads through the images in the main view</para></listitem> - </itemizedlist> - </para> - - <note> - <para>The text filter is only used for those fields which are actually displayed in the icon view. E.g. filename matching only works if filenames are displayed. The fields which are displayed can be configured in the album settings dialog.</para> - </note> - - <para> - The window top shows the menu bar and the main toolbar below. - </para> - - <para> - <inlinemediaobject> - <imageobject><imagedata fileref="&path;maininterfacetoolbar.png" format="PNG"/></imageobject> - <textobject> <phrase>The Default Main Toolbar</phrase> </textobject> - </inlinemediaobject> - </para> - - <para> - - <orderedlist> - - <listitem><para>Go one view backwards in the main window view history (Alt+Left)</para> </listitem> - - <listitem><para>Go one view forwards in the main window view history (Alt+Right)</para> </listitem> - - <listitem><para>Add images, import function (Ctrl+I)</para></listitem> - - <listitem><para>Create a new Album (Ctrl+N)</para></listitem> - - <listitem><para>Edit Album properties</para></listitem> - - <listitem><para>Quick Search tool (Ctrl+F)</para></listitem> - - <listitem><para>View image (F3)</para></listitem> - - <listitem><para>Open in Image Editor (F4)</para></listitem> - - <listitem><para>Rename Image (F2)</para></listitem> - - <listitem><para>Toggle Full Screen (Ctrl+Shift+F)</para></listitem> - - <listitem><para>Slide Show (F9)</para></listitem> - - </orderedlist> - - </para> - - </sect2> - - <sect2 id="using-myalbumsview"> - <title>Albums View</title> - - <para> - The "Albums" tree provides an organized view of your photograph albums. All photographs that are managed by &digikam; are stored in a single folder branch. The albums can be sorted by their folder layout on the hard disk, by the Collection name that has been set in the Album Properties or by the Date of that Albums (this date can also be changed in the Properties of each Album). - </para> - - <para> - You can switch between these sort orders using <guimenuitem>Sort Albums</guimenuitem> from the <guimenu>View</guimenu> menu. - </para> - - <sect3 id="using-createnewalbum"> - <title>Creating a New Album</title> - - <para> - There are a number of ways to create a new Album. You can create a new Album when you upload new photographs from the Camera using the Camera Tool. You can also create a new empty Album by clicking the <guibutton>New</guibutton> button on the tool bar. As an additional option, you can create a new Album by importing an existing folder of photographs from your computer; just select <menuchoice><guimenu>Import</guimenu> <guimenuitem>Add Folders...</guimenuitem></menuchoice> from the menu bar and select the folder that you want to import. An Album will be created with the same name as the hard disk folder. You can use drag and drop to import a folder. Drag a folder icon, for example from a &konqueror; window. Then drop it on the album list on the left. A menu will appear that gives you the option to move or copy the folder into &digikam;. - </para> - - </sect3> - - <sect3 id="using-deletealbum"> - <title>Deleting an Album</title> - - <para> - When you delete an Album from &digikam; it will be moved into the internal Trash Can. As an option you could change this behavior, so that delete really did remove the Album and all of the photographs in it. This can be changed by selecting <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &digikam;</guimenuitem></menuchoice> and selecting the Miscellaneous page. At the top of this page are the settings that control what happens when a photograph is deleted. To delete an Album right-click the Album in the "Albums" tree and select Delete Album from Hard Disk from the context menu. - </para> - - </sect3> - - <sect3 id="using-addphototoalbum"> - <title>Adding a Photograph to an Album</title> - - <para> - Most of the time you will create new Albums and populate them with photographs directly from your camera using the Camera Tool. However, sometimes you may want to add a photograph that you already have on your computer to an existing Album. To add a photograph to an Album, make sure that the Album is selected. Then, either click the <guilabel>Add Images</guilabel> icon in the tool bar or select <menuchoice><guimenu>Import</guimenu> <guimenuitem>Add Images...</guimenuitem></menuchoice> from the menu bar. Select the photographs that you want to add from the file dialog and click <guilabel>Open</guilabel>. The photographs will be copied into the Album. Additionally, you can use drag and drop to import photographs. Drag the photographs icons, for example from a &konqueror; window. Then drop it on the image list on the right hand side. - </para> - - <para> - If you have a scanner configured, you can also scan a photograph straight into an Album. Select - <menuchoice><guimenu>Import</guimenu> - <guimenuitem>Import from Scanner...</guimenuitem></menuchoice>. - </para> - - </sect3> - - <sect3 id="using-movecopyitem"> - <title>Moving or Copying Photographs Between Albums</title> - - <para> - Simply drag the photograph and drop it on the destination Album to move or copy it from one Album to another. A menu will appear that gives you the option to <guilabel>Move</guilabel> or <guilabel>Copy</guilabel> the photograph. You can move or copy multiple photographs the same way, just select all the photographs that you want to move and drag them on to the destination Album. - </para> - - </sect3> - - <sect3 id="using-managealbums"> - <title>Managing Albums</title> - - <anchor id="albumpropsedit.anchor"/> - - <para> - An Album contains a set of photographs. Album Properties allows you to set information about this set. To access the Album Properties right-click on an Album and select <guilabel>Edit Album Properties</guilabel> from the context menu. - </para> - - <para>The Album Properties dialog allows you to set:</para> - - <example> - <title>The Album Properties Dialog</title> - <screenshot><mediaobject><imageobject><imagedata fileref="&path;maininterfacealbumproperties.png" format="PNG" /> </imageobject></mediaobject></screenshot> - </example> - - <itemizedlist> - - <listitem><para>The Album <guilabel>Title</guilabel> : this will be used in the "Albums" list. - </para></listitem> - - <listitem><para>The Album <guilabel>Collection</guilabel> : this is a way of grouping your Albums together by a common label. The Collection you set will be used to order your albums when you select <guilabel>By Collection</guilabel> from the drop down box in the tool bar or using <menuchoice><guimenu>View</guimenu><guimenuitem>Sort Albums</guimenuitem><guimenuitem>By Collection</guimenuitem></menuchoice>. If you want to add and delete Collection labels, use the <link linkend="setup-collection">Collection Settings</link> dialog. - </para></listitem> - - <listitem><para>The <guilabel>Comments</guilabel> for the Album : this will be shown in the banner at the top of the main Image Window. - </para></listitem> - - <listitem><para>The Album <guilabel>Date</guilabel> : this will be used when you order your Albums by date using <menuchoice><guimenu>View</guimenu><guimenuitem>Sort Albums</guimenuitem><guimenuitem>By Date</guimenuitem></menuchoice>. - </para></listitem> - - <listitem><para><guilabel>Oldest, Average, Newest</guilabel> buttons : these will set the <guilabel>Date</guilabel> to the oldest, average or latest date of the images in that album. It will first try to calculate the average date of the images in the album based on the EXIF-headers. If that fails it will fall back to the modification date of the files in that folder. - </para></listitem> - - </itemizedlist> - - </sect3> - - <sect3 id="using-setalbumicon"> - <title>Setting the Album Icon</title> - - <para> - When you first view an Album, &digikam; selects the first photograph in the Album as the icon to display in the "Albums" list. This helps you remember what kind of photographs are contained in an Album. Sometimes the first photograph in the Album is not the most representative and you want to select a different one as the Album icon. - </para> - - <para> - To select a different photograph as the Album icon, right-click on the photograph that you want to use as the Album icon and select "Set as Album Thumbnail" from the context menu. Additionally you can use drag and drop to set the Album icon. Drag the photographs icon and drop it on the currently selected Album in the Album list. - </para> - - <note> - <para> - An Album can only be in one Album Collection and Album Collections cannot be nested. - </para> - - <para> - &digikam; also supports tagging individual photographs using the "My Tags" area at the left of the main window. Album Collections are different from photograph tagging because the Album Collection applies to all the photographs in an Album rather than to individual photographs. You can use both Album Collections and tagging to organize your photographs. - </para> - </note> - - </sect3> - - </sect2> - - <sect2 id="using-imageview"> - <title>Image View</title> - - <sect3> - <title>Introduction</title> - - <para> - The Image Window provides the main view of your images. When you select an Album the images contained in that Album will be displayed in the Image Window. Each image is displayed as a thumbnail. You can alter the size of the thumbnails using the magnifier slider in the lower right of the status bar. - <inlinemediaobject> - <imageobject><imagedata fileref="&path;editorzoombuttons.png" format="PNG"/></imageobject> - <textobject> <phrase>The thumbnail size slider</phrase> </textobject> - </inlinemediaobject> - </para> - - <para> - The first time you select an Album you may have to wait briefly while the thumbnails are generated, unless you used the - <menuchoice> - <guimenu>Tools</guimenu> - <guimenuitem>Rebuild all Thumbnails...</guimenuitem> - </menuchoice> menu item beforehand. - </para> - - <para> - Information about each photograph is displayed below each thumbnail. You can control what information is displayed from the - <menuchoice> - <guimenu>Settings</guimenu> - <guimenuitem>Configure &digikam;</guimenuitem> - </menuchoice> - dialog. Select the <guilabel>Album View</guilabel> page and look for the <guilabel>Icon-View Options</guilabel> section. - </para> - - <para> - The thumbnails have Tool Tips which will pop up if you allow the mouse to dwell over a thumbnail for a moment. The Tool Tip shows the most important properties of the photograph including any tags that you have applied. The screenshot at the top of the <link linkend="using-mainwindow-intro">Introduction to the Main Window</link> section shows a Tool Tip being displayed. - </para> - - </sect3> - - <sect3> - <title>Image Management</title> - - <para> - Photographs are what &digikam; is all about. Albums and Tags allow you to organize and find your photographs in a way that suits you. You can access all of the functions that &digikam; can perform on a photograph by right-clicking the thumbnail (context menu) or by selecting from the Image menu in the menu bar. You have the choice between viewing the images, viewing by slide show, or of editing the images. - </para> - - </sect3> - - <sect3 id="using-imageviewing"> - <title>Viewing an image</title> - - <para> - There are several possibilities to view an image. You can either click on it, push - <menuchoice> - <shortcut><keycombo action="press"><keycap>F3</keycap></keycombo></shortcut> - <guimenu>Image</guimenu><guimenuitem>View...</guimenuitem> - </menuchoice> or - <menuchoice> - <shortcut><keycombo action="press">&Enter;</keycombo></shortcut> - <guimenu></guimenu></menuchoice> - or select <menuchoice><guimenu>View</guimenu></menuchoice> from the context menu. The image will take the whole central space of the main window. For viewing it larger, click the sidebars away (by just clicking on them). While viewing images you can take action from the context menu at any time. To get back to the album view, just click again or press - <menuchoice> - <shortcut><keycombo action="press">&Esc;</keycombo></shortcut> - <guimenu></guimenu></menuchoice> or - <menuchoice> - <shortcut><keycombo action="press"><keycap>F3</keycap></keycombo></shortcut> - <guimenu></guimenu></menuchoice> puts you back into the main window. - <inlinemediaobject> - <imageobject><imagedata fileref="&path;maininterfaceview.png" format="PNG"/></imageobject> - <textobject> <phrase>The viewer with thumbnail slider below</phrase> </textobject> - </inlinemediaobject> - </para> - - </sect3> - - <sect3 id="using-imageediting"> - <title>Editing a Photograph</title> - - <para> - You can open the Image Editor on a photograph either using - <menuchoice> - <shortcut><keycap>F4</keycap></shortcut> - <guimenu>Image</guimenu><guimenuitem>Edit...</guimenuitem> - </menuchoice> - or by right-clicking and selecting <guilabel>Edit</guilabel> from the context menu. See the <link linkend="using-imageeditor">&digikam; Image Editor</link> section for instructions on how to edit your photographs. The Image Editor lets you view your photographs and make a number of adjustments to them. - </para> - - </sect3> - - <sect3 id="using-externalapp"> - <title>Viewing or Editing a Photograph With Another Application</title> - - <para> - Sometimes &digikam; may not provide all of the capabilities you need. You can open a photograph in another application by right-clicking on it and selecting from the <guilabel>Open With</guilabel> sub-menu. The list of applications that appear in this menu is controlled by the standard desktop file associations for the image format type of this photograph. Consult the desktop manual for instructions on changing these file associations if the application that you need is not listed. - </para> - - <para> - Note that there can be a problem with meta-data embedded in photographs when they are edited by other image manipulation applications. Some applications do not retain the photograph's meta-data when you save a modified image. This means that if you modify a photograph using one of these programs you will lose information such as orientation, aperture &etc; that are stored in the EXIF and IPTC tags. - </para> - - </sect3> - - <sect3 id="using-rotateimage"> - <title>Lossless Image Rotation</title> - - <note><para> - You will need to have the Kipi JPEG Lossless Plugin installed for the rotation features. If you do not have this plugin installed you can still rotate your photographs, but you have use the Image Editor. The Image Editor uses a different method of rotating an image, you may not notice any difference but the Image Editor method can cause some loss of quality in the photograph when saving the picture as JPEG. The rotation methods described here uses the Kipi JPEG Lossless Plugin which preserve the quality in the original photograph. - </para></note> - - <para> - &digikam; provides two ways to get your photographs the right way up. The simplest method is to right-click the thumbnail and select <guilabel>Rotate</guilabel> and then pick the correct amount of rotation needed. - </para> - - <para> - Many digital cameras now have an orientation sensor. This sensor can detect how you hold the camera while taking an image. It stores this orientation information inside the image. This meta data is stored in an embedded meta-data section called EXIF. The cameras could rotate the image themselves right away, but they have limited processing power, so they leave this job to an application like &digikam;. If the camera is storing the orientation, then &digikam; can use it to automatically rotate your photographs so that they are the correct way up when you display them. &digikam; will rotate the image on disk according to this orientation information. - </para> - - <para> - The photograph is rotated without loss of quality and the orientation information is set to normal, so that other EXIF-aware applications will handle it correctly. To use this feature, right-click on the thumbnail and select - <menuchoice> - <guimenu>Image</guimenu><guimenuitem>Auto Rotate/Flip Using EXIF Information</guimenuitem> - </menuchoice> - . The Camera Tool can perform this operation automatically when it uploads the photographs from your camera which will ensure that your photographs are always the right way up. The rotate operation will do nothing if your camera does not include this information in the photos. - </para> - - </sect3> - - <sect3 id="using-renameimage"> - <title>Renaming a Photograph</title> - - <para> - You can change the filename for a photograph by right-clicking a thumbnail and selecting - <menuchoice> - <shortcut><keycap>F2</keycap></shortcut> - <guimenu>Rename</guimenu> - </menuchoice>. Remember to keep the file extension (.jpg, .tif, &etc;). - </para> - - </sect3> - - <sect3 id="using-deleteimage"> - <title>Deleting a Photograph</title> - - <para> - When you delete a photograph from &digikam; it will be moved to the internal Trash Can. - <menuchoice> - <shortcut><keycombo action="simul"><keycap>F8</keycap></keycombo> </shortcut> - <guimenu>Image</guimenu><guimenuitem>Delete</guimenuitem> - </menuchoice> or - <menuchoice> - <shortcut><keycap>Delete</keycap> </shortcut><guimenu></guimenu> - </menuchoice> - If you prefer that Delete really removes the photograph completely, than you can do that by - <menuchoice> - <shortcut>&Shift;<keycap> Delete</keycap> </shortcut> - <guimenu></guimenu> - </menuchoice> - </para> - <para>Deleting works from anywhere in any &digikam; windows</para> - - </sect3> - - </sect2> - - <sect2 id="using-mydatesview"> <title>Calendar View</title> - - <para><inlinemediaobject><imageobject><imagedata fileref="&path;maininterfacedateview.png" format="PNG" /> </imageobject> - <textobject><phrase>Dates View from Main Window</phrase></textobject></inlinemediaobject> - </para> - - <para> - The "Dates" view organizes your photographs based on their dates. &digikam; uses either the - EXIF date or, if no EXIF date is available, the last modification time of the file. - </para> - - <para> - When you select a month from the list, all images from that month are displayed in the Image View. - You can select days or weeks in the date sheet at the bottom of the Date View to show only the images - from the selected dates. - </para> - - </sect2> - - <sect2 id="using-mytagsview"> <title>Tags View (Keywords)</title> - - <para> - (Hierarchical) tagging provides a flexible and powerful way to organize and catalog your images. Tags are labels that can be applied to individual images or whole groups. Once a tag has been set to an image it can be found again by selecting the tag or doing a search. - </para> - - <example> <title>Selecting a tag and applying a new one</title> - <screenshot><mediaobject><imageobject><imagedata fileref="&path;maininterfacetagsview.png" format="PNG" /> </imageobject></mediaobject></screenshot> - </example> - - <para>When a tag is selected, all of the images that are marked with that tag are displayed. </para> - - <para> - Tags can be arranged in a hierarchical tree. This allows you to organize your tags in a logical manner. One can collapse parts of the tree in the "Tags" list so that one can easily find the tags that you are looking for. - </para> - - <tip> - <para>Tags are stored in a database for fast access, and, the applied tags are written into IPTC data fields of the image (at least for JPEG). So can use your tags with other programs or, in case of loss of that data in the database, the tags will be re-imported when the image is noticed by &digikam;.</para></tip> - - <sect3 id="using-managetags"> <title>Managing Tags</title> - - <para> - You can add new tags by right-clicking on either the "Tags" label or an existing tag and selecting <guilabel>New Tag</guilabel>. If you add a new tag by right-clicking on an existing tag, your new tag will be created as a sub-tag. - </para> - - <para> - You can delete a Tag by right-clicking on the Tag you want to delete and selecting <guilabel>Delete</guilabel> Tag. When you delete a tag, the photographs themselves are not deleted. Simply the tag is removed from those photographs. - </para> - - <para> - You can move the position of a Tag within the tree by dragging it to the position that you want and dropping it there. A menu will appear that gives you the option to - <guilabel>Move</guilabel> the tag. This works from the left and right sidebar. A tag can only be in one place in the tree at a time. - </para> - - <para> - You can set the Tag Properties by right-clicking on a Tag and selecting <guilabel>Edit Tag Properties</guilabel>. The Tag Properties allow you to change the name of the tag and the icon used in the "Tags" tree. - </para> - - <para> - To select a different photograph as the tag icon, right-click on the photograph that you want to use as the tag icon and select "Set as Tag Thumbnail" from the context menu. Additionally you can use drag and drop to set the tag icon. Drag the images icon and drop it on the currently selected tag in the tag list. - </para> - - </sect3> - - <sect3 id="using-taggingimages"> <title>Tagging Photographs</title> - - <para> - Before you can get the most out of &digikam;'s Tagging capabilities, you must first tag your photographs. There are two methods of tagging photographs. Once you have identified the photographs that you want to tag you can either drag and drop them onto the Tag in the "My Tags" tree or, by right-clicking on the selected photographs in the Image Window, you can use the <guilabel>Assign Tag</guilabel> menu to select the Tags you wish to set. - </para> - - <para> - You can label a photograph with as many tags as you like. The photograph will appear when you select any of the tags that are set against it. This way you can set a tag for each person in a photograph, as well as the place the photograph was taken, the event it was taken at, &etc; - </para> - - <example> <title>Tagging Image with context menu, or with drag&drop from either sidebar</title> - <screenshot><mediaobject><imageobject><imagedata fileref="&path;maininterfaceassigntags.png" format="PNG" /> </imageobject></mediaobject></screenshot> - </example> - - <para> - Once you have tagged a photograph, the tag name will appear under the thumbnail in the Image Window. - </para> - - <para> - You can remove a tag from a photograph by right-clicking on the photograph and using the <guilabel>Remove</guilabel> Tag menu. This menu will only show those tags that have been set on this photograph. - </para> - - </sect3> - - </sect2> - - <sect2> <title>The Timeline</title> - - <para>The timeline view shows a timescale-adjustable histogram of the numbers of images per time unit. A selection frame moves over the histogram. To select a time frame just click into the <emphasis>lower square</emphasis> of the selection frame where the time unit is indicated. That will show all corresponding images in the main window.</para> - <para>In the field right below you can enter a title and save your selection. It will then appear in the list field at the bottom.</para> - <example> - <title>The Timeline View in Action</title> - <screenshot><mediaobject><imageobject><imagedata fileref="&path;timeline.png" format="PNG" /> </imageobject></mediaobject></screenshot> - </example> - </sect2> - - <sect2 id="using-mysearchesview"> <title>Searches View</title> - - <sect3> - <title>The Quick Search</title> - <anchor id="quicksearchtool.anchor"/> - - <para> - Quick Search is a little box in the status bar and provides you with a simple means to search all data fields in the album library with a single query. You can enter any arguments in the <guilabel>Search</guilabel> text field and it will be used to determine the results. For instance, you can enter the string 'birthday' to search the complete album library for occurrences of the word 'birthday' in all photograph descriptions, or '05.png' to search for a specific image file name '05.png' (no escaping as in regexpressions needed). - </para> - - <para>Search Properties:<itemizedlist> - <listitem><para>searches are case insensitive</para></listitem> - <listitem><para>blank separated search terms are boolean AND combinations</para></listitem> - <listitem><para>special characters are literal and not interpreted ( . * ? / &etc;)</para></listitem> - <listitem><para>include all elements of the database: names, rating, keywords, tags, albums, collections, dates (and more in the future)</para></listitem> - </itemizedlist> - </para> - - <para> - The Quick Search really works intuitively. If you want to search images from a certain date, you can simply type <userinput>2005</userinput>, but it is even possible to search for a certain month. Just enter the name of the month in your local language. If it is Dutch, you can enter <userinput>Maart</userinput>, to see the images of March. The combination of 'Maart 2006' means 'Maart AND 2006' and therefore is equivalent to '2006 Maart'. Or look for 'Maart 2007 cr2' to find all RAW files of March 2007. - </para> - <para>Next to the search box is a little LED that turns green if the search has results. Just click on it to reset the filtering and show all images again. If the search is not succeessful, the LED turns red.</para> - - <example> - <title>Quick Search Tool Dialog in Action</title> - <screenshot><mediaobject><imageobject><imagedata fileref="&path;maininterfacequicksearch.png" format="PNG" /> </imageobject></mediaobject></screenshot> - </example> - </sect3> - - <sect3> <title>Searches proper</title> - - <para> - The more sophisticated search tool is a tab on the left sidebar (binocular icon). If you open it, you will be presented with a simple search box the works as described above, except that you can save this search as a live folder that always filters for what you entered as search criteria. When saved, the filter will appear in the list. </para> - <para> - When you are satisfied with your selection, click on the <guilabel>Ok</guilabel> button, and the search will be carried out, and the results displayed in "My Search" view from the main window. The <guilabel>Save search as</guilabel> text field will be used to label your query in "My Search" list. If you want to modify your selection after performing a search, simply right click on the item from "My Search" view and select an option from the pop-up menu. - </para> - <example> - <title>Quick Search Tool Dialog in Action</title> - <screenshot><mediaobject><imageobject><imagedata fileref="&path;searchinterface.png" format="PNG" /> </imageobject></mediaobject></screenshot> - </example> - - <para> - If you select <guilabel>Edit Search</guilabel>, the search form will re-appear, containing your previous search information. If you select <guilabel>Edit as Advanced Search</guilabel>, the advanced search tool dialog will be come up to modify your previous search information using more elaborate search rules. See the <link linkend="using-mainwindow-advancedsearchtool">The Advanced Search Tool</link> section for more information. - </para> - - <para> - If you want to remove an existing search from the list, just select <guilabel>Delete Search</guilabel> from the pop-up menu. - </para> - - <example> - <title>Search View from Main Window</title> - <screenshot><mediaobject><imageobject><imagedata fileref="&path;maininterfacesearchview.png" format="PNG" /> </imageobject></mediaobject></screenshot> - </example> - - </sect3> - - <sect3 id="using-mainwindow-advancedsearchtool"> - <title>The Advanced Search Tool</title> - <anchor id="advancedsearchtool.anchor"/> - - <para> - Advanced Search tool provides an extended search form with a wealth of search parameters, which can be used to search in specific fields of the &digikam; albums database. - </para> - - <para> - The <guilabel>Search Rules</guilabel> list is used to set all options to process a search query in the albums database. All rules are listed vertically and separated by an operator. An option can be added or deleted to the list using <guilabel>Add Search Group/Remove Group</guilabel>. Each option can be combined with another one using <guilabel>Meet all..</guilabel> or <guilabel>Meet any...</guilabel> or <guilabel>one of these...</guilabel> <guilabel>At least one...</guilabel> logical operators. Thus, one can construct searches of the type "AND NOT". - </para> - - </sect3> - - </sect2> - - <sect2 id="fuzzy-searches"> <title>Fuzzy Searches/Duplicates</title> - <para>&digikam; characterizes every image by a legthy number using a special technique (Haar algorithm) that make it possible to compare images by comparing this calculated signature. The less numerical difference there is between any two image signatures, the more they resemble each other. This technique has three implementations</para> - <itemizedlist> - <listitem><para>Similar items: This is a drag&drop zone where you can drop any image to find a similar one. A threshold can be modified in order to narrow down or enlarge the resulting selection. Drag an image from anywhere over the fuzzy search icon in the left sidebar, it will open and you drop it there.</para></listitem> - <listitem><para>Sketch: free hand color sketching: draw a quick sketch and &digikam; will find corresponding images. Again a threshold can be set.</para></listitem> - <listitem><para>Duplicates: after &digikam; has scanned all collections you will find a list of duplicates here. It's up to you of course to decide what to do with them. From the menu <menuchoice><guimenu>Tools</guimenu><guimenuitem>Rebuild all fingerprints...</guimenuitem></menuchoice> you can initiate a total rebuild of the image signatures (may take hours if you have a large collection, an estimate is 2 hours for 10'000 images) or from the bottom you can just rescan, which is much faster. <guimenu>Find duplicates</guimenu> will do just that, but it will take a long time too as it has to compare every image with any other image. Fortunately, you can refine your search by albums and/or tags.</para></listitem> - </itemizedlist> - - <example> - <title>Fuzzy search for similar image</title> - <screenshot><mediaobject><imageobject><imagedata fileref="&path;fuzzysearchsimilar.png" format="PNG" /></imageobject></mediaobject></screenshot> - </example> - - <example> - <title>Find duplicates while restricting to an album</title> - <screenshot><mediaobject> - <imageobject><imagedata fileref="&path;duplicates_albumsfilter.png" format="PNG" /></imageobject> - </mediaobject></screenshot> - </example> - </sect2> - - <sect2> <title>Map Searches</title> - <para>This tab provides an intuitive map search tool based on the marble widget. 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. 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 filtered and shown (provided your images have been geo-coded of course).</para> - <para>In the box below you can enter a name for your geo filter. It will be added to the list view below for future reference, it acts as a live geo folder.</para> - <example> <title>The Map Searches tab</title> - <screenshot><screeninfo>For higher resolution maps choose "More Info"</screeninfo><mediaobject><imageobject><imagedata fileref="&path;sidebargeolocation.png" format="PNG" /> </imageobject></mediaobject></screenshot> - </example> - - </sect2> - -</sect1> + &doc-using-mainwindow; <sect1 id="using-lighttable"> <title>The &digikam; Light Table</title> <para> @@ -709,7 +154,7 @@ </sect1> -&doc-sidebar; +&doc-using-sidebar; <sect1 id="dam"> <title>Digital Asset Management (DAM) with &digikam;</title> diff --git a/digikam/using-mainwindow.docbook b/digikam/using-mainwindow.docbook new file mode 100644 index 0000000..b83d2b6 --- /dev/null +++ b/digikam/using-mainwindow.docbook @@ -0,0 +1,582 @@ + <sect1 id="using-mainwindow"> <title>The Main &digikam; Window</title> + + <sect2 id="using-mainwindow-intro"> + <title>Introduction to the Main Window</title> + + <para> + <inlinemediaobject><imageobject><imagedata fileref="&path;maininterfacepreview.png" format="PNG" /> </imageobject> + </inlinemediaobject> + </para> + + <para>&digikam;'s main window has four areas. The first one is a sidebar in the left margin that lets you switch between 4 views: <guibutton>Albums</guibutton>, <guibutton>Dates</guibutton>, <guibutton>Tags</guibutton> and <guibutton>Searches</guibutton>. Then there is a tree navigator panel showing the selected view. The main image window is right in the center. And on the right hand side there is another <link linkend="using-sidebar">sidebar</link> shown. This one can be used to show all information about your images. You can use all these views to organize and find your photographs. + </para> + <para>To unclutter the interface, either toggle the sidebars away with a &LMB;, or use the full screen view mode (F11, Ctrl+Shift+F).</para> + <para>Drag and Drop of images works about everywhere: d&d an image into another branch of the album tree, across the horizontal album separation line, or to another application window. The only restriction is that you cannot d&d into tag, date or searches.</para> + + <anchor id="maininterface-statusbar"/> + <para>The status bar at the bottom shows in all four views: + <itemizedlist> + <listitem><para>the file name when selecting a single file</para></listitem> + <listitem><para>selection information when several items are selected</para></listitem> + <listitem><para>progress bar for batch processes, ⪚ assigning tags</para></listitem> + <listitem><para>Quick filters:</para> + <para>- search string field: live filter on file names, captions (comments), and tags</para> + <para>- a file type selector lets you single out the most common ones: JPEG, PNG, TIFF, RAW, movies and audio</para> + <para>- a rating filter to select images rated with the clicked number of stars</para> + </listitem> + <listitem><para>a thumbnail size slider</para></listitem> + <listitem><para>a navigation bar that leads through the images in the main view</para></listitem> + </itemizedlist> + </para> + + <note> + <para>The text filter is only used for those fields which are actually displayed in the icon view. E.g. filename matching only works if filenames are displayed. The fields which are displayed can be configured in the album settings dialog.</para> + </note> + + <para> + The window top shows the menu bar and the main toolbar below. + </para> + + <para> + <inlinemediaobject> + <imageobject><imagedata fileref="&path;maininterfacetoolbar.png" format="PNG"/></imageobject> + <textobject> <phrase>The Default Main Toolbar</phrase> </textobject> + </inlinemediaobject> + </para> + + <para> + + <orderedlist> + + <listitem><para>Go one view backwards in the main window view history (Alt+Left)</para> </listitem> + + <listitem><para>Go one view forwards in the main window view history (Alt+Right)</para> </listitem> + + <listitem><para>Add images, import function (Ctrl+I)</para></listitem> + + <listitem><para>Create a new Album (Ctrl+N)</para></listitem> + + <listitem><para>Edit Album properties</para></listitem> + + <listitem><para>Quick Search tool (Ctrl+F)</para></listitem> + + <listitem><para>View image (F3)</para></listitem> + + <listitem><para>Open in Image Editor (F4)</para></listitem> + + <listitem><para>Rename Image (F2)</para></listitem> + + <listitem><para>Toggle Full Screen (Ctrl+Shift+F)</para></listitem> + + <listitem><para>Slide Show (F9)</para></listitem> + + </orderedlist> + + </para> + + </sect2> + + <sect2 id="using-myalbumsview"> + <title>Albums View</title> + + <para> + The "Albums" tree provides an organized view of your photograph albums. All photographs that are managed by &digikam; are stored in a single folder branch. The albums can be sorted by their folder layout on the hard disk, by the Collection name that has been set in the Album Properties or by the Date of that Albums (this date can also be changed in the Properties of each Album). + </para> + + <para> + You can switch between these sort orders using <guimenuitem>Sort Albums</guimenuitem> from the <guimenu>View</guimenu> menu. + </para> + + <sect3 id="using-createnewalbum"> + <title>Creating a New Album</title> + + <para> + There are a number of ways to create a new Album. You can create a new Album when you upload new photographs from the Camera using the Camera Tool. You can also create a new empty Album by clicking the <guibutton>New</guibutton> button on the tool bar. As an additional option, you can create a new Album by importing an existing folder of photographs from your computer; just select <menuchoice><guimenu>Import</guimenu> <guimenuitem>Add Folders...</guimenuitem></menuchoice> from the menu bar and select the folder that you want to import. An Album will be created with the same name as the hard disk folder. You can use drag and drop to import a folder. Drag a folder icon, for example from a &konqueror; window. Then drop it on the album list on the left. A menu will appear that gives you the option to move or copy the folder into &digikam;. + </para> + + </sect3> + + <sect3 id="using-deletealbum"> + <title>Deleting an Album</title> + + <para> + When you delete an Album from &digikam; it will be moved into the internal Trash Can. As an option you could change this behavior, so that delete really did remove the Album and all of the photographs in it. This can be changed by selecting <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &digikam;</guimenuitem></menuchoice> and selecting the Miscellaneous page. At the top of this page are the settings that control what happens when a photograph is deleted. To delete an Album right-click the Album in the "Albums" tree and select Delete Album from Hard Disk from the context menu. + </para> + + </sect3> + + <sect3 id="using-addphototoalbum"> + <title>Adding a Photograph to an Album</title> + + <para> + Most of the time you will create new Albums and populate them with photographs directly from your camera using the Camera Tool. However, sometimes you may want to add a photograph that you already have on your computer to an existing Album. To add a photograph to an Album, make sure that the Album is selected. Then, either click the <guilabel>Add Images</guilabel> icon in the tool bar or select <menuchoice><guimenu>Import</guimenu> <guimenuitem>Add Images...</guimenuitem></menuchoice> from the menu bar. Select the photographs that you want to add from the file dialog and click <guilabel>Open</guilabel>. The photographs will be copied into the Album. Additionally, you can use drag and drop to import photographs. Drag the photographs icons, for example from a &konqueror; window. Then drop it on the image list on the right hand side. + </para> + + <para> + If you have a scanner configured, you can also scan a photograph straight into an Album. Select + <menuchoice><guimenu>Import</guimenu> + <guimenuitem>Import from Scanner...</guimenuitem></menuchoice>. + </para> + + </sect3> + + <sect3 id="using-movecopyitem"> + <title>Moving or Copying Photographs Between Albums</title> + + <para> + Simply drag the photograph and drop it on the destination Album to move or copy it from one Album to another. A menu will appear that gives you the option to <guilabel>Move</guilabel> or <guilabel>Copy</guilabel> the photograph. You can move or copy multiple photographs the same way, just select all the photographs that you want to move and drag them on to the destination Album. + </para> + + </sect3> + + <sect3 id="using-managealbums"> + <title>Managing Albums</title> + + <anchor id="albumpropsedit.anchor"/> + + <para> + An Album contains a set of photographs. Album Properties allows you to set information about this set. To access the Album Properties right-click on an Album and select <guilabel>Edit Album Properties</guilabel> from the context menu. + </para> + + <para>The Album Properties dialog allows you to set:</para> + + <example> + <title>The Album Properties Dialog</title> + <screenshot><mediaobject><imageobject><imagedata fileref="&path;maininterfacealbumproperties.png" format="PNG" /> </imageobject></mediaobject></screenshot> + </example> + + <itemizedlist> + + <listitem><para>The Album <guilabel>Title</guilabel> : this will be used in the "Albums" list. + </para></listitem> + + <listitem><para>The Album <guilabel>Collection</guilabel> : this is a way of grouping your Albums together by a common label. The Collection you set will be used to order your albums when you select <guilabel>By Collection</guilabel> from the drop down box in the tool bar or using <menuchoice><guimenu>View</guimenu><guimenuitem>Sort Albums</guimenuitem><guimenuitem>By Collection</guimenuitem></menuchoice>. If you want to add and delete Collection labels, use the <link linkend="setup-collection">Collection Settings</link> dialog. + </para></listitem> + + <listitem><para>The <guilabel>Comments</guilabel> for the Album : this will be shown in the banner at the top of the main Image Window. + </para></listitem> + + <listitem><para>The Album <guilabel>Date</guilabel> : this will be used when you order your Albums by date using <menuchoice><guimenu>View</guimenu><guimenuitem>Sort Albums</guimenuitem><guimenuitem>By Date</guimenuitem></menuchoice>. + </para></listitem> + + <listitem><para><guilabel>Oldest, Average, Newest</guilabel> buttons : these will set the <guilabel>Date</guilabel> to the oldest, average or latest date of the images in that album. It will first try to calculate the average date of the images in the album based on the EXIF-headers. If that fails it will fall back to the modification date of the files in that folder. + </para></listitem> + + </itemizedlist> + + </sect3> + + <sect3 id="using-setalbumicon"> + <title>Setting the Album Icon</title> + + <para> + When you first view an Album, &digikam; selects the first photograph in the Album as the icon to display in the "Albums" list. This helps you remember what kind of photographs are contained in an Album. Sometimes the first photograph in the Album is not the most representative and you want to select a different one as the Album icon. + </para> + + <para> + To select a different photograph as the Album icon, right-click on the photograph that you want to use as the Album icon and select "Set as Album Thumbnail" from the context menu. Additionally you can use drag and drop to set the Album icon. Drag the photographs icon and drop it on the currently selected Album in the Album list. + </para> + + <note> + <para> + An Album can only be in one Album Collection and Album Collections cannot be nested. + </para> + + <para> + &digikam; also supports tagging individual photographs using the "My Tags" area at the left of the main window. Album Collections are different from photograph tagging because the Album Collection applies to all the photographs in an Album rather than to individual photographs. You can use both Album Collections and tagging to organize your photographs. + </para> + </note> + + </sect3> + + </sect2> + + <sect2 id="using-imageview"> + <title>Image View</title> + + <sect3> + <title>Introduction</title> + + <para> + The Image Window provides the main view of your images. When you select an Album the images contained in that Album will be displayed in the Image Window. Each image is displayed as a thumbnail. You can alter the size of the thumbnails using the magnifier slider in the lower right of the status bar. + <inlinemediaobject> + <imageobject><imagedata fileref="&path;editorzoombuttons.png" format="PNG"/></imageobject> + <textobject> <phrase>The thumbnail size slider</phrase> </textobject> + </inlinemediaobject> + </para> + + <para> + The first time you select an Album you may have to wait briefly while the thumbnails are generated, unless you used the + <menuchoice> + <guimenu>Tools</guimenu> + <guimenuitem>Rebuild all Thumbnails...</guimenuitem> + </menuchoice> menu item beforehand. + </para> + + <para> + Information about each photograph is displayed below each thumbnail. You can control what information is displayed from the + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Configure &digikam;</guimenuitem> + </menuchoice> + dialog. Select the <guilabel>Album View</guilabel> page and look for the <guilabel>Icon-View Options</guilabel> section. + </para> + + <para> + The thumbnails have Tool Tips which will pop up if you allow the mouse to dwell over a thumbnail for a moment. The Tool Tip shows the most important properties of the photograph including any tags that you have applied. The screenshot at the top of the <link linkend="using-mainwindow-intro">Introduction to the Main Window</link> section shows a Tool Tip being displayed. + </para> + + </sect3> + + <sect3> + <title>Image Management</title> + + <para> + Photographs are what &digikam; is all about. Albums and Tags allow you to organize and find your photographs in a way that suits you. You can access all of the functions that &digikam; can perform on a photograph by right-clicking the thumbnail (context menu) or by selecting from the Image menu in the menu bar. You have the choice between viewing the images, viewing by slide show, or of editing the images. + </para> + + </sect3> + + <sect3 id="using-imageviewing"> + <title>Viewing an image</title> + + <para> + There are several possibilities to view an image. You can either click on it, push + <menuchoice> + <shortcut><keycombo action="press"><keycap>F3</keycap></keycombo></shortcut> + <guimenu>Image</guimenu><guimenuitem>View...</guimenuitem> + </menuchoice> or + <menuchoice> + <shortcut><keycombo action="press">&Enter;</keycombo></shortcut> + <guimenu></guimenu></menuchoice> + or select <menuchoice><guimenu>View</guimenu></menuchoice> from the context menu. The image will take the whole central space of the main window. For viewing it larger, click the sidebars away (by just clicking on them). While viewing images you can take action from the context menu at any time. To get back to the album view, just click again or press + <menuchoice> + <shortcut><keycombo action="press">&Esc;</keycombo></shortcut> + <guimenu></guimenu></menuchoice> or + <menuchoice> + <shortcut><keycombo action="press"><keycap>F3</keycap></keycombo></shortcut> + <guimenu></guimenu></menuchoice> puts you back into the main window. + <inlinemediaobject> + <imageobject><imagedata fileref="&path;maininterfaceview.png" format="PNG"/></imageobject> + <textobject> <phrase>The viewer with thumbnail slider below</phrase> </textobject> + </inlinemediaobject> + </para> + + </sect3> + + <sect3 id="using-imageediting"> + <title>Editing a Photograph</title> + + <para> + You can open the Image Editor on a photograph either using + <menuchoice> + <shortcut><keycap>F4</keycap></shortcut> + <guimenu>Image</guimenu><guimenuitem>Edit...</guimenuitem> + </menuchoice> + or by right-clicking and selecting <guilabel>Edit</guilabel> from the context menu. See the <link linkend="using-imageeditor">&digikam; Image Editor</link> section for instructions on how to edit your photographs. The Image Editor lets you view your photographs and make a number of adjustments to them. + </para> + + </sect3> + + <sect3 id="using-externalapp"> + <title>Viewing or Editing a Photograph With Another Application</title> + + <para> + Sometimes &digikam; may not provide all of the capabilities you need. You can open a photograph in another application by right-clicking on it and selecting from the <guilabel>Open With</guilabel> sub-menu. The list of applications that appear in this menu is controlled by the standard desktop file associations for the image format type of this photograph. Consult the desktop manual for instructions on changing these file associations if the application that you need is not listed. + </para> + + <para> + Note that there can be a problem with meta-data embedded in photographs when they are edited by other image manipulation applications. Some applications do not retain the photograph's meta-data when you save a modified image. This means that if you modify a photograph using one of these programs you will lose information such as orientation, aperture &etc; that are stored in the EXIF and IPTC tags. + </para> + + </sect3> + + <sect3 id="using-rotateimage"> + <title>Lossless Image Rotation</title> + + <note><para> + You will need to have the Kipi JPEG Lossless Plugin installed for the rotation features. If you do not have this plugin installed you can still rotate your photographs, but you have use the Image Editor. The Image Editor uses a different method of rotating an image, you may not notice any difference but the Image Editor method can cause some loss of quality in the photograph when saving the picture as JPEG. The rotation methods described here uses the Kipi JPEG Lossless Plugin which preserve the quality in the original photograph. + </para></note> + + <para> + &digikam; provides two ways to get your photographs the right way up. The simplest method is to right-click the thumbnail and select <guilabel>Rotate</guilabel> and then pick the correct amount of rotation needed. + </para> + + <para> + Many digital cameras now have an orientation sensor. This sensor can detect how you hold the camera while taking an image. It stores this orientation information inside the image. This meta data is stored in an embedded meta-data section called EXIF. The cameras could rotate the image themselves right away, but they have limited processing power, so they leave this job to an application like &digikam;. If the camera is storing the orientation, then &digikam; can use it to automatically rotate your photographs so that they are the correct way up when you display them. &digikam; will rotate the image on disk according to this orientation information. + </para> + + <para> + The photograph is rotated without loss of quality and the orientation information is set to normal, so that other EXIF-aware applications will handle it correctly. To use this feature, right-click on the thumbnail and select + <menuchoice> + <guimenu>Image</guimenu><guimenuitem>Auto Rotate/Flip Using EXIF Information</guimenuitem> + </menuchoice> + . The Camera Tool can perform this operation automatically when it uploads the photographs from your camera which will ensure that your photographs are always the right way up. The rotate operation will do nothing if your camera does not include this information in the photos. + </para> + + </sect3> + + <sect3 id="using-renameimage"> + <title>Renaming a Photograph</title> + + <para> + You can change the filename for a photograph by right-clicking a thumbnail and selecting + <menuchoice> + <shortcut><keycap>F2</keycap></shortcut> + <guimenu>Rename</guimenu> + </menuchoice>. Remember to keep the file extension (.jpg, .tif, &etc;). + </para> + + </sect3> + + <sect3 id="using-deleteimage"> + <title>Deleting a Photograph</title> + + <para> + When you delete a photograph from &digikam; it will be moved to the internal Trash Can. + <menuchoice> + <shortcut><keycombo action="simul"><keycap>F8</keycap></keycombo> </shortcut> + <guimenu>Image</guimenu><guimenuitem>Delete</guimenuitem> + </menuchoice> or + <menuchoice> + <shortcut><keycap>Delete</keycap> </shortcut><guimenu></guimenu> + </menuchoice> + If you prefer that Delete really removes the photograph completely, than you can do that by + <menuchoice> + <shortcut>&Shift;<keycap> Delete</keycap> </shortcut> + <guimenu></guimenu> + </menuchoice> + </para> + <para>Deleting works from anywhere in any &digikam; windows</para> + + </sect3> + + </sect2> + + <sect2 id="using-mydatesview"> <title>Calendar View</title> + + <para><inlinemediaobject><imageobject><imagedata fileref="&path;maininterfacedateview.png" format="PNG" /> </imageobject> + <textobject><phrase>Dates View from Main Window</phrase></textobject></inlinemediaobject> + </para> + + <para> + The "Dates" view organizes your photographs based on their dates. &digikam; uses either the + EXIF date or, if no EXIF date is available, the last modification time of the file. + </para> + + <para> + When you select a month from the list, all images from that month are displayed in the Image View. + You can select days or weeks in the date sheet at the bottom of the Date View to show only the images + from the selected dates. + </para> + + </sect2> + + <sect2 id="using-mytagsview"> <title>Tags View (Keywords)</title> + + <para> + (Hierarchical) tagging provides a flexible and powerful way to organize and catalog your images. Tags are labels that can be applied to individual images or whole groups. Once a tag has been set to an image it can be found again by selecting the tag or doing a search. + </para> + + <example> <title>Selecting a tag and applying a new one</title> + <screenshot><mediaobject><imageobject><imagedata fileref="&path;maininterfacetagsview.png" format="PNG" /> </imageobject></mediaobject></screenshot> + </example> + + <para>When a tag is selected, all of the images that are marked with that tag are displayed. </para> + + <para> + Tags can be arranged in a hierarchical tree. This allows you to organize your tags in a logical manner. One can collapse parts of the tree in the "Tags" list so that one can easily find the tags that you are looking for. + </para> + + <tip> + <para>Tags are stored in a database for fast access, and, the applied tags are written into IPTC data fields of the image (at least for JPEG). So can use your tags with other programs or, in case of loss of that data in the database, the tags will be re-imported when the image is noticed by &digikam;.</para></tip> + + <sect3 id="using-managetags"> <title>Managing Tags</title> + + <para> + You can add new tags by right-clicking on either the "Tags" label or an existing tag and selecting <guilabel>New Tag</guilabel>. If you add a new tag by right-clicking on an existing tag, your new tag will be created as a sub-tag. + </para> + + <para> + You can delete a Tag by right-clicking on the Tag you want to delete and selecting <guilabel>Delete</guilabel> Tag. When you delete a tag, the photographs themselves are not deleted. Simply the tag is removed from those photographs. + </para> + + <para> + You can move the position of a Tag within the tree by dragging it to the position that you want and dropping it there. A menu will appear that gives you the option to + <guilabel>Move</guilabel> the tag. This works from the left and right sidebar. A tag can only be in one place in the tree at a time. + </para> + + <para> + You can set the Tag Properties by right-clicking on a Tag and selecting <guilabel>Edit Tag Properties</guilabel>. The Tag Properties allow you to change the name of the tag and the icon used in the "Tags" tree. + </para> + + <para> + To select a different photograph as the tag icon, right-click on the photograph that you want to use as the tag icon and select "Set as Tag Thumbnail" from the context menu. Additionally you can use drag and drop to set the tag icon. Drag the images icon and drop it on the currently selected tag in the tag list. + </para> + + </sect3> + + <sect3 id="using-taggingimages"> <title>Tagging Photographs</title> + + <para> + Before you can get the most out of &digikam;'s Tagging capabilities, you must first tag your photographs. There are two methods of tagging photographs. Once you have identified the photographs that you want to tag you can either drag and drop them onto the Tag in the "My Tags" tree or, by right-clicking on the selected photographs in the Image Window, you can use the <guilabel>Assign Tag</guilabel> menu to select the Tags you wish to set. + </para> + + <para> + You can label a photograph with as many tags as you like. The photograph will appear when you select any of the tags that are set against it. This way you can set a tag for each person in a photograph, as well as the place the photograph was taken, the event it was taken at, &etc; + </para> + + <example> <title>Tagging Image with context menu, or with drag&drop from either sidebar</title> + <screenshot><mediaobject><imageobject><imagedata fileref="&path;maininterfaceassigntags.png" format="PNG" /> </imageobject></mediaobject></screenshot> + </example> + + <para> + Once you have tagged a photograph, the tag name will appear under the thumbnail in the Image Window. + </para> + + <para> + You can remove a tag from a photograph by right-clicking on the photograph and using the <guilabel>Remove</guilabel> Tag menu. This menu will only show those tags that have been set on this photograph. + </para> + + </sect3> + + </sect2> + + <sect2> <title>The Timeline</title> + + <para> + The timeline view shows a timescale-adjustable histogram of the numbers of images per time unit. A selection frame moves over the histogram. To select a time frame just click into the <emphasis>lower square</emphasis> of the selection frame where the time unit is indicated. That will show all corresponding images in the main window. + </para> + + <para> + In the field right below you can enter a title and save your selection. It will then appear in the list field at the bottom. + </para> + + <example> + + <title>The Timeline View in Action</title> + <screenshot><mediaobject><imageobject><imagedata fileref="&path;timeline.png" format="PNG" /> </imageobject></mediaobject></screenshot> + + </example> + + </sect2> + + <sect2 id="using-mysearchesview"> <title>Searches View</title> + + <sect3> + <title>The Quick Search</title> + <anchor id="quicksearchtool.anchor"/> + + <para> + Quick Search is a little box in the status bar and provides you with a simple means to search all data fields in the album library with a single query. You can enter any arguments in the <guilabel>Search</guilabel> text field and it will be used to determine the results. For instance, you can enter the string 'birthday' to search the complete album library for occurrences of the word 'birthday' in all photograph descriptions, or '05.png' to search for a specific image file name '05.png' (no escaping as in regexpressions needed). + </para> + + <para>Search Properties:<itemizedlist> + <listitem><para>searches are case insensitive</para></listitem> + <listitem><para>blank separated search terms are boolean AND combinations</para></listitem> + <listitem><para>special characters are literal and not interpreted ( . * ? / &etc;)</para></listitem> + <listitem><para>include all elements of the database: names, rating, keywords, tags, albums, collections, dates (and more in the future)</para></listitem> + </itemizedlist> + </para> + + <para> + The Quick Search really works intuitively. If you want to search images from a certain date, you can simply type <userinput>2005</userinput>, but it is even possible to search for a certain month. Just enter the name of the month in your local language. If it is Dutch, you can enter <userinput>Maart</userinput>, to see the images of March. The combination of 'Maart 2006' means 'Maart AND 2006' and therefore is equivalent to '2006 Maart'. Or look for 'Maart 2007 cr2' to find all RAW files of March 2007. + </para> + <para>Next to the search box is a little LED that turns green if the search has results. Just click on it to reset the filtering and show all images again. If the search is not succeessful, the LED turns red.</para> + + <example> + <title>Quick Search Tool Dialog in Action</title> + <screenshot><mediaobject><imageobject><imagedata fileref="&path;maininterfacequicksearch.png" format="PNG" /> </imageobject></mediaobject></screenshot> + </example> + </sect3> + + <sect3> <title>Searches proper</title> + + <para> + The more sophisticated search tool is a tab on the left sidebar (binocular icon). If you open it, you will be presented with a simple search box the works as described above, except that you can save this search as a live folder that always filters for what you entered as search criteria. When saved, the filter will appear in the list. </para> + <para> + When you are satisfied with your selection, click on the <guilabel>Ok</guilabel> button, and the search will be carried out, and the results displayed in "My Search" view from the main window. The <guilabel>Save search as</guilabel> text field will be used to label your query in "My Search" list. If you want to modify your selection after performing a search, simply right click on the item from "My Search" view and select an option from the pop-up menu. + </para> + <example> + <title>Quick Search Tool Dialog in Action</title> + <screenshot><mediaobject><imageobject><imagedata fileref="&path;searchinterface.png" format="PNG" /> </imageobject></mediaobject></screenshot> + </example> + + <para> + If you select <guilabel>Edit Search</guilabel>, the search form will re-appear, containing your previous search information. If you select <guilabel>Edit as Advanced Search</guilabel>, the advanced search tool dialog will be come up to modify your previous search information using more elaborate search rules. See the <link linkend="using-mainwindow-advancedsearchtool">The Advanced Search Tool</link> section for more information. + </para> + + <para> + If you want to remove an existing search from the list, just select <guilabel>Delete Search</guilabel> from the pop-up menu. + </para> + + <example> + <title>Search View from Main Window</title> + <screenshot><mediaobject><imageobject><imagedata fileref="&path;maininterfacesearchview.png" format="PNG" /> </imageobject></mediaobject></screenshot> + </example> + + </sect3> + + <sect3 id="using-mainwindow-advancedsearchtool"> + <title>The Advanced Search Tool</title> + <anchor id="advancedsearchtool.anchor"/> + + <para> + Advanced Search tool provides an extended search form with a wealth of search parameters, which can be used to search in specific fields of the &digikam; albums database. + </para> + + <para> + The <guilabel>Search Rules</guilabel> list is used to set all options to process a search query in the albums database. All rules are listed vertically and separated by an operator. An option can be added or deleted to the list using <guilabel>Add Search Group/Remove Group</guilabel>. Each option can be combined with another one using <guilabel>Meet all..</guilabel> or <guilabel>Meet any...</guilabel> or <guilabel>one of these...</guilabel> <guilabel>At least one...</guilabel> logical operators. Thus, one can construct searches of the type "AND NOT". + </para> + + </sect3> + + </sect2> + + <sect2 id="fuzzy-searches"> <title>Fuzzy Searches/Duplicates</title> + <para>&digikam; characterizes every image by a legthy number using a special technique (Haar algorithm) that make it possible to compare images by comparing this calculated signature. The less numerical difference there is between any two image signatures, the more they resemble each other. This technique has three implementations</para> + <itemizedlist> + <listitem><para>Similar items: This is a drag&drop zone where you can drop any image to find a similar one. A threshold can be modified in order to narrow down or enlarge the resulting selection. Drag an image from anywhere over the fuzzy search icon in the left sidebar, it will open and you drop it there.</para></listitem> + <listitem><para>Sketch: free hand color sketching: draw a quick sketch and &digikam; will find corresponding images. Again a threshold can be set.</para></listitem> + <listitem><para>Duplicates: after &digikam; has scanned all collections you will find a list of duplicates here. It's up to you of course to decide what to do with them. From the menu <menuchoice><guimenu>Tools</guimenu><guimenuitem>Rebuild all fingerprints...</guimenuitem></menuchoice> you can initiate a total rebuild of the image signatures (may take hours if you have a large collection, an estimate is 2 hours for 10'000 images) or from the bottom you can just rescan, which is much faster. <guimenu>Find duplicates</guimenu> will do just that, but it will take a long time too as it has to compare every image with any other image. Fortunately, you can refine your search by albums and/or tags.</para></listitem> + </itemizedlist> + + <example> + <title>Fuzzy search for similar image</title> + <screenshot><mediaobject><imageobject><imagedata fileref="&path;fuzzysearchsimilar.png" format="PNG" /></imageobject></mediaobject></screenshot> + </example> + + <example> + <title>Find duplicates while restricting to an album</title> + <screenshot><mediaobject> + <imageobject><imagedata fileref="&path;duplicates_albumsfilter.png" format="PNG" /></imageobject> + </mediaobject></screenshot> + </example> + </sect2> + + <sect2> <title>Map Searches</title> + <para> + This tab provides an intuitive map search tool based on the marble widget. 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. 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 filtered and shown (provided your images have been geo-coded of course). + </para> + + <para> + In the box below you can enter a name for your geo filter. It will be added to the list view below for future reference, it acts as a live geo folder. + </para> + + <example> <title>The Map Searches tab</title> + + <screenshot><screeninfo>For higher resolution maps choose "More Info"</screeninfo><mediaobject><imageobject><imagedata fileref="&path;sidebargeolocation.png" format="PNG" /> </imageobject></mediaobject></screenshot> + + </example> + + </sect2> + +</sect1> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> diff --git a/digikam/sidebar.docbook b/digikam/using-sidebar.docbook similarity index 100% rename from digikam/sidebar.docbook rename to digikam/using-sidebar.docbook diff --git a/showfoto/index.docbook b/showfoto/index.docbook index 28d4caa..43dd281 100644 --- a/showfoto/index.docbook +++ b/showfoto/index.docbook @@ -9,7 +9,7 @@ <!-- relative path to snapshots for showfoto --> <!ENTITY path "../digikam/"> <!ENTITY doc-intro-fileformats SYSTEM "../digikam/intro-fileformats.docbook"> - <!ENTITY doc-sidebar SYSTEM "../digikam/sidebar.docbook"> + <!ENTITY doc-using-sidebar SYSTEM "../digikam/using-sidebar.docbook"> <!ENTITY doc-photo-editing SYSTEM "../digikam/photo-editing.docbook"> <!ENTITY doc-editor-color SYSTEM "../digikam/editor-color.docbook"> <!ENTITY doc-editor-enhance SYSTEM "../digikam/editor-enhance.docbook"> @@ -137,7 +137,7 @@ <chapter id="sidebar"> <title>The &showfoto; sidebar</title> - &doc-sidebar; + &doc-using-sidebar; </chapter>
