summaryrefslogtreecommitdiffstats
path: root/doc/external_tools.docbook
blob: 61722ccb00206eb53a242711deeab6d7679ba4eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<chapter id="external_tools">
<title>External tools</title>

<para>You can easily extend &kappname; by defining external tools. These tools
  are accessible from the contextual popup menu which appears when
  right-clicking on a thumbnail or in the image view. Look in the
  <menuchoice><guimenu>External Tools</guimenu></menuchoice> entry.</para>

<para>&kappname; comes with a few predefined external tools, but it's very
  easy to add more through the <guilabel>Configure External Tools</guilabel> dialog. You can open
  it from <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
      External Tools...</guimenuitem></menuchoice>.
</para>
  
<para>Here is how it looks:

<screenshot>
  <screeninfo>External tools dialog</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="external_tools_dialog.png" format="PNG" />
    </imageobject>
  </mediaobject>
</screenshot>
</para>

<para>In this example, I defined an external tool which will call Exiftran to
  regenerate the EXIF tags for JPEG images. Here is a more detailed description
  of its definition:</para>

<itemizedlist>
  <listitem>
    <para>The <guilabel>Name:</guilabel> field contains the description of your
      tool, has it will appear in the menu.
    </para>
  </listitem>
  <listitem>
    <para>The <guilabel>Command:</guilabel> field contains the command which
      will be run when this tool is invoked.
      Click on the little question mark on the right of the field to get a list
      of the keywords you can use in this field. These keywords will get
      expanded to the image files.
    </para>
  </listitem>
  <listitem>
    <para>
      The button on the right lets you associate an icon with your tool.
    </para>
  </listitem>
  <listitem>
    <para>
      The <guilabel>File Associations</guilabel> group indicates what type of
      files this tool can work with. Your tool will only appear in the 
      <menuchoice><guimenu>External Tools</guimenu></menuchoice> menu if the
      selected files are of the correct type. In my example, this tool is only
      valid with JPEG images, so I choose <guilabel>Custom:</guilabel>, then
      <guilabel>image/jpeg</guilabel> and <guilabel>image/pjpeg</guilabel>.
    </para>
  </listitem>
</itemizedlist>

<tip>
  <para>You can find other external tool examples from
    <ulink url="http://gwenview.sourceforge.net/tools">&kappname; web site</ulink>.
  </para>
</tip>

</chapter>