Warning, /documentation/digikam-doc/setup_application/templates_settings.rst is written in an unsupported language. File is not indexed.
0001 .. meta:: 0002 :description: digiKam Templates Settings 0003 :keywords: digiKam, documentation, user manual, photo management, open source, free, learn, easy, configure, setup, template, metadata, copyright, author, title, credit, source, IPTC, XMP 0004 0005 .. metadata-placeholder 0006 0007 :authors: - digiKam Team 0008 0009 :license: see Credits and License page for details (https://docs.digikam.org/en/credits_license.html) 0010 0011 .. _templates_settings: 0012 0013 Templates Settings 0014 ================== 0015 0016 .. contents:: 0017 0018 Overview 0019 -------- 0020 0021 The **Metadata Templates Manager** is meant to create and manage metadata templates which can be used in: 0022 0023 - The **Information** tab of the **Captions** view from the Right Sidebar. 0024 0025 - The **On the Fly Operations (JPEG only)** section of the **Settings** view from the Right Sidebar in the :menuselection:`Import --> Cameras` Window. 0026 0027 The goal of templates is to apply more than one metadata information at the same time to items. You can create many profiles 0028 corresponding to your workflow. In all cases, the information will be hosted in file to XMP metadata, and for some fields, in IPTC when possible. Remember that XMP is a replacement of IPTC as explained :ref:`in this section <iptc_tags>` of the manual. 0029 0030 The top part shows a list of the already existing templates. The first row shows the title of the template, the second row shows the name of the author(s) in the “Author Names” field of that very template. To the right you have three editing buttons, below an input field for the template title. To create a new template you type a title in the input field and click the **Add** button. The new template will appear in the list. To edit an existing template you select it in the list, then you edit its fields (see next paragraph) and finally you click the **Replace** button. You can as well type in a new title for the edited template and save the new version with the **Add** button. To delete a template, very obviously, you select it in the list and click the **Remove** button. 0031 0032 .. warning:: 0033 0034 Note that all the changes you made to the templates will only be stored in the template file if you exit the settings dialog with **OK** button. The **Add** and **Replace** buttons only change the template list in the memory. 0035 0036 .. tip:: 0037 0038 The template file can be found in :file:`~/.local/share/digikam/` for manual backup or for managing different template sets by means of the file system. 0039 0040 The rest of the window is divided into four tabs, grouping the metadata fields into **Rights**, **Location**, **Contact** and **Subjects**. 0041 0042 The Rights Information 0043 ---------------------- 0044 0045 .. figure:: images/setup_template_rights.webp 0046 :alt: 0047 :align: center 0048 0049 The digiKam Template Rights Configuration Page 0050 0051 The **Rights** tab contains the default identity and copyright data. This is an extract of the IPTC/XMP specifications for these fields: 0052 0053 - **Authors** (synonymous to *Creator and By-line*): This field should contain your name, or the name of the person who created the photograph. If it is not appropriate to add the name of the photographer (for example, if the identity of the photographer needs to be protected) the name of a company or organization can also be used. Once saved, this field should not be changed by anyone. This field does not support the use of commas or semi-colons as separator. With IPTC, this field is limited to 32 characters. 0054 0055 - **Author Positions** (synonymous with *By-line title*): This field should contain the job title of the photographer. Examples might include titles such as: Staff Photographer, Freelance Photographer, or Independent Commercial Photographer. Since this is a qualifier for the Author field, the Author field must also be filled out. With IPTC, this field is limited to 32 characters. 0056 0057 - **Credit** (synonymous with *Provider*): Use the credit field to identify who is providing the photograph. This does not necessarily have to be the author. If a photographer is working for a news agency such as Reuters or the Associated Press, these organizations could be listed here as they are "providing" the image for use by others. If the image is a stock photograph, then the group (agency) involved in supplying the image should be listed here. With IPTC, this field is limited to 32 characters. 0058 0059 - **Copyright**: The Copyright Notice should contain any necessary copyright notice for claiming the intellectual property, and should identify the current owner(s) of the copyright for the photograph. Usually, this would be the photographer, but if the image was done by an employee or as work-for-hire, then the agency or company should be listed. Use the form appropriate to your country. For the United States you would typically follow the form of (c) {date of first publication} name of copyright owner, as in *(c) 2005 John Doe.* Note, the word *copyright* or the abbreviation *copr* may be used in place of the (c) symbol. In some foreign countries only the copyright symbol is recognized and the abbreviation does not work. Furthermore the copyright symbol must be a full circle with a *c* inside; using something like (c) where the parentheses form a partial circle is not sufficient. For additional protection worldwide, use of the phrase, "all rights reserved" following the notice above is encouraged. In Europe you would use: Copyright {Year} {Copyright owner}, all rights reserved. In Japan, for maximum protection, the following three items should appear in the copyright field of the IPTC Core: (a) the word, Copyright; (b) year of the first publication; and (c) name of the author. You may also wish to include the phrase *all rights reserved*. With XMP, you can include more than one copyright string using different languages. With IPTC, this field is limited to 128 characters. 0060 0061 - **Right Usage Terms**: The Right Usage Terms field should be used to list instructions on how a resource can be legally used. With XMP, you can include more than one right usage terms string using different languages. This field does not exist with IPTC. 0062 0063 - **Source**: The Source field should be used to identify the original owner or copyright holder of the photograph. The value of this field should never be changed after the information is entered following the image's creation. While not yet enforced by the custom panels, you should consider this to be a "write-once" field. The source could be an individual, an agency, or a member of an agency. To aid in later searches, it is suggested to separate any slashes */* with a blank space. Use the form *photographer / agency* rather than *photographer/agency*. Source may also be different from Creator and from the names listed in the **Copyright Notice**. With IPTC, this field is limited to 32 characters. 0064 0065 - **Instructions**: The Instructions field should be used to list editorial instructions concerning the use of photograph. With IPTC, this field is limited to 256 characters. 0066 0067 The Location Information 0068 ------------------------ 0069 0070 .. figure:: images/setup_template_location.webp 0071 :alt: 0072 :align: center 0073 0074 The digiKam Template Location Configuration Page 0075 0076 The **Location** tab contains the default data about the place in the world describing the contents. This is an extract of the IPTC/XMP specifications for these fields: 0077 0078 - **City**: This field should contain the name of the city where the photograph was taken. With IPTC, this field is limited to 32 characters. 0079 0080 - **Sublocation**: This field should contain the sublocation of the city where the photograph was taken. With IPTC, this field is limited to 32 characters. 0081 0082 - **State/Province**: This field should contain the province or state where the photograph was taken. With IPTC, this field is limited to 32 characters. 0083 0084 - **Country**: Select here the country where the photograph was taken. With IPTC, this field is limited to 64 characters. 0085 0086 The Contact Information 0087 ----------------------- 0088 0089 .. figure:: images/setup_template_contact.webp 0090 :alt: 0091 :align: center 0092 0093 The digiKam Template Contact Configuration Page 0094 0095 The data in the Contact tab refer to the (lead) photographer under **Author Names** in the **Rights** tab. As these information do not exists in IPTC, see below an extract of the XMP specifications for these fields: 0096 0097 - **Address**: This field should contain the address where the lead author lives. 0098 0099 - **Postal Code**: This field should contain the postal code where the lead author lives. 0100 0101 - **City**: This field should contain the city name where the lead author lives. 0102 0103 - **Province**: This field should contain the province where the lead author lives. 0104 0105 - **Country**: This field should contain the country name where the lead author lives. 0106 0107 - **Phone**: This field should contain the phone number of the lead author. 0108 0109 - **Email**: This field should contain the email of the lead author. 0110 0111 - **URL**: This field should contain the web site URL of the lead author. 0112 0113 The Subjects Information 0114 ------------------------ 0115 0116 .. figure:: images/setup_template_subjects.webp 0117 :alt: 0118 :align: center 0119 0120 The digiKam Template Subjects Configuration Page 0121 0122 In the **Subjects** tab you can assign one or more Subject Codes according to the IPTC Photo Metadata Standard to the template. If the first option **Use standard reference code** is selected you can choose a code from the drop down field and the meaning of it will then appear in the fields of the **Use custom definition** section. If you don't know the code for the subject you want to assign this way is a bit tedious since there are 1400 subjects in the standard. A better way is to look for your subject in this URL. There you select **Subject Codes** and your language (English recommended) and click *Show*. In the diagram you scroll and make additional levels of an item visible by clicking on one of the fields. In the field right of the diagram you can find the code of the selected subject. 0123 0124 In general the IPTC Subject Codes are quite comprehensive but on the other hand a bit incomplete in some fields, e.g. under Lifestyle and Leisure/Games you find just Go, Chess, Bridge and Shogi. So you may want to add own subjects, even though they always remain private (or company) subjects. A way to do that in digiKam is to first check **Use standard reference code** and select *10001004* which brings you to *Lifestyle* and *Leisure/Games/shogi* - just to stay in our example. Then you check **Use custom definition** and change the last digit of **Reference** to 5 and the text in the **Detail**” field to - say *domino*. You save this custom definition to the template by clicking **Add** button at the right side of the subjects list. Then you type in a template title (if it's a new template) and save the template by clicking **Add** button at the right side of the templates list. Don't mix up these two.