summaryrefslogtreecommitdiffstats
path: root/doc/kipi-plugins/acquireimages.docbook
blob: 37516edc5e2e12ec994eb6bde15c3ea98936a973 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<chapter id="acquireimages">
<chapterinfo>

<title>Acquire Images</title>

<authorgroup>
    <author>
        <firstname>Gilles</firstname><surname>Caulier</surname>
        <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation>
    </author>
    
    <author>
        <firstname>Gerhard</firstname><surname>Kulzer</surname>
        <affiliation><address><email>gerhard at kulzer.net</email></address></affiliation>
    </author>    
</authorgroup>

<abstract>
<para>
The Kipi acquire images plugin provides tools to capture new images and save them to the collections.
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>Kipi</keyword>
</keywordset>
</chapterinfo>

<title>Introduction</title>

<para>
This plugin can be used to capture and add new images to the host application from external sources.
Actually, two actions can be used :
</para>

<itemizedlist>

<listitem>
    <para>
    <guilabel>Scan images</guilabel> : use the Kooka interface for scanning images from either a flat scanner supported by the Sane project or a another capture source like video streams (for this to work you must have installed Kooka and Sane).
    </para>
</listitem>

<listitem>
    <para>
    <guilabel>Screenshots</guilabel> : take screenshots.
    </para>
</listitem>

</itemizedlist>

<sect1 id="using-plugin-acquirescan">
<title>Scan Image Dialog</title>

<para>
When you open the <guilabel>Scan images</guilabel> menu a dialog comes up that lets you choose between the available acquisition sources on your computer. Choose the one you want to capture from. You can also set the default source for the next time.
</para>

<para>
When the Kooka dialog window comes up, make your choices of acquisition settings by altering the default values. Look at the preview and crop it before making the final decision. The estimated file size is indicated in the lower right corner. See the dedicated <ulink url="help:/kooka/index.html">Kooka manual</ulink> for more information.
</para>

<note><para>
Make sure that the dialog is fully visible since some settings might be hidden if the window is too narrow.
</para></note>

<para>
Press the scan button and wait until the scanning is finished and the <guilabel>Save Target Option</guilabel> dialog appears. Here you can alter the compression quality and the image file type (be aware that the BMP type is not compressed and creates large files). The second item in that dialog let you choose (or create) the folder the image will be saved to.
</para>

<figure>
    <title>The Save Target Dialog in Action</title>
    <graphic srccredit="The Save Target Dialog in Action" fileref="acquire-savetargetpreview.png"/>
</figure>

</sect1>

<sect1 id="using-plugin-acquirescreenshot">
<title>Screenshot Dialog</title>

<para>
The <guilabel>Screenshot</guilabel> acquisition mode you can choose from 1st menu item->Import->Screenshot...
A dialog window comes up providing you with various snapshot modes:
</para>

<itemizedlist>
<listitem>
   <para>
   Deselect the <guilabel>Grab the entire desktop</guilabel> item to shoot a single window under the mouse cursor.
   </para>
</listitem>
<listitem>
   <para>
   When the <guilabel>Hide all host application windows</guilabel> item is selected the calling host application will dissappear to give way to the other screens/windows. Otherwise you'll - after the delay - shoot the screen/window actually visible (if you've deselected <guilabel>Grab the entire desktop</guilabel> the window under the mouse pointer will be shot).
   </para>
</listitem>
</itemizedlist>

<para>
The delay control determines how long Screenshot will wait until the exposure is happening. If you need to navigate to some other screens set the delay high enough to give you the time for navigation.
</para>

<figure>
    <title>The Screenshot Dialog in Action</title>
    <graphic srccredit="The Screenshot Dialog in Action" fileref="acquire-screenshotpreview.png"/>
</figure>

<para>
Once the screenshot has been taken the <guilabel>Save Target Option</guilabel> dialog appears with the same options as described above.
</para>

</sect1>

</chapter>

<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
End:
-->