Git commit d88e00c4f2eaa7f8c172174c7c463f85c733b2de by Gilles Caulier. Committed on 09/11/2016 at 19:26. Pushed by cgilles into branch 'master'.
apply patch #16 from Wolfgang M +1 -1 digikam/index.docbook D +0 -164 digikam/using-setup-album.docbook M +1 -1 digikam/using-setup-editor-iface.docbook A +206 -0 digikam/using-setup-views.docbook M +1 -1 digikam/using-setup.docbook http://commits.kde.org/digikam-doc/d88e00c4f2eaa7f8c172174c7c463f85c733b2de diff --git a/digikam/index.docbook b/digikam/index.docbook index 4ca6846..dcb0507 100644 --- a/digikam/index.docbook +++ b/digikam/index.docbook @@ -63,7 +63,7 @@ <!ENTITY doc-using-setup-intro SYSTEM "using-setup-intro.docbook"> <!ENTITY doc-using-setup-database SYSTEM "using-setup-database.docbook"> <!ENTITY doc-using-setup-collections SYSTEM "using-setup-collections.docbook"> - <!ENTITY doc-using-setup-album SYSTEM "using-setup-album.docbook"> + <!ENTITY doc-using-setup-views SYSTEM "using-setup-views.docbook"> <!ENTITY doc-using-setup-tooltip SYSTEM "using-setup-tooltip.docbook"> <!ENTITY doc-using-setup-metadata SYSTEM "using-setup-metadata.docbook"> diff --git a/digikam/using-setup-album.docbook b/digikam/using-setup-album.docbook deleted file mode 100644 index bc802e3..0000000 --- a/digikam/using-setup-album.docbook +++ /dev/null @@ -1,164 +0,0 @@ -<sect2 id="using-setup-album"> - <title>Album View Settings</title> - - <para> - In a number of tabs you can access the following groups of settings for the Album View: - </para> - - <sect3 id="using-setup-album-iconview"> - <title>Icon-View Settings</title> - - <para> - <inlinemediaobject><imageobject> - <imagedata fileref="&path;using-setup-album-iconview.png" format="PNG" /> - </imageobject></inlinemediaobject> - </para> - - <para> - The first series of settings on the left side of this view permit to customize the technical information to show below the album icon thumbnail, as the filename, the file size, the creation date, the image dimensions, and the aspect ratio. - </para> - - <para> - Note that the <guilabel>Show file modification date</guilabel> option shows the file modification date only if it's different from the creation date. This function is useful to identify quickly which items have been modified. - </para> - - <para> - On the right side, the options permit to customize other properties to show over and below the album icon thumbnail, as the file mime-type, the title, the caption, and the labels. - </para> - - <para> - The <guilabel>Show rotation overlay buttons</guilabel> option shows overlay buttons over the image thumbnail to be able to process left or right image rotation. - </para> - - <para> - The <guilabel>Show fullscreen overlay button</guilabel> option shows an overlay button over the image thumbnail to open it in fullscreen mode. - </para> - - <para> - The <guilabel>Show Geolocation Indicator</guilabel> option shows an icon over the image thumbnail if the item has geolocation information. - </para> - - <para> - An example of an album icon is given below: - </para> - - <para> - <inlinemediaobject><imageobject> - <imagedata fileref="&path;using-setup-album-iconview-item.png" format="PNG" /> - </imageobject></inlinemediaobject> - </para> - - <para> - On the bottom side of this settings panel, you can tune the behavior of icon-view item with user actions. - </para> - - <para> - The <guilabel>Thumbnail click action</guilabel> option permits to choose what should happen when you click on a thumbnail. Two settings are available: <guilabel>Show embedded view</guilabel> to display image in preview mode (F3) or <guilabel>Start image editor</guilabel> to open image in a separated window (F4). - </para> - - <para> - The <guilabel>Icon View font</guilabel> option permits to select the font used to display text in icon-views. - </para> - - <para> - The <guilabel>Use large thumbnail size for high screen resolution</guilabel> option renders the icon-view with large thumbnail size, for example in case of 4K monitor is used. By default this option is turned off and the maximum thumbnail size is limited to 256 x 256 pixels. When this option is enabled, thumbnail size can be extended to 512 x 512 pixels. This option will store more data in thumbnail database and will use more system memory. &digikam; needs to be restarted for the option to take effect and the <link linkend="tool-maintenance-features-thumbs">Rebuild Thumbnails</link> option from the Maintenance tool needs to be processed over all collections. - </para> - - </sect3> - - <sect3 id="using-setup-album-folderview"> - <title>Folder View Settings</title> - - <para> - These settings permit to customize the album tree-view of the Left Sidebar. The <guilabel>Tree View thumbnail size</guilabel> option configures the size in pixels of the Tree View thumbnails in &digikam;'s sidebars. Use large value for HiDPI screen. The <guilabel>Tree View font</guilabel> option sets the font used to display text in Tree Views. The option <guilabel>Show a count of items in Tree Views</guilabel> will display along the album name the number of icon-view items inside. - </para> - - <para> - <inlinemediaobject><imageobject> - <imagedata fileref="&path;using-setup-album-folderview.png" format="PNG" /> - </imageobject></inlinemediaobject> - </para> - - </sect3> - - <sect3 id="using-setup-album-preview"> - <title>Album View Preview Settings</title> - - <para> - Instead of opening the image in the editor, the &digikam; preview mode (<keycap>F3</keycap>) will embedded the large image view inside the main window. The goal to this view is to be faster than image editor, to be able to review the list of current images quickly. Depending of your computer features, you can customize the better way to load image to preview. Raw files can be processed differently, as this kind of container can require long computation. - </para> - - <para> - When option <guilabel>Embedded view zoomed to the original image size</guilabel> is not turned on, preview mode will not zoom the embedded view to the original image size. - </para> - - <para> - When option <guilabel>Show icons and text over preview</guilabel> is not turned on, preview mode will not show icons and text over the image preview. - </para> - - <para> - <inlinemediaobject><imageobject> - <imagedata fileref="&path;using-setup-album-preview.png" format="PNG" /> - </imageobject></inlinemediaobject> - </para> - - </sect3> - - <sect3 id="using-setup-album-fullscreen"> - <title>Album View Full-Screen Settings</title> - - <para> - TODO - </para> - - <para> - <inlinemediaobject><imageobject> - <imagedata fileref="&path;using-setup-album-fullscreen.png" format="PNG" /> - </imageobject></inlinemediaobject> - </para> - - </sect3> - - <sect3 id="using-setup-album-mimetype"> - <title>Album Mime Type Settings</title> - - <para> - &digikam; can understand lots of different image file types as well as some video and audio formats. To control which types of files &digikam; will try to display you can add or remove file extensions from these lists. Any files that are in the &digikam; Album folders that do not match these extensions will be ignored by &digikam;. - </para> - - <note><para> - The default settings can be easily restored by clicking on the update buttons to the right of each category. - </para></note> - - <para> - <inlinemediaobject><imageobject> - <imagedata fileref="&path;using-setup-album-mimetypes.png" format="PNG" /> - </imageobject></inlinemediaobject> - </para> - - </sect3> - - <sect3 id="using-setup-album-categories"> - <title>Album Categories Settings</title> - - <para> - TODO - </para> - - <para> - <inlinemediaobject><imageobject> - <imagedata fileref="&path;using-setup-album-categories.png" format="PNG" /> - </imageobject></inlinemediaobject> - </para> - - </sect3> - -</sect2> - -<!-- -Local Variables: -mode: sgml -sgml-omittag: nil -sgml-shorttag: t -End: ---> diff --git a/digikam/using-setup-editor-iface.docbook b/digikam/using-setup-editor-iface.docbook index 5ad7915..6c23c48 100644 --- a/digikam/using-setup-editor-iface.docbook +++ b/digikam/using-setup-editor-iface.docbook @@ -6,7 +6,7 @@ </para> <para> - Over and underexposed areas of an image can be indicated by dark and light marker colors that can be defined here. In the editor this viewing mode can be switched on and off with F10 and F11 respectively. The thresholds for over- and under-exposure can be set by the adjustment bars "... percents". Check <guilabel>Indicate exposure as pure color</guilabel> if you want only pure black (RGB 0,0,0) indicated as under-exposure and only pure white (RGB 8bit 255,255,255 respectively RGB 16bit 65535, 65535, 65535) indicated as over-exposure. + Over and underexposed areas of an image can be indicated by dark and light marker colors that can be defined here. In the editor this viewing mode can be switched on and off with F10 and F11 respectively. </para> <para> diff --git a/digikam/using-setup-views.docbook b/digikam/using-setup-views.docbook new file mode 100644 index 0000000..8342ce6 --- /dev/null +++ b/digikam/using-setup-views.docbook @@ -0,0 +1,206 @@ +<sect2 id="using-setup-views"> + <title>Views Settings</title> + + <para> + In a number of tabs you can access the following groups of settings for the Views of &digikam; (Albums, Tags, Labels, ...): + </para> + + <sect3 id="using-setup-views-icons"> + <title>Icon Settings</title> + + <para> + <inlinemediaobject><imageobject> + <imagedata fileref="&path;using-setup-album-iconview.png" format="PNG" /> + </imageobject></inlinemediaobject> + </para> + + <para> + The first series of settings on the left side of this view permit to customize the technical information shown below the icon thumbnail, as the filename, the file size, the creation date, the image dimensions, and the aspect ratio. + </para> + + <para> + Note that the <guilabel>Show file modification date</guilabel> option shows the file modification date only if it's different from the creation date. This function is useful to identify quickly which items have been modified. + </para> + + <para> + On the right side, the options permit to customize other properties to show over and below the icon thumbnail, as the file mime-type, the title, the caption, and the labels. + </para> + + <para> + The <guilabel>Show rotation overlay buttons</guilabel> option shows overlay buttons over the image thumbnail to be able to process left or right image rotation. + </para> + + <para> + The <guilabel>Show fullscreen overlay button</guilabel> option shows an overlay button over the image thumbnail to open it in fullscreen mode. + </para> + + <para> + The <guilabel>Show Geolocation Indicator</guilabel> option shows an icon over the image thumbnail if the item has geolocation information. + </para> + + <para> + An example of an icon is given below: + </para> + + <para> + <inlinemediaobject><imageobject> + <imagedata fileref="&path;using-setup-album-iconview-item.png" format="PNG" /> + </imageobject></inlinemediaobject> + </para> + + <para> + On the bottom side of this settings panel, you can tune the behavior of the icon with user actions. + </para> + + <para> + The <guilabel>Thumbnail click action</guilabel> option permits to choose what should happen when you click on a thumbnail. Two settings are available: <guilabel>Show preview</guilabel> to display the image in preview mode (F3) or <guilabel>Start image editor</guilabel> to open the image in a separate editor window (F4). + </para> + + <para> + The <guilabel>Icon View font</guilabel> option permits to select the font used to display text in icons. + </para> + + <para> + The <guilabel>Use large thumbnail size for high screen resolution</guilabel> option renders the icon-view with large thumbnail size, for example in case of 4K monitor is used. By default this option is turned off and the maximum thumbnail size is limited to 256 x 256 pixels. When this option is enabled, the thumbnail size can be extended to 512 x 512 pixels. This option will store more data in the thumbnail database and will use more system memory. &digikam; needs to be restarted for the option to take effect and the <link linkend="tool-maintenance-features-thumbs">Rebuild Thumbnails</link> option from the Maintenance tool needs to be processed over all collections. + </para> + + </sect3> + + <sect3 id="using-setup-views-treeview"> + <title>Tree View Settings</title> + + <para> + These settings permit to customize the tree views of the Left and Right Sidebar. The <guilabel>Tree View icon size</guilabel> option configures the size in pixels of the Tree View icons in &digikam;'s sidebars. Use large value for HiDPI screen. The <guilabel>Tree View font</guilabel> option sets the font used to display text in Tree Views. The option <guilabel>Show a count of items in Tree Views</guilabel> will display the number of items inside a folder or assigned to a tag behind the album/tag name. The count shown depends on whether the subfolders/-tags are folded out or not and on the + <menuchoice> + <guimenu>View</guimenu><guimenuitem>Include Album Sub-Tree</guimenuitem> + </menuchoice> + and the + <menuchoice> + <guimenu>View</guimenu><guimenuitem>Include Tag Sub-Tree</guimenuitem> + </menuchoice> + settings in the main menu. + </para> + + <para> + <inlinemediaobject><imageobject> + <imagedata fileref="&path;using-setup-album-folderview.png" format="PNG" /> + </imageobject></inlinemediaobject> + </para> + + </sect3> + + <sect3 id="using-setup-views-preview"> + <title>Album View Preview Settings</title> + + <para> + Instead of opening the image in the editor, the &digikam; preview mode (<keycap>F3</keycap>) will show the image within the main window in the Image Area. The advantage of the preview is that it is faster than opening the image editor and that the icons of the other images remain visible so that you are able to review the list of current images quickly. Depending on your computer features, you can customize the best way to load images into the preview. Raw files can be processed differently, as this kind of container can require long computation. + </para> + + <para> + The first option will try to open a small version of the photograph embedded in the file. It will be found in all RAW files and can be found in all files that support IPTC or XMP like PNG, JPEG, TIFF, JPEG2000, PGF. If an embedded preview cannot be found some image decoders (JPEG, JPEG2000, and PGF, WebP) are able to create a reduced version of the photograph by themselves which is still faster than using the whole image. Depending on the size of the image, the size of the embedded preview and the size available for the preview on your screen the effect of this option can be visible or not. + </para> + + <para> + The second option will always use the full image data for the preview regardless of whether there is a reduced version embedded in the file or not. This can result in a better quality of the preview but is usually slower. + </para> + + <para> + Only if the second option is checked the drop down field to the right of "Raw images:" is accessible. It offers three options: With <guilabel>Automatic</guilabel> selected the Libraw decoder will decode the RAW data automatically without any adjustments from the user. This may lead to weird results sometimes. The algorithm also takes screen resolution and CPU speed into account to achieve an optimum regarding speed and rendering quality. <guilabel>Embedded preview</guilabel> will try to use the (JPEG) preview embedded in RAW files. <guilabel>Raw data in half size</guilabel> will show unprocessed RAW data in half size. + </para> + + <para> + The option <guilabel>Embedded view zoomed to the original image size</guilabel> is related to the first option. It will zoom the embedded view to the original image size which can lead to a reduced quality of the preview depending on the parameters mentioned above in the description of the first option. + </para> + + <para> + The option <guilabel>Show icons and text over preview</guilabel> will show icons for rotation, face tags, full screen mode etc. in the top left corner of the image preview. TODO text? + </para> + + <para> + <inlinemediaobject><imageobject> + <imagedata fileref="&path;using-setup-album-preview.png" format="PNG" /> + </imageobject></inlinemediaobject> + </para> + + </sect3> + + <sect3 id="using-setup-views-fullscreen"> + <title>Full-Screen Settings</title> + + <para> + The options in this tab apply only to the Full Screen Mode you can access via the <guilabel>Full Screen</guilabel> button on the Toolbar or via + <menuchoice> + <shortcut><keycombo action="press"><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>F</keycap></keycombo></shortcut> + <guimenu>View</guimenu><guimenuitem>Full Screen Mode</guimenuitem> + </menuchoice> + in the main menu or the context menu. It does <emphasis>not</emphasis> apply to the Full Screen Mode you access by clicking the <quote>Show Fullscreen</quote> icon + <inlinemediaobject> + <imageobject><imagedata fileref="&path;using-mainwindow-icon-fullscreen.png" format="PNG"/> </imageobject> + </inlinemediaobject> + either on a thumbnail or on the preview. + </para> + + <para> + <inlinemediaobject><imageobject> + <imagedata fileref="&path;using-setup-album-fullscreen.png" format="PNG" /> + </imageobject></inlinemediaobject> + </para> + + <para> + If all three options are activated the only way to leave the Full Screen Mode is the context menu or <keycombo action="press"><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>F</keycap></keycombo>. You can work on the images also by choosing functions from the context menu of an icon or the preview. + </para> + + + </sect3> + + <sect3 id="using-setup-views-mimetype"> + <title>Mime Types Settings</title> + + <para> + &digikam; can understand lots of different image file types as well as some video and audio formats. To control which types of files &digikam; will try to display you can add or remove file extensions from these lists. Any files that are in the &digikam; Album folders that do not match these extensions will be ignored by &digikam;. + </para> + + <note><para> + The default settings can be easily restored by clicking on the update buttons to the right of each category. + </para></note> + + <para> + <inlinemediaobject><imageobject> + <imagedata fileref="&path;using-setup-album-mimetypes.png" format="PNG" /> + </imageobject></inlinemediaobject> + </para> + + <para> + For more informations, for example how to remove file types from the list, use the context help with the question mark from the window header. + </para> + + </sect3> + + <sect3 id="using-setup-views-categories"> + <title>Album Categories Settings</title> + + <para> + In the Album View you can choose from + <menuchoice> + <guimenu>View</guimenu><guisubmenu>Sort Albums</guisubmenu><guimenuitem>By Category</guimenuitem> + </menuchoice> + to have the Albums in the Album Tree of the Left Sidebar sorted by category. Here you can manage these categories, which is add or remove categories or rename them by using the <guilabel>Replace</guilabel> button. To assign categories to an Album you got to use the <link linkend="albumpropsedit.anchor">Album Properties</link> dialog. + </para> + + <para> + <inlinemediaobject><imageobject> + <imagedata fileref="&path;using-setup-album-categories.png" format="PNG" /> + </imageobject></inlinemediaobject> + </para> + + </sect3> + +</sect2> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> diff --git a/digikam/using-setup.docbook b/digikam/using-setup.docbook index 3c96f66..6d078ce 100644 --- a/digikam/using-setup.docbook +++ b/digikam/using-setup.docbook @@ -4,7 +4,7 @@ &doc-using-setup-intro; &doc-using-setup-database; &doc-using-setup-collections; - &doc-using-setup-album; + &doc-using-setup-views; &doc-using-setup-tooltip; &doc-using-setup-metadata; &doc-using-setup-templates;
