Print Creator ¶

Overview ¶

The Print Creator is a tool to print a group of images at the same time.

This tool allows multiple images to be combined onto single sheets of paper in standard photo sizes for printing. The combined images can also be automatically opened with the image editor Gimp for enhancement or for direct printing using the Gimp-Print tool. The combined images can also be output directly as PDF or image files.

Using the Wizard ¶

The first page allows you to select the items to print, either from Images currently selected in digiKam, or from Albums hosted in your collections. This page also checks for the availability of the Gimp binary program.

The next page allows to you customize the Printing Layout, the List of Items to assemble, and the Printing Target. Three print targets can be selected:

Post processing with Gimp, which must be installed on your system.

PDF file. Linux has a native export to PDF support, as does MacOS. A supplemental driver may need to be installed for Windows.

Image file.

A layout preview using selected items and the printing template is displayed on the right bottom side of the dialog.

The Print Wizard Page to Preview Selected Items on Template Layout¶

The next page allows you to customize the caption for each item. Options include:

No caption.

Image file name.

Exif date-time from file metadata.

Item comments from file metadata.

A Custom Format constructed by a list of fields assembled into a string.

The caption Text Color, Text Size, and Font Family can be customized if necessary.

The Print Wizard Page to Setup Captions¶

The next page allows you to crop and rotate each item to the desired area before printing. You can review all items one by one before starting the print processing.

The Print Wizard Page to Crop or Rotate Items¶

The last page lists all necessary tasks to render printing. If you select an image or a PDF file as target, a supplemental dialog will appear to customize the last options used by the print driver, and especially the place where the file is to be stored.

The Print Wizard Page to Render Printing¶

Creating a New Layout ¶

The Print Creator tool allows you to add new templates and manage new page layouts. This chapter explains how to create templates, test, and share files for an official integration into digiKam.

Getting Started ¶

A template is at least one file with an XML extension (for instance my-templates.xml). However, if you want it to be included in a future version of digiKam, you need another file that allows translations, e.g. a desktop file (see below).

When the Print Creator is running, it does the following:

Waits for you to choose the page size.

Looks for files describing the templates (XML files).

For each file, it looks for a template. If a template is found, it checks if the layout fits into the chosen page size, adds it, and loads a desktop file if one exists.

Displays templates with a preview icon in a list box.

The current official templates list can be seen in this git repository.

The XML File Structure ¶

An XML file is used to describe template layouts and how it fits into a real page layout. For now, you can add a fake page size to make your template available for all those pages in which your new template fits.

An example of a template (already included in default templates.xml) is a layout containing six passport size photos (35x40mm):

<templates>
    <paper name="passport-photos" width="90" height="130" unit="mm" >
        <template name="6_photos_3.5x4cm" dpi="0" autorotate="true">
            <photo x="10" y="3"  width="35" height="40" />
            <photo x="55" y="3"  width="35" height="40" />
            <photo x="10" y="45" width="35" height="40" />
            <photo x="55" y="45" width="35" height="40" />
            <photo x="10" y="87" width="35" height="40" />
            <photo x="55" y="87" width="35" height="40" />
        </template>
    </paper>
</templates>

The paper element represents the template layout, important attributes are width, height and unit:

width attribute: Represents the layout width.
height attribute: Represents the layout height.
unit attribute: Specifies the units for width and height. Valid values are inches or inch, mm, or cm.

The template element is the real template definition and contains the photo positions. Attributes are:

name attribute: is the template’s name, that is used to get translations at run-time set from a desktop file-name (6_photos_3.5x4cm.desktop in the example). If the desktop file-name does not exist, the name attribute is shown.
autorotate attribute: Sets if autorotation must be performed.
photo element: Sets photo position (x and y attributes) and size (width and height attributes).

Another example is presented below for A6 page size:

<paper name="A6" width="105" height="148" unit="mm" >
    <template name="1_photo_9x13cm" dpi="0" autorotate="true">
        <photo x="5" y="10" width="90" height="130" />
    </template>
    <template name="1_photo_10.5x14.8cm" dpi="0" autorotate="true">
        <photo x="0" y="0" width="105" height="148" />
    </template>
</paper>

The Desktop File ¶

The desktop file is needed for translations. If you produce templates strictly for your own use, you don’t really need it. It’s a standard ini-style file and looks like this (for instance 1_photo_9x13cm):

[Desktop Entry]
Type=Theme
Name=9x13 cm (1 photo)
Name[da]=9x13 cm (1 foto)
Name[de]=9x13 cm (1 Foto)
Name[en_GB]=9x13 cm (1 photo)
Name[et]=9x13 cm (1 foto)
Name[gl]=9x13 cm (1 foto)
Name[it]=9×13 cm (1 foto)
Name[nb]=9x13 cm (1 bilde)
Name[nl]=9x13 cm (1 foto)
Name[pt]=9x13 cm (1 fotografia)
Name[pt_BR]=9x13 cm (1 foto)
Name[sv]=9 x 13 cm (1 foto)
Name[x-test]=xx9x13 cm (1 photo)xx

The nice thing is that when your layouts get integrated into the Print Creator tool default templates, translation teams will translate the desktop file for you.

Creating a New Template from An Existing Template ¶

The easiest way to get started is to copy templates.xml file and modify it. The templates folder can be found usually under Linux at /usr/share/apps/digikam/templates/. Writing in this folder requires root access, so we will not create our template there. Instead do the following from a console:

Create a template folder in your home directory:

mkdir -p ~/.config/share/apps/digikam/templates/

Go to this directory:

cd ~/.config/share/apps/digikam/templates/

Copy the templates.xml to my_templates.xml for instance:

cp -r /usr/share/digikam/templates/templates.xml ~/.config/share/apps/digikam/templates/my_templates.xml

Remove all pages, add your pages, then create the desktop file accordingly.

You are done. You can now open digiKam and start the tool, your new templates should appear in the Layouts list from the Select page layout wizard dialog page.

Final Words ¶

This is the end of this chapter, now is the time for you to get creative and add new templates.

When you are done, do not hesitate to submit your work for official integration in digiKam, to see your new layout included in the official list. See the Contribute page from the digiKam project web-site for details.