← Back to branch summary

~ubuntu-branches/ubuntu/edgy/gwenview/edgy

« back to all changes in this revision

Viewing changes to doc/gwenview/external_tools.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2005-12-06 17:59:19 UTC
  • mfrom: (1.1.3 upstream) (2.1.1 sarge)
  • Revision ID: james.westby@ubuntu.com-20051206175919-8yv9nfmw0pws6p52
Tags: 1.3.1-0ubuntu1
* Sync with Debian
* Edit kde.mk for .pot generation

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/gwenview/external_tools.docbook
1
 
<chapter id="external_tools">
2
 
<title>External tools</title>
3
 
 
4
 
<para>You can easily extend &kappname; by defining external tools. These tools
5
 
  are accessible from the contextual popup menu which appears when
6
 
  right-clicking on a thumbnail or in the image view. Look in the
7
 
  <menuchoice><guimenu>External Tools</guimenu></menuchoice> entry.</para>
8
 
 
9
 
<para>&kappname; comes with a few predefined external tools, but it's very
10
 
  easy to add more through the <guilabel>Configure External Tools</guilabel> dialog. You can open
11
 
  it from <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
12
 
      External Tools...</guimenuitem></menuchoice>.
13
 
</para>
14
 
  
15
 
<para>Here is how it looks:
16
 
 
17
 
<screenshot>
18
 
  <screeninfo>External tools dialog</screeninfo>
19
 
  <mediaobject>
20
 
    <imageobject>
21
 
      <imagedata fileref="external_tools_dialog.png" format="PNG" />
22
 
    </imageobject>
23
 
  </mediaobject>
24
 
</screenshot>
25
 
</para>
26
 
 
27
 
<para>In this example, I defined an external tool which will call Exiftran to
28
 
  regenerate the EXIF tags for JPEG images. Here is a more detailed description
29
 
  of its definition:</para>
30
 
 
31
 
<itemizedlist>
32
 
  <listitem>
33
 
    <para>The <guilabel>Name:</guilabel> field contains the description of your
34
 
      tool, has it will appear in the menu.
35
 
    </para>
36
 
  </listitem>
37
 
  <listitem>
38
 
    <para>The <guilabel>Command:</guilabel> field contains the command which
39
 
      will be run when this tool is invoked.
40
 
      Click on the little question mark on the right of the field to get a list
41
 
      of the keywords you can use in this field. These keywords will get
42
 
      expanded to the image files.
43
 
    </para>
44
 
  </listitem>
45
 
  <listitem>
46
 
    <para>
47
 
      The button on the right lets you associate an icon with your tool.
48
 
    </para>
49
 
  </listitem>
50
 
  <listitem>
51
 
    <para>
52
 
      The <guilabel>File Associations</guilabel> group indicates what type of
53
 
      files this tool can work with. Your tool will only appear in the 
54
 
      <menuchoice><guimenu>External Tools</guimenu></menuchoice> menu if the
55
 
      selected files are of the correct type. In my example, this tool is only
56
 
      valid with JPEG images, so I choose <guilabel>Custom:</guilabel>, then
57
 
      <guilabel>image/jpeg</guilabel> and <guilabel>image/pjpeg</guilabel>.
58
 
    </para>
59
 
  </listitem>
60
 
</itemizedlist>
61
 
 
62
 
<tip>
63
 
  <para>You can find other external tool examples from
64
 
    <ulink url="http://gwenview.sourceforge.net/tools">&kappname; web site</ulink>.
65
 
  </para>
66
 
</tip>
67
 
 
68
 
</chapter>
69
 
<!-- vim: set ft=xml: -->