Warning, /documentation/digikam-doc/setup_application/metadata_settings.rst is written in an unsupported language. File is not indexed.

0001 .. meta::
0002    :description: digiKam Metadata Settings
0003    :keywords: digiKam, documentation, user manual, photo management, open source, free, learn, easy
0005 .. metadata-placeholder
0007    :authors: - digiKam Team
0009    :license: see Credits and License page for details (https://docs.digikam.org/en/credits_license.html)
0011 .. _metadata_settings:
0013 Metadata Settings
0014 =================
0016 .. contents::
0018 Image files can have some metadata embedded into the image file format. These metadata can be stored in a number of standard formats as JPEG, TIFF, PNG, JPEG2000, PGF, and RAW files. Metadata can be read and written in the `Exif <https://en.wikipedia.org/wiki/Exif>`_, `IPTC <https://en.wikipedia.org/wiki/IPTC_Information_Interchange_Model>`_, and `XMP <https://en.wikipedia.org/wiki/Extensible_Metadata_Platform>`_ formats if they are present in the file.
0020 .. _metadata_behavior:
0022 Behavior Settings
0023 -----------------
0025 The **Behavior** tab allows you to select what information digiKam will write to the metadata and control how digiKam will deal with this embedded information.
0027 .. figure:: images/setup_metadata_behavior.webp
0028     :alt:
0029     :align: center
0031     The digiKam Metadata General Behavior Settings Page
0033 .. note::
0035     If the **Lazy Synchronization** option is turned on, digiKam will only write metadata when user clicks on the **Apply Pending Changes To Metadata** icon in the status bar or when application is shutdown.
0037 .. _metadata_sidecars:
0039 Sidecars Settings
0040 -----------------
0042 The **Sidecars** tab allows user to control whether digiKam will read and write from/to XMP sidecars or not. You can also customize the granularity of write operations to XMP sidecar:
0044     - **Write to XMP sidecar only** will not touch the item metadata.
0045     - **Write to item and XMP Sidecar** will touch both item and sidecar at the same time.
0046     - **Write to XMP sidecar for read-only item only** will handle sidecar for non-writable items only, as video or RAW files for example.
0048 Filename for the sidecars set to :file:`filename.ext.xmp`. For example, :file:`image1.dng` will have a sidecar file named :file:`image1.dng.xmp`. With the option **Sidecar file names are compatible with commercial programs** digiKam will create the XMP sidecar files with a compatible file name (:file:`image1.xmp`) used by many commercial programs.
0050 .. figure:: images/setup_metadata_sidecars.webp
0051     :alt:
0052     :align: center
0054     The digiKam Metadata Sidecar Behavior Settings Page
0056 .. note::
0058     If the box **Read from sidecar files** is checked, digiKam will only read the sidecar while ignoring the embedded metadata.
0060 The option **Additional sidecar file extensions** allows to add extra filename extensions to be processed alongside regular items, independently of the XMP sidecars. These files will be hidden, but regarded as an extension of the main file. Just write :file:`thm pp3` to support :file:`filename.thm` (extra Jpeg thumbnail for RAW) and :file:`filename.pp3` (RAWTheraPee metadata) sidecars.
0062 .. _metadata_rotation:
0064 Rotation Settings
0065 -----------------
0067 .. figure:: images/setup_metadata_rotation.webp
0068     :alt:
0069     :align: center
0071     The digiKam Metadata Rotation Behavior Settings Page
0073 **Show images/thumbnails rotated according to orientation tag**: this will use any orientation information that your camera has included in the Exif information to automatically rotate your photographs so that they are the correct way up when displayed. It will not actually rotate the image file, only the display of the image on the screen. If you want to permanently rotate the image on file, you can click with the right mouse button on the thumbnail and select **Auto-rotate/flip according to Exif orientation**. The image will then be rotated on disk and the tag will be reset to "normal". If your camera routinely gets this orientation information wrong you might like to switch this feature off.
0075 **Set orientation tag to normal after rotate/flip**: the auto-rotate option automatically corrects the orientation of images taken with digital cameras that have an orientation sensor. The camera adds an orientation tag to the image's Exif metadata. digiKam can read this tag to adjust the image accordingly. If you manually rotate an image, these metadata will be incorrect. This option will set the orientation tag to *Normal* after an adjustment, assuming that you rotated it to the correct orientation. Switch this off if you don't want digiKam to make changes to the orientation tag, when you rotate or flip the image.
0077 .. _metadata_viewers:
0079 Views Settings
0080 --------------
0082 These settings allows to customize the metadata contents displayed in Exif, Makernotes, IPTC, XMP, and ExifTool viewers from the right sidebar. For more details see :ref:`this section <metadata_view>` from the manual.
0084 .. figure:: images/setup_metadata_views.webp
0085     :alt:
0086     :align: center
0088     The digiKam Settings For The Metadata Viewers
0090 .. _metadata_exiftool:
0092 ExifTool Settings
0093 -----------------
0095 ExifTool is a backend engine that digiKam can use to process operations on metadata, as view, read, and write. This panel only show the detection of the ExifTool binary program, and the supported formats with the respective read and write features.
0097 .. figure:: images/setup_metadata_exiftool.webp
0098     :alt:
0099     :align: center
0101     The digiKam Settings For The ExifTool Backend
0103 .. note::
0105     To replace the Exiv2 backend by ExifTool with all read and write metadata operations, see the :ref:`Metadata Behavior <metadata_behavior>` section of this manual.
0107 .. _metadata_baloo:
0109 Baloo Settings
0110 --------------
0112 **Baloo** is the file indexing and file search framework for **KDE Plasma** under Linux, with a focus on providing a very small memory footprint along with an extremely fast searching. Baloo is not an application, but a daemon to index files.
0114 .. figure:: images/setup_metadata_baloo.webp
0115     :alt:
0116     :align: center
0118     The digiKam Settings For The Baloo Metadata Search Engine
0120 This page allows to share metadata stored in digiKam database with the Baloo search engine. Extra applications as **KDE Dolphin** file manager can use the Baloo interface to provide file search results with items managed by the digiKam database.
0122 .. note::
0124     This page is only available under Linux, not Windows and macOS. The KDE Plasma **Files Indexer** feature must be enabled in the KDE Plasma control Panel.
0126 .. _metadata_advanced:
0128 Advanced Settings
0129 -----------------
0131 The **Advanced** tab allows you to manage namespaces used by digiKam to store and retrieve tags, ratings and comments. This functionality is often used by advanced users to synchronize metadata between different software. Please leave the default settings if you are not sure what to do here.
0133 The categories that you can manage with these advanced settings are:
0135     - **Caption**: all languages-alternative comments (supported by XMP only), else the simple comments values (Exif and IPTC).
0136     - **Color Label**: the color labels properties to apply on items in your workflow.
0137     - **Rating**: the stars properties to apply on items in your workflow.
0138     - **Tags**: the nested keywords hierarchy to apply on items in your workflow (supported by XMP only), else the simple flat list of keywords (Exif and IPTC).
0139     - **Title**: all languages-alternative titles (supported by XMP only), else the simple title values (Exif and IPTC).
0141 For each category you can set the read and write behavior in metadata. The default settings is to **Unify Read and Write** operations, but if you disable this option, you can customize **Read Options** and **Write Options** independently.
0143 .. figure:: images/setup_metadata_advanced.webp
0144     :alt:
0145     :align: center
0147     The digiKam Advanced Metadata Settings For the **Caption** Category
0149 On this example, the top **Caption** entry in the list is **Xmp.dc.description**, and it will be read by digiKam first. If it contains a valid value it will be used, otherwise the next entry named **Xmp.exif.UserComment**, etc. The entries list priority is high on the top and low on the bottom. The entry in the list are used only if item is enabled with the checkbox preceding the name.
0151 With the buttons on the right side, you can customize the list:
0153     - **Add**: allows to add a new entry in the tags list.
0154     - **Edit**: allows to modify the current select entry in the list.
0155     - **Delete**: allows to remove the current select entry in the list.
0156     - **Move up**: allows to move the current select entry in the list to a higher priority.
0157     - **Move Down**: allows to move the current selected entry in the list to a lower priority.
0158     - **Revert Changes**: allows to revert last changes done on the list.
0159     - **Save Profile**: allows to save the current configuration to a **Profile** file.
0160     - **Load Profile**: allows to load a saved configuration from a **Profile** file.
0161     - **Revert To Default**: allows to reset the current list to the default values.
0163 The **Profile** are simple ini-based text file used to store the advanced metadata settings to the disk. A profile can be loaded to overload the current configuration, depending of your workflow and the rules to apply for the best interoperability with other photo management programs. digiKam comes with a compatibility profile for **DarkTable**.
0165 .. important::
0167     We recommend to always put XMP tags to the top priority on this list, as XMP has better features than IPC and Exif.
0169 .. note::
0171     The **Tags** category provide an extra option named **Read All Metadata For Tags** to force operations on all the namespaces.