diff options
| author | tpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2010-01-19 18:22:05 +0000 |
|---|---|---|
| committer | tpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2010-01-19 18:22:05 +0000 |
| commit | 57e10fedbcb8c3e8c6590ff0935dbf017ce5587f (patch) | |
| tree | 3000a7649ca4e40e43f9e7feed963236a0b0f56b /doc/kipi-plugins | |
| download | kipi-plugins-57e10fedbcb8c3e8c6590ff0935dbf017ce5587f.tar.gz kipi-plugins-57e10fedbcb8c3e8c6590ff0935dbf017ce5587f.zip | |
Import abandoned KDE3 version of kipi plugins
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/libraries/kipi-plugins@1077221 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'doc/kipi-plugins')
53 files changed, 2353 insertions, 0 deletions
diff --git a/doc/kipi-plugins/Makefile.am b/doc/kipi-plugins/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kipi-plugins/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kipi-plugins/README b/doc/kipi-plugins/README new file mode 100644 index 0000000..9ca5c16 --- /dev/null +++ b/doc/kipi-plugins/README @@ -0,0 +1,41 @@ +Handbook README: +---------------- + +>>> How to Make Screenshot for Manual with Alpha Blending 3D Border <<< + +- Never use advanced color theme to make screenshots. Always use KDE default color. + +- Use KSnapshot for take a shot. Use region selection option for take only + important area. Remove buttons and dialog hearder for limit image file size. + _ALWAYS use PNG file format to save image. + +- Open your screenshot in Gimp 2.0 and make operations below: + + * Script-Fu/Decor/Add Border with this options : + -> Border X Size = 1 + -> Border Y Size = 1 + -> Border Color = black (R:0, G:0, B:0) + -> Delata Value on Color = 1 + * Image/Flatten Image + * Script-Fu/Shadow/Drop-Shadow with this options : + -> Offset X = 5 + -> Offset Y = 5 + -> Blur Radius = 10 + -> Color = black (R:0, G:0, B:0) + -> Opacity = 80 + -> Allow Resizing = On + * Save target image in PNG with max compression (Compression Level = 9) + +Note : A gimp2.2 script from Gerhard Kulzer can be use to add Alpha Blending 3D Border around screenshots. + Always use default settings. Script can be downloaded from this url: + +http://digikam3rdparty.free.fr/Tools/kde-screenshot-dropshadow.scm + + !----------Important-------------! +Since the documentation is very good it is also very demanding in terms of volume, 99% whereof are screenshots. In order to limit the byte count to the minimum the following command chain shall be used to reduce the png file size. A factor of 2-4 can be gained. From within the folder where the png reside issue this command (requires pngnq and optipng to be installed on the system): + +pngnq -s 1 ./*.png && optipng *-nq8.png && rename -f s/-nq8\.png/.png/ *-nq8.png + + +Gilles Caulier <caulier dot gilles at gmail dot com> +Gerhard Kulzer <gerhard at kulzer dot net>
\ No newline at end of file diff --git a/doc/kipi-plugins/acquire-savetargetpreview.png b/doc/kipi-plugins/acquire-savetargetpreview.png Binary files differnew file mode 100644 index 0000000..b779680 --- /dev/null +++ b/doc/kipi-plugins/acquire-savetargetpreview.png diff --git a/doc/kipi-plugins/acquire-screenshotpreview.png b/doc/kipi-plugins/acquire-screenshotpreview.png Binary files differnew file mode 100644 index 0000000..429beee --- /dev/null +++ b/doc/kipi-plugins/acquire-screenshotpreview.png diff --git a/doc/kipi-plugins/acquireimages.docbook b/doc/kipi-plugins/acquireimages.docbook new file mode 100644 index 0000000..37516ed --- /dev/null +++ b/doc/kipi-plugins/acquireimages.docbook @@ -0,0 +1,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: +--> + diff --git a/doc/kipi-plugins/calendar.docbook b/doc/kipi-plugins/calendar.docbook new file mode 100644 index 0000000..b669de1 --- /dev/null +++ b/doc/kipi-plugins/calendar.docbook @@ -0,0 +1,46 @@ +<chapter id="calendar"> +<chapterinfo> + +<title>Calendar</title> + +<authorgroup> +<author> +<firstname>Gilles</firstname> +<surname>Caulier</surname> +<affiliation> +<address><email>caulier dot gilles at free.fr</email></address> +</affiliation> +</author> +</authorgroup> + +<abstract> +<para> +The Kipi Calendar plugin is a tool to create calendar from image collections. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> + +</chapterinfo> + +<title>Introduction</title> + +<para> +The Kipi plugin <quote>Calendar</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact Kipi team mailing list <email>kde-imaging@kde.org</email>. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/cdarchiving.docbook b/doc/kipi-plugins/cdarchiving.docbook new file mode 100644 index 0000000..7baf5f4 --- /dev/null +++ b/doc/kipi-plugins/cdarchiving.docbook @@ -0,0 +1,51 @@ +<chapter id="cdarchiving"> +<chapterinfo> + +<title>CD Archiving</title> + +<authorgroup> +<author> +<firstname>Gilles</firstname> +<surname>Caulier</surname> +<affiliation> +<address><email>caulier dot gilles at free.fr</email></address> +</affiliation> +</author> +</authorgroup> + +<abstract> +<para> +The Kipi CD archiving plugin is a tool to backup image collections. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +This plugin archive the Albums in a CD/DVD media using K3b program. +You can select easily the Albums to archive in the media. An HTML interface can be built +for a confortable data navigation. For the Win32 platform, an 'AutoRun' option is available. +</para> +<para> +The K3b program is available at this +<ulink url="http://www.k3b.org/"> +<citetitle>url.</citetitle> +</ulink> +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/colorimages.docbook b/doc/kipi-plugins/colorimages.docbook new file mode 100644 index 0000000..4f825bf --- /dev/null +++ b/doc/kipi-plugins/colorimages.docbook @@ -0,0 +1,65 @@ +<chapter id="colorimages"> +<chapterinfo> + +<title>Color Images</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Color Images plugin is a tool to change or improve the images' color rendering. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> + +This plugin can be used for batch colors enhancement of images in an Album. + It uses the "convert" program from the "ImageMagick" package. An plugin effect + preview (partial or full) is available. + 10 color filter types are availables: + +</para> + +<itemizedlist> +<listitem><para><emphasis>Decrease contrast</emphasis> : reduces the image contrast.</para></listitem> +<listitem><para><emphasis>Depth</emphasis> : changes the color depth of the image.</para></listitem> +<listitem><para><emphasis>Equalize</emphasis> : performs histogram equalization to the image.</para></listitem> +<listitem><para><emphasis>Fuzz</emphasis> : merges colors within a distance are considered equal.</para></listitem> +<listitem><para><emphasis>Gray scales</emphasis> : converts colors images to gray scales image.</para></listitem> +<listitem><para><emphasis>Increase contrast</emphasis> : enhances the image contrast.</para></listitem> +<listitem><para><emphasis>Monochrome</emphasis> : transforms the image to black and white.</para></listitem> +<listitem><para><emphasis>Negate</emphasis> : replaces every pixel with its complementary color.</para></listitem> +<listitem><para><emphasis>Normalize</emphasis> : transforms image to span the full range of color values.</para></listitem> +<listitem><para><emphasis>Segment</emphasis> : segments an image by analyzing the histograms of the color components.</para></listitem> +<listitem><para><emphasis>Trim</emphasis> : trims an image (fuzz reverse technic).</para></listitem> +</itemizedlist> + +<para> +You can see some samples built with this plugin at this link +<ulink url="http://digikamplugins.free.fr/ImagesGallerySamples/MultipleAlbums/ColorImages/index.html"> +<citetitle>url.</citetitle> +</ulink></para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/convertimages.docbook b/doc/kipi-plugins/convertimages.docbook new file mode 100644 index 0000000..287b3e5 --- /dev/null +++ b/doc/kipi-plugins/convertimages.docbook @@ -0,0 +1,52 @@ +<chapter id="convertimages"> +<chapterinfo> + +<title>Convert Images</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Convert Images plugin is a tool to convert an image file format to another. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> + +This plugin can be used for batch convertion of images in an Album. +It uses the "convert" program from "ImageMagick" package. The supported image file formats are the following: +</para> + +<itemizedlist> +<listitem><para>JPEG.</para></listitem> +<listitem><para>PNG.</para></listitem> +<listitem><para>PPM.</para></listitem> +<listitem><para>BMP.</para></listitem> +<listitem><para>TIFF.</para></listitem> +<listitem><para>TGA.</para></listitem> +<listitem><para>EPS.</para></listitem> +</itemizedlist> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/effectimages.docbook b/doc/kipi-plugins/effectimages.docbook new file mode 100644 index 0000000..b44cb6a --- /dev/null +++ b/doc/kipi-plugins/effectimages.docbook @@ -0,0 +1,65 @@ +<chapter id="effectimages"> +<chapterinfo> + +<title>Effect Images</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Effect Images plugin is a tool for to add a special effect to the images. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> + +This plugin can be used for batch FX transforming images in an Album. + It use "convert" program from "ImageMagick" package. An image effect + preview (partial or full) is also available. + 11 FX filters types have been implemented: +</para> + +<itemizedlist> +<listitem><para><emphasis>Adaptative threshold</emphasis> : perform local adaptive thresholding.</para></listitem> +<listitem><para><emphasis>Charcoal</emphasis> : simulate a charcoal drawing.</para></listitem> +<listitem><para><emphasis>Detect edges</emphasis> : detect edges within an image.</para></listitem> +<listitem><para><emphasis>Emboss</emphasis> : returns a grayscale image with a three-dimensional effect.</para></listitem> +<listitem><para><emphasis>Implode</emphasis> : implode image pixels about the center.</para></listitem> +<listitem><para><emphasis>Paint</emphasis> : applies a special effect filter that simulates an oil painting.</para></listitem> +<listitem><para><emphasis>Shade light</emphasis> : shines a distant light on an image to create a three-dimensional effect.</para></listitem> +<listitem><para><emphasis>Solarize</emphasis> : negate all pixels above the threshold level.</para></listitem> +<listitem><para><emphasis>Spread</emphasis> : this is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.</para></listitem> +<listitem><para><emphasis>Swirl</emphasis> : swirls the pixels about the center of the image.</para></listitem> +<listitem><para><emphasis>Wave</emphasis> : creates a ripple effect in the image by shifting the pixels vertically along a sine wave.</para></listitem> +</itemizedlist> + +<para> +You can see some samples building with this plugin at this +<ulink url="http://digikamplugins.free.fr/ImagesGallerySamples/MultipleAlbums/EffectImages/index.html"> +<citetitle>url.</citetitle> +</ulink> +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/filterimages.docbook b/doc/kipi-plugins/filterimages.docbook new file mode 100644 index 0000000..c5d4c9d --- /dev/null +++ b/doc/kipi-plugins/filterimages.docbook @@ -0,0 +1,62 @@ +<chapter id="filterimages"> +<chapterinfo> + +<title>Filter Images</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Filter Images plugin is a tool for to apply a digital filter to the images. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> + +This plugin can be used for batch filter images in an Album. + It use "convert" program from "ImageMagick" package. An image effect + preview (partial or full) is available. + 9 filters types have been implemented: +</para> + +<itemizedlist> +<listitem><para><emphasis>Add noise</emphasis> : add noise in an image.</para></listitem> +<listitem><para><emphasis>Antialias</emphasis> : remove pixel aliasing.</para></listitem> +<listitem><para><emphasis>Blur</emphasis> : blur the image with a Gaussian operator.</para></listitem> +<listitem><para><emphasis>Despeckle</emphasis> : reduce the speckles within an image.</para></listitem> +<listitem><para><emphasis>Enhance</emphasis> : apply a digital filter to enhance a noisy image.</para></listitem> +<listitem><para><emphasis>Median</emphasis> : apply a median filter to an image.</para></listitem> +<listitem><para><emphasis>Noise reduction</emphasis> : reduce noise in an image.</para></listitem> +<listitem><para><emphasis>Sharpen</emphasis> : sharpen the image with a Gaussian operator.</para></listitem> +<listitem><para><emphasis>Unsharp</emphasis> : sharpen the image with an unsharp mask operator.</para></listitem> +</itemizedlist> + +<para> +You can see some samples building with this plugin at this +<ulink url="http://digikamplugins.free.fr/ImagesGallerySamples/MultipleAlbums/FilterImages/index.html"> +<citetitle>url.</citetitle> +</ulink></para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/findduplicateimages.docbook b/doc/kipi-plugins/findduplicateimages.docbook new file mode 100644 index 0000000..6b6b43b --- /dev/null +++ b/doc/kipi-plugins/findduplicateimages.docbook @@ -0,0 +1,42 @@ +<chapter id="findduplicateimages"> +<chapterinfo> + +<title>Find Duplicate Images</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Find Duplicate Images plugin is a tool for find duplicate photograph on your image collections. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The Kipi plugin <quote>Find Duplicate Images</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact Kipi team mailing list <email>kde-imaging@kde.org</email>. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/flickrexport.docbook b/doc/kipi-plugins/flickrexport.docbook new file mode 100644 index 0000000..b3e0853 --- /dev/null +++ b/doc/kipi-plugins/flickrexport.docbook @@ -0,0 +1,140 @@ +<chapter id="flickrexport"> +<chapterinfo> + +<title>Flickr Export</title> + +<authorgroup> + <author> + <firstname>Vardhman</firstname><surname>Jain</surname> + <affiliation><address><email>vardhman at students dot iiit dot net</email></address></affiliation> + </author> + + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> + <para> + FlickrExport Kipi-plugin allows the user to upload photos to the <ulink url="http://www.flickr.com">Flickr</ulink> web service. + </para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + + <para> + Flickr is an online photo management application on internet. Flickr is a way to get your photos to the people who matter to you. With Flickr you can show off your favorite photos to the world, blog the photos you take with a cameraphone, and securely and privately show photos to your friends and family around the world. + </para> + + <para> + The FlickrExport plugin can be used to upload image collection from your host to the remote flickr server using internet. + </para> + +<sect1 id="using-plugin-flickrexport"> + <title>Plugin intialization on First access</title> + + <para> + On accessing the plugin for the first time the user is taken through the process of obtaining a token. Which is used for authentication purposes. + Following dialog will popup and a browser window will be launched where user will signup in to <ulink url="http://www.flickr.com">Flickr</ulink>. + </para> + + <figure> + <title>The First Sign Up Dialog Preview</title> + <graphic srccredit="The First Sign Up Dialog Preview" fileref="flickrexportsignup.png"/> + </figure> + + <para> + On successful signup FlickrUploadr will be allowed to send photos to flickr website. The user will be presented with the following page on + successful signup. + </para> + + <figure> + <title>The Successfull Signup Flickr page</title> + <graphic srccredit="The Successfull Signup Flickr page" fileref="flickrexportauthenticated.png"/> + </figure> + + <para> + Simply close the browser windows and return to the host application Dialog. On clicking <guilabel>Yes</guilabel>, user will see the interface to upload photos to Flickr. Described in the next section. + </para> + +</sect1> + +<sect1 id="uploading-using-plugin-flickrexport"> +<title>The Regular Plugin Usage</title> + + + <para> + When the flickrexport plugin is invoked for second time or later the user is greeted with the following dialog, which shows the current access permissions flickrexport plugin has. The uploading process requires "write" permissions. The plugin doesn't allow any other permission as of now. User is asked if he wants to proceed with his current permissions. + </para> + <figure> + <title>Current Permissions Dialog preview</title> + <graphic srccredit="The " fileref="flickrexportcontinue.png"/> + </figure> + + <para> + On clicking <guilabel>Yes</guilabel>, user will see the interface to upload photos to Flickr. + </para> + <para> + On clicking <guilabel>No</guilabel>, the authentication process is repeated. + </para> + + <para> + This Main upload dialog is shown belows. + </para> + + + <figure> + <title>The Main Uploading Dialog Preview</title> + <graphic srccredit="The Main Uploading Dialog Preview" fileref="flickrexportuploaddialog.png"/> + </figure> + + <para> + The <guilabel>Add Photos</guilabel> button should be clicked once user has set in the other options in the dialog. On clicking this button user a image selector dialog opens up, user can select the photos he wants to upload and click ok. On clicking ok the image uploading starts. + </para> + + + <para> + The <guilabel>Tags</guilabel> field can be filled with a series of words (comma seperated) which will be assigned as tags to the images uploaded. + </para> + + <para> + The <guilabel>Public</guilabel>, <guilabel>Friends</guilabel>, and <guilabel>Family</guilabel> Checkbox can be checked to have appropriate access permission on the images you upload. By default the images upload are private. + </para> + + <para> + If the <guilabel>Resize photos before uploading</guilabel> option is selected, the photos will be resized before uploading. The values will be read from the <guilabel>Maximum dimension</guilabel> combobox. + </para> + + <para> + The <guilabel>Maximum Dimension</guilabel> combobox can be used to adjust the maximum height to which the photos will be resized before uploading. The width calculation will be done so as to have the aspect ratio conserved. + </para> + + <figure> + <title>The Uploading Progress Dialog Preview</title> + <graphic srccredit="The Uploading Progress Dialog Preview" fileref="flickrexportuploading.png"/> + </figure> + <para> + User can click <guilabel>Cancel</guilabel> button to abort the uploading of photos. +</para> + +<para> +Finally user can view the uploaded photos by visting <ulink url="http://www.flickr.com">Flickr</ulink> website. +</para> +</sect1> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: ts +End: +--> diff --git a/doc/kipi-plugins/flickrexportauthenticated.png b/doc/kipi-plugins/flickrexportauthenticated.png Binary files differnew file mode 100644 index 0000000..8d768ed --- /dev/null +++ b/doc/kipi-plugins/flickrexportauthenticated.png diff --git a/doc/kipi-plugins/flickrexportcontinue.png b/doc/kipi-plugins/flickrexportcontinue.png Binary files differnew file mode 100644 index 0000000..b1438a9 --- /dev/null +++ b/doc/kipi-plugins/flickrexportcontinue.png diff --git a/doc/kipi-plugins/flickrexportsignup.png b/doc/kipi-plugins/flickrexportsignup.png Binary files differnew file mode 100644 index 0000000..109f936 --- /dev/null +++ b/doc/kipi-plugins/flickrexportsignup.png diff --git a/doc/kipi-plugins/flickrexportuploaddialog.png b/doc/kipi-plugins/flickrexportuploaddialog.png Binary files differnew file mode 100644 index 0000000..538c6cc --- /dev/null +++ b/doc/kipi-plugins/flickrexportuploaddialog.png diff --git a/doc/kipi-plugins/flickrexportuploading.png b/doc/kipi-plugins/flickrexportuploading.png Binary files differnew file mode 100644 index 0000000..e1b6059 --- /dev/null +++ b/doc/kipi-plugins/flickrexportuploading.png diff --git a/doc/kipi-plugins/galleryexport.docbook b/doc/kipi-plugins/galleryexport.docbook new file mode 100644 index 0000000..2dbbfd5 --- /dev/null +++ b/doc/kipi-plugins/galleryexport.docbook @@ -0,0 +1,42 @@ +<chapter id="galleryexport"> +<chapterinfo> + +<title>Gallery Export</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Gallery Export plugin is a tool for export image collections to a remote Gallery server. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The Kipi plugin <quote>Gallery Export</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact Kipi team mailing list <email>kde-imaging@kde.org</email>. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/geolocation.docbook b/doc/kipi-plugins/geolocation.docbook new file mode 100644 index 0000000..0695cfb --- /dev/null +++ b/doc/kipi-plugins/geolocation.docbook @@ -0,0 +1,165 @@ +<chapter id="geolocation"> +<chapterinfo> + +<title>Geolocation Editor</title> + +<authorgroup> + <author> + <firstname>Gerhard</firstname><surname>Kulzer</surname> + <affiliation><address><email>gerhard at kulzer dot net</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Geolocation plugin allows for adding and editing GPS coordinates of picture metadata. The geo-data is stored into the image (EXIF tags) and the location can be displayed in an external browser map. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> + The Kipi plugin <quote>Geolocation</quote> provides the tools to localize pictures geographically in the common spherical coordinate system (used by GPS/Galileo). Altitude, latitude and longitude are being used. +</para> +<note><para> + The plugin only works for image formats that have EXIF support by <ulink url="http://www.exiv2.org">libkexiv2</ulink> +</para></note> + +<sect1 id="geolocation-title"> <title>Geolocation</title> +<para> +The plugin has two methods to mark the pictures with coordinates: +</para> +<itemizedlist> + <listitem> + <para> + Batch correlation of GPS tracking data with a series of images. </para> + </listitem> + <listitem> + <para> + Semi-automatic coordinate attribtuin to single pictures. </para> + </listitem> +</itemizedlist> + +<sect2 id="geolocation-correlator"> <title>The correlator</title> + <para>In order to correlate your images with geo data you need to have a GPS track available as a XML file in gpx format (<ulink url="http://www.gpsbabel.org">gpsbabel</ulink> and <ulink url="http://www.ncc.up.pt/gpsman/">gpsman</ulink> can do the download and conversion of track data from a GPS device for you). + </para> + <para> + <menuchoice><guimenu>Image</guimenu> + <guimenuitem>Geolocation</guimenuitem> + <guimenuitem>Correlator</guimenuitem></menuchoice>. + This interface can correlate a previously selected number of pictures with a registered GPS track. + </para> + <example> + <title>The geo-correlation dialog based on EXIF date/time and track data (gpx format)</title> + <screenshot><mediaobject><imageobject><imagedata fileref="geolocationcorrelate.png" format="PNG" /> </imageobject></mediaobject></screenshot> + </example> + <para> + Select the images you want to correlate in the application main view, then call the menu. The above dialog will show up. To indicate possible time/location correlation you have to load a track file with <guilabel>Load GPX File</guilabel> that contains of course GPS data taken at the same time and location as the pictures with your photo camera. + </para> + <para> + When the file is loaded, an automatic correlation is done showing the attributed coordinates in red. GPS track data is invariably recorded in GMT time, so you need to match the camera time with GMT, which can be done with <guilabel>Time Zone</guilabel>. Select the <emphasis>camera time zone</emphasis> here! + </para> + <para> + The <guilabel>Max. time gap</guilabel> setting specifies the limit within which GPS time and camera time shall be deemed coincident. The maximum value is 2000 seconds. + </para> + <tip><para>If you have no track data for pictures that were taken in the same place you can just manually edit a gpx file and apply it to those images. The 2000 seconds time gap will then correlate all pictures taken within two 3rds of an hour. + </para></tip> + + <para> + The option <guilabel>Interpolate</guilabel> and <guilabel>Difference in min.</guilabel> can be used if there is no match of data. If you know that in reality there is a location match despite a larger time gap between camera and GPS, you can set this limit here and click on the <guilabel>Correlate</guilabel> button to interpolate. + </para> + <example> + <title>Correlation</title> + <screenshot><mediaobject><imageobject><imagedata fileref="geolocationcorrelate1.png" format="PNG" /> </imageobject></mediaobject></screenshot> + </example> + <para> + 240 minutes is the maximum time difference that can be introduced here. + </para> + +</sect2> + +<sect2 id="geolocation-edit-coordinates"> <title>Edit Coordinates</title> + <example> + <title>Semi-automatic attributing of coordinates through map interaction</title> + <screenshot><mediaobject><imageobject><imagedata fileref="geolocationeditcoords.png" format="PNG" /> </imageobject></mediaobject></screenshot> + </example> + <para> + The coordinates can be set manually with this dialog. This comes handy if there is a series of photos taken at the same location. Since the coordinates are memorized from one dialog call to another, it is as easy as clicking onto <guilabel>OK</guilabel> to set the previous data to the current photo. + </para> + <para> + Otherwise the location can be found and fixed iteratively with the displayed map. Click on the region of interest, zoom in, adjust location by clicking again, and so on until sufficient accuracy is achieved. The altitude must always be entered manually. The map can be switched between map mode, satellite image or mixed mode. + </para> +</sect2> + +<sect2 id="geolocation-manual"> <title>Commandline tagging</title> + <para> + Completely outside of the kipi-plugin context, the are ways to GPS tag images. Here a litel script is given that uses the exiftool to tag a batch of images. + </para> + + +<blockquote><screen> +#!/bin/sh +# exiftool wrapper script for easy commandline use. It treats regex files or whole directories. +# +# FMT Output +# "%d deg %d' %.2f"\" 54 deg 59' 22.80" +# "%d deg %.4f min" 54 deg 59.3800 min +# "%.6f degrees" 54.989667 degrees + +if [ -z $1 ]; then + echo "Usage: exiftool-gps-wrapper lat long [alt] file || dir (use signed floating coordinates)" +else + + if [ -z "$4" ]; then foo="$3"; alt=0 + else foo="$4"; alt=$3 + fi + + echo $foo + if [ -e "$foo" ] ; then + latR=$(echo "$1" | awk '{if ($1 < 0) print "S"; else print "N"}') + lonR=$(echo "$2" | awk '{if ($1 < 0) print "W"; else print "E"}') + lat=$(echo "$1" | awk '{val = $1; if ($1 < 0) sub(/-/, "", val); print val}') # absolute value + lon=$(echo "$2" | awk '{val = $1; if ($1 < 0) sub(/-/, "", val); print val}') # absolute value + # use the following syntax for easy googlian paste of ll=-1.23456,53.345345 + #lonR=$(echo "$2" | awk '{if ($2 < 0) print "W"; else print "E"}') + echo $lat, $latR, $lon, $lonR, $3, $4, $foo + + function setgpsinfo () + { + exiftool -c "%.6f" -GPSMapDatum="WGS-84" -GPSAltitude=$5 \ + -GPSLongitudeRef=$4 -GPSLongitude=$3 -GPSLatitudeRef=$2 -GPSLatitude=$1 "$6" + exiftool -GPS:ALL "$6" + } + + if [ -d "$foo" ] ; then + + for i in "$foo" ; do # the selection of files treated depend on the passed regex + echo "i= "$i + setgpsinfo $lat $latR $lon $lonR $alt "$i" + done + else + setgpsinfo $lat $latR $lon $lonR $alt "$foo" + fi + else echo "file or folder is wrong" + fi +fi +</screen></blockquote> +</sect2> +</sect1> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/geolocationcorrelate.png b/doc/kipi-plugins/geolocationcorrelate.png Binary files differnew file mode 100644 index 0000000..e447382 --- /dev/null +++ b/doc/kipi-plugins/geolocationcorrelate.png diff --git a/doc/kipi-plugins/geolocationcorrelate1.png b/doc/kipi-plugins/geolocationcorrelate1.png Binary files differnew file mode 100644 index 0000000..e5b9da7 --- /dev/null +++ b/doc/kipi-plugins/geolocationcorrelate1.png diff --git a/doc/kipi-plugins/geolocationeditcoords.png b/doc/kipi-plugins/geolocationeditcoords.png Binary files differnew file mode 100644 index 0000000..5ad14ac --- /dev/null +++ b/doc/kipi-plugins/geolocationeditcoords.png diff --git a/doc/kipi-plugins/imagegallery_albumsettings.png b/doc/kipi-plugins/imagegallery_albumsettings.png Binary files differnew file mode 100644 index 0000000..e58b72c --- /dev/null +++ b/doc/kipi-plugins/imagegallery_albumsettings.png diff --git a/doc/kipi-plugins/imagegallery_collectionselection.png b/doc/kipi-plugins/imagegallery_collectionselection.png Binary files differnew file mode 100644 index 0000000..bd81954 --- /dev/null +++ b/doc/kipi-plugins/imagegallery_collectionselection.png diff --git a/doc/kipi-plugins/imagegallery_looksettings.png b/doc/kipi-plugins/imagegallery_looksettings.png Binary files differnew file mode 100644 index 0000000..50952c1 --- /dev/null +++ b/doc/kipi-plugins/imagegallery_looksettings.png diff --git a/doc/kipi-plugins/imagegallery_preview.png b/doc/kipi-plugins/imagegallery_preview.png Binary files differnew file mode 100644 index 0000000..34adffe --- /dev/null +++ b/doc/kipi-plugins/imagegallery_preview.png diff --git a/doc/kipi-plugins/imagegallery_progress.png b/doc/kipi-plugins/imagegallery_progress.png Binary files differnew file mode 100644 index 0000000..c1b6513 --- /dev/null +++ b/doc/kipi-plugins/imagegallery_progress.png diff --git a/doc/kipi-plugins/imagegallery_thumbsettings.png b/doc/kipi-plugins/imagegallery_thumbsettings.png Binary files differnew file mode 100644 index 0000000..7d4f8c3 --- /dev/null +++ b/doc/kipi-plugins/imagegallery_thumbsettings.png diff --git a/doc/kipi-plugins/imagesgallery.docbook b/doc/kipi-plugins/imagesgallery.docbook new file mode 100644 index 0000000..3a7ac12 --- /dev/null +++ b/doc/kipi-plugins/imagesgallery.docbook @@ -0,0 +1,145 @@ +<chapter id="imagesgallery"> +<chapterinfo> + +<title>Images Gallery</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 images gallery plugin is a tool for exporting a set of Albums to an HTML page. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +This powerful plugin can export your Albums into a HTML page compliant to 4.01 version for web publication in the form of an image gallery. You can easily select the Albums to export in an HTML page and set a big parameters list for the HTML rendering. UTF-8 encoding is used for a best internationalization. +</para> + +<para> +You can see some samples building with this plugin at this +<ulink url="http://digikamplugins.free.fr/ImagesGallerySamples/MultipleAlbums/index.htm"><citetitle>url.</citetitle></ulink> +</para> + +<sect1 id="using-plugin-imagesgallerycollectionselection"> +<title>Collections Selection Dialog</title> + +<para> +The plugin has four tabs to adapt the settings. +The <guilabel>Selection</guilabel> tab allows you to select all Albums you want to export to HTML. Just check the respective Albums (they are displayed without hierarchical nesting). The three buttons to the right help to quickly select large amounts of Albums. The frame below shows the Album ID-picture with the text that will appear as a header of the HTML page. +</para> + +<figure> + <title>The Collections Selection Dialog</title> + <graphic srccredit="The Collections Selection Dialog" fileref="imagegallery_collectionselection.png"/> +</figure> + +</sect1> + +<sect1 id="using-plugin-imagesgallerylooksettings"> +<title>Look Settings Dialog</title> + +<para> +The <guilabel>Look</guilabel> tab defines the general look and layout of each page. This tab is largely self-explanatory. The <guilabel>Create pages for each image</guilabel> check box will create a gallery with a HTML page per image, that is, if you click onto an image a new page will open showing the image within the web browser. If you leave this box unchecked clicking the images will directly open them with the default image viewer, e.g. Kuickshow. +</para> + +<figure> + <title>The Look Settings Dialog</title> + <graphic srccredit="The Look Settings Dialog" fileref="imagegallery_looksettings.png"/> +</figure> + +</sect1> + +<sect1 id="using-plugin-imagesgalleryalbumsettings"> +<title>Album Settings Dialog</title> + +<para> +The <guilabel>Album</guilabel> tab defines the settings of where and how to store the gallery with all its associated images. Select a folder with write access where you want the gallery to be written to. A sub-folder named KIPIHTMLExport will be created containing everything. +</para> + +<para> +When you check the <guilabel>Resize target images</guilabel> box you can fix the maximum target image size (in pixels) with the slider below it. Images bigger than this value will be scaled down to it, smaller images will not be modified. +The next two check boxes allow you to set specific image compression features. If disk space is of concern check the target image compression and lower the compression level from the host application default value. Then you can choose between JPEG (smallest filesize, but lossy) and PNG (lossless and free license) formats. +</para> + +<note><para> +If JPEG file format is selected for target resizing images, all EXIF informations will be preserved from original JPEG files. +</para></note> + +<para> +With the <guilabel>Set different color depth</guilabel> check box you can change the default color depth. This will of course influence the filesize. The rest of the setting are rather self-explanatory. +</para> + +<figure> + <title>The Album Settings Dialog</title> + <graphic srccredit="The Album Settings Dialog" fileref="imagegallery_albumsettings.png"/> +</figure> + +</sect1> + +<sect1 id="using-plugin-imagesgallerythumbsettings"> +<title>Thumbnails Settings Dialog</title> + +<para> +The <guilabel>Thumbnails</guilabel> tab allows to set some of the <guilabel>Album</guilabel> tab settings for the thumbnails (that are the small images shown in the gallery). +</para> + +<figure> + <title>The Thumbnails Settings Dialog</title> + <graphic srccredit="The Thumbnails Settings Dialog" fileref="imagegallery_thumbsettings.png"/> +</figure> + +</sect1> + +<sect1 id="using-plugin-imagesgalleryinaction"> +<title>Images Gallery in Action</title> + +<para> +A progress dialog giving a feedback indicate to user. Press <guilabel>Cancel</guilabel> button during this stage +if you want abort the process. +</para> + +<figure> + <title>The Images Gallery Plugin in Action</title> + <graphic srccredit="The Images Gallery Plugin in Action" fileref="imagegallery_progress.png"/> +</figure> + +<para> +When all jobs are completed, this dialog will not closed automaticly and user can consult the progress messages +if any errors occurs durring this stage. The web browser will be started automaticly at end to display a gallery preview. Press <guilabel>Close</guilabel> button to close dialog. +</para> + +<figure> + <title>The Images Gallery Preview in Konqueror</title> + <graphic srccredit="The Images Gallery Preview in Konqueror" fileref="imagegallery_preview.png"/> +</figure> + +</sect1> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/imageviewer.docbook b/doc/kipi-plugins/imageviewer.docbook new file mode 100644 index 0000000..7811daa --- /dev/null +++ b/doc/kipi-plugins/imageviewer.docbook @@ -0,0 +1,198 @@ +<chapter id="imageviewer"> +<chapterinfo> + +<title>OpenGL Imageviewer</title> + +<authorgroup> + <author> + <firstname>Markus</firstname><surname>Leuthold</surname> + <affiliation><address><email>kusi _AT forum dot titlis _dot org</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi imageviewer is a very fast and flexible tool for viewing images, based on OpenGL +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The KIPI imageviewer allows to display a selection of images and to do basic operations, such as rotation, zooming or panning. The usage of the viewer is only based on keyboard shortcuts and mouse gestures. It was placed emphasis mainly on speed in displaying as well as fast access to the functions. +</para> + + +<variablelist><title>Image Access</title> +<varlistentry><term>Next Image</term> +<listitem> +<para> +<itemizedlist> +<listitem><para>Scrollwheel Down</para></listitem> +<listitem><para>Down/Right Arrow</para></listitem> +<listitem><para>Space</para></listitem> +<listitem><para>Key N</para></listitem> +<listitem><para>PgDown</para></listitem> +</itemizedlist> +</para> +</listitem> +</varlistentry> + +<varlistentry><term>Previous Image</term> +<listitem> +<para> +<itemizedlist> +<listitem><para>Scrollwheel Up</para></listitem> +<listitem><para>Up/Left Arrow</para></listitem> +<listitem><para>Key P</para></listitem> +<listitem><para>PgUp</para></listitem> +</itemizedlist> +</para> +</listitem> +</varlistentry> + +<varlistentry><term>Quit</term> +<listitem> +<para> +<itemizedlist> +<listitem><para>Esc</para></listitem> +</itemizedlist> +</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> + <title>Display</title> + <varlistentry> + <term>Toggle fullscreen/normal</term> + <listitem> + <para> + On startup, an image is displayed in fullscreen mode by default. It can be changed to windowed mode + </para> + <para> + <itemizedlist> + <listitem> + <para>Key F</para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Toggle scrollwheel action</term> + <listitem> + <para> + Turning the scrollwheel either proceeds to the next image or zooms into the image + </para> + <para> + <itemizedlist> + <listitem> + <para>Key C</para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>Rotation</term> + <listitem> + <para> + The rotation is only temporary and not saved to the file + </para> + <para> + <itemizedlist> + <listitem> + <para>Key R</para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>Reset view</term> + <listitem> + <para> + <itemizedlist> + <listitem> + <para>double click</para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + + + <varlistentry> + <term>Original size</term> + <listitem> + <para> + Each pixel of the image corresponds to a pixel of the screen + </para> + <para> + <itemizedlist> + <listitem> + <para>Key O</para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> +</variablelist> + +<variablelist> + <title>Zooming</title> + <varlistentry> + <term></term> + <listitem> + <itemizedlist> + <listitem> + <para>move mouse up/down while pressing the right mouse button</para> + </listitem> + <listitem> + <para>scrollwheel (in case you toggled the scrollwheel action)</para> + </listitem> + <listitem> + <para>plus/minus</para> + </listitem> + <listitem> + <para>Ctrl + scrollwheel</para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> +</variablelist> + +<variablelist> + <title>Panning</title> + <varlistentry> + <term></term> + <listitem> + <itemizedlist> + <listitem> + <para>move mouse while pressing the left mouse button</para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> +</variablelist> +</chapter> +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/index.docbook b/doc/kipi-plugins/index.docbook new file mode 100644 index 0000000..4559c78 --- /dev/null +++ b/doc/kipi-plugins/index.docbook @@ -0,0 +1,233 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.0//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kipi;"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY doc-acquireimages SYSTEM "acquireimages.docbook"> + <!ENTITY doc-calendar SYSTEM "calendar.docbook"> + <!ENTITY doc-cdarchiving SYSTEM "cdarchiving.docbook"> + <!ENTITY doc-colorimages SYSTEM "colorimages.docbook"> + <!ENTITY doc-convertimages SYSTEM "convertimages.docbook"> + <!ENTITY doc-effectimages SYSTEM "effectimages.docbook"> + <!ENTITY doc-filterimages SYSTEM "filterimages.docbook"> + <!ENTITY doc-findduplicateimages SYSTEM "findduplicateimages.docbook"> + <!ENTITY doc-flickrexport SYSTEM "flickrexport.docbook"> + <!ENTITY doc-galleryexport SYSTEM "galleryexport.docbook"> + <!ENTITY doc-geolocation SYSTEM "geolocation.docbook"> + <!ENTITY doc-imagesgallery SYSTEM "imagesgallery.docbook"> + <!ENTITY doc-imageviewer SYSTEM "imageviewer.docbook"> + <!ENTITY doc-jpeglossless SYSTEM "jpeglossless.docbook"> + <!ENTITY doc-kameraklient SYSTEM "kameraklient.docbook"> + <!ENTITY doc-metadataeditor SYSTEM "metadataeditor.docbook"> + <!ENTITY doc-mpegencoder SYSTEM "mpegencoder.docbook"> + <!ENTITY doc-printwizard SYSTEM "printwizard.docbook"> + <!ENTITY doc-rawconverter SYSTEM "rawconverter.docbook"> + <!ENTITY doc-recompressimages SYSTEM "recompressimages.docbook"> + <!ENTITY doc-renameimages SYSTEM "renameimages.docbook"> + <!ENTITY doc-resizeimages SYSTEM "resizeimages.docbook"> + <!ENTITY doc-sendimages SYSTEM "sendimages.docbook"> + <!ENTITY doc-slideshow SYSTEM "slideshow.docbook"> + <!ENTITY doc-timeadjust SYSTEM "timeadjust.docbook"> + <!ENTITY doc-wallpaper SYSTEM "wallpaper.docbook"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The Kipi Plugins Handbook</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> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<date>2008-02-13</date> +<releaseinfo>0.1.3</releaseinfo> <!-- Used Kicker version here --> + +<copyright> +<year>2004-2008</year> +<holder>The Kipi developers team</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract> +<para> +This is the handbook for the plugins of Kipi, the &kde;'s Images Plugins Interface. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +<keyword>Plugins</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction to Kipi Plugins</title> + +<para> +One of the nicest things about KDE photo management programs like "digiKam", "KPhotoAlbum", "GWenView" and "ShowImg" is how easily their functionality can be extended, by using plugins. The Kde Image Plugins Interface (KIPI) project can manipulate image files in almost any way that users can. Their advantage is that it is much easier to add a capability to the host application by writing a small plugin than by modifying the host application core. Many valuable plugins have C++ source code that only comes to 100-200 lines or so. +</para> + +<para> +Kipi plugins are additional functions for the KDE Images Managment Host Programs. They can add extra menus and shortcuts, and extend the host programs features. You can install as many or as few as you like, from within host programs. +</para> + +<para> +More information on using and enabling the plugins you want is available in the host program handbook. +</para> + +<para> +The plugins installed in this handbook are: +</para> + +<itemizedlist> +<listitem> +<para><link linkend="acquireimages">Acquire Images plugin</link></para> +</listitem> +<listitem> +<para><link linkend="calendar">Calendar plugin</link></para> +</listitem> +<listitem> +<para><link linkend="cdarchiving">CD Archiving plugin</link></para> +</listitem> +<listitem> +<para><link linkend="colorimages">Color Images plugin</link></para> +</listitem> +<listitem> +<para><link linkend="convertimages">Convert Images plugin</link></para> +</listitem> +<listitem> +<para><link linkend="effectimages">Effect Images plugin</link></para> +</listitem> +<listitem> +<para><link linkend="filterimages">Filter Images plugin</link></para> +</listitem> +<listitem> +<para><link linkend="findduplicateimages">Find Duplicate Images plugin</link></para> +</listitem> +<listitem> +<para><link linkend="flickrexport">Remote Flickr Export plugin</link></para> +</listitem> +<listitem> +<para><link linkend="galleryexport">Remote Gallery Export plugin</link></para> +</listitem> +<listitem> +<para><link linkend="geolocation">Geolocation plugin</link></para> +</listitem> +<listitem> +<para><link linkend="imagesgallery">Images Gallery plugin</link></para> +</listitem> +<listitem> +<para><link linkend="imageviewer">OpenGL Imageviewer plugin</link></para> +</listitem> +<listitem> +<para><link linkend="jpeglossless">JPEG Loss Less plugin</link></para> +</listitem> +<listitem> +<para><link linkend="kameraklient">Digital camera client plugin</link></para> +</listitem> +<listitem> +<para><link linkend="mpegencoder">MPEG Encoder plugin</link></para> +</listitem> +<listitem> +<para><link linkend="metadataeditor">Metadata Editor plugin</link></para> +</listitem> +<listitem> +<para><link linkend="printwizard">Print Wizard plugin</link></para> +</listitem> +<listitem> +<para><link linkend="rawconverter">Raw Converter plugin</link></para> +</listitem> +<listitem> +<para><link linkend="recompressimages">Recompress Images plugin</link></para> +</listitem> +<listitem> +<para><link linkend="renameimages">Rename Images plugin</link></para> +</listitem> +<listitem> +<para><link linkend="resizeimages">Resize Images plugin</link></para> +</listitem> +<listitem> +<para><link linkend="sendimages">Send Images plugin</link></para> +</listitem> +<listitem> +<para><link linkend="slideshow">Slide Show plugin</link></para> +</listitem> +<listitem> +<para><link linkend="timeadjust">Time Adjust plugin</link></para> +</listitem> +<listitem> +<para><link linkend="wallpaper">Wall Paper plugin</link></para> +</listitem> +</itemizedlist> +</chapter> + +&doc-acquireimages; +&doc-calendar; +&doc-cdarchiving; +&doc-colorimages; +&doc-convertimages; +&doc-effectimages; +&doc-filterimages; +&doc-findduplicateimages; +&doc-flickrexport; +&doc-galleryexport; +&doc-geolocation; +&doc-imagesgallery; +&doc-imageviewer; +&doc-jpeglossless; +&doc-kameraklient; +&doc-mpegencoder; +&doc-metadataeditor; +&doc-printwizard; +&doc-rawconverter; +&doc-recompressimages; +&doc-renameimages; +&doc-resizeimages; +&doc-sendimages; +&doc-slideshow; +&doc-timeadjust; +&doc-wallpaper; + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +Copyrights for each plugin is listed in the applicable chapter. +</para> + +<para> +All Pictures copyrighted 2004-2007 by Gilles Caulier <email>caulier_dot_gilles_at_free.fr</email> and Gerhard Kulzer <email>gerhard_at_kulzer.net</email>. +</para> + +&underFDL; +&underGPL; + +</chapter> + +<!-- +<appendix id="installation"> +<title>Installation</title> +<para>To be written +</para> +</appendix> +--> + +</book> + +<!-- +Local Variables: +mode: sgml +End: +--> diff --git a/doc/kipi-plugins/jpeglossless.docbook b/doc/kipi-plugins/jpeglossless.docbook new file mode 100644 index 0000000..abc6eb6 --- /dev/null +++ b/doc/kipi-plugins/jpeglossless.docbook @@ -0,0 +1,50 @@ +<chapter id="jpeglossless"> +<chapterinfo> + +<title>JPEG Loss Less</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi JPEG lossless plugin is a tool to transform the images without loss in quality due to compression. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +This plugin is available from within the host application. It allows (for the below listed transformations) to save images in JPEG format, which usually looses precision every time you save it (otherwise there would not be no size reduction) without losing any quality nor metadata information: +</para> + +<itemizedlist> +<listitem><para>Do lossless JPEG 90/180/270 Degree Rotation.</para></listitem> +<listitem><para>Do lossless JPEG Horizontal or Vertical flip.</para></listitem> +<listitem><para>Do lossless JPEG black and white conversion.</para></listitem> +<listitem><para>Exif orientation tag based rotation or flip auto-adjustment.</para></listitem> +<listitem><para>Do lossless recompression of JPEG images.</para></listitem> +</itemizedlist> +<para>As a consequence of the lossless storage the file size will be larger (similar to the lossless PNG format) since there's no compression of the color coding information. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/kameraklient.docbook b/doc/kipi-plugins/kameraklient.docbook new file mode 100644 index 0000000..989f5da --- /dev/null +++ b/doc/kipi-plugins/kameraklient.docbook @@ -0,0 +1,43 @@ +<chapter id="kameraklient"> +<chapterinfo> + +<title>Digital Camera Client</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + + +<abstract> +<para> +The Kipi Camera Client plugin is a tool to connect your computer to a digital camera. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The Kipi plugin <quote>KameraKlient</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact Kipi team mailing list <email>kde-imaging@kde.org</email>. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/metadataeditor.docbook b/doc/kipi-plugins/metadataeditor.docbook new file mode 100644 index 0000000..2057820 --- /dev/null +++ b/doc/kipi-plugins/metadataeditor.docbook @@ -0,0 +1,50 @@ +<chapter id="metadataeditor"> +<chapterinfo> + +<title>Metadata Editor</title> + +<authorgroup> + <author> + <firstname>Gerhard</firstname><surname>Kulzer</surname> + <affiliation><address><email>gerhard at kulzer dot net</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Metadata editor plugin is a tool for adding and editing GPS coordinates of the photo metadata. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +<keyword>Metadata</keyword><keyword>IPTC</keyword><keyword>EXIF</keyword><keyword>Makernote</keyword><keyword>Comments</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The Kipi plugin <quote>Metadata Editor</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact Kipi team mailing list <email>kde-imaging@kde.org</email>. +</para> + + <para> + Using the metadata plugin <guilabel>Import</guilabel> function allows to copy data from one image to another. Select the image you want ot copy to in the main application. Then call the import function, which will open a file browser where you select the source image (the one you want to copy the metadata from). Click <guilabel>OK</guilabel> and the data will be copied over. + </para> + <para> + This feature does not work for all image formats. You can import from everything but not write to everything. JPEG is supported for writing. Please refer to the exiv2 capabilities to know which formats are supported. + </para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/mpeg_encode_dialog.png b/doc/kipi-plugins/mpeg_encode_dialog.png Binary files differnew file mode 100644 index 0000000..5873f77 --- /dev/null +++ b/doc/kipi-plugins/mpeg_encode_dialog.png diff --git a/doc/kipi-plugins/mpegencoder.docbook b/doc/kipi-plugins/mpegencoder.docbook new file mode 100644 index 0000000..2bb6323 --- /dev/null +++ b/doc/kipi-plugins/mpegencoder.docbook @@ -0,0 +1,94 @@ +<chapter id="mpegencoder"> +<chapterinfo> + +<title>MPEG Encoder</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 MPEG Encoder plugin is a tool for converting a series of images into a diashow-style MPEG file. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The MPEG Encoder plugin can be used to convert the selected images into a MPEG sequence with a defined duration and merge all images in an single MPEG file. This plugin applies the "MjpegTools" and "ImageMagick" packages. Between the images, you can insert a basic transition. You can also add an audio track to the images sequence using MP2 or WAV files. +</para> + +<para> +All images will be automatically scaled to the correct size of the selected video format. A background color can be selected. You can use this plugin to build some DVD/XVCD/SVCD/VCD image portfolios for your home DVD player. Use the K3b program to create this media. +</para> + +<sect1 id="using-plugin-mpeg_encode"> +<title>Using the plugin</title> + +<para> +First you have to select the images to be packed into MPEG from the host application browser. Then call from <menuchoice><guimenu>Tools</guimenu><guimenuitem>Create MPEG Slideshow</guimenuitem></menuchoice> menu from the host application window. +</para> + +<para> +The before selected images appear in the <guilabel>Image Files in Portfolio</guilabel> list box. Use this box to order your files or to modify the content of the list. +</para> + +<para> +When you are happy with the content, go on with the other settings. The video format can be chosen from four (DVD/XVCD/SVCD/VCD) different formats. If the MPEG file shall be played over a TV set, select the TV standard from PAL, SECAM and NTSC. PAL is the default value and the probable choice in central Europe. +</para> + +<para> +Then you can choose the display duration per image, it scales in seconds. The list box below allows to select the transition behavior between the images. A low value goes with an rather sudden change whereas a higher value creates a smooth transition. +</para> + +<para> +The next selector lets you free choose the preferred background color. In doubt leave it black. +The 'MPEG Output Filename' box specifies the outout filename and its path (location). Leave the mpg ending but change the path and filename as you wish. +</para> + +<para> +If you point in the 'Audio Input Filename' to an audio file, it will be integrated into the MPEG file. So if you're done with the setting, click on the <guilabel>Encode</guilabel> button to launch the conversion. Depending on your computer speed go and drink a short or long coffee and enjoy the slideshow when its finished. +</para> + +<note> +<para> +If the plugin complains about encoders or tools missing you can set the path to the programs "MjpegTools" and "ImageMagick" at the lower right <guilabel>Settings</guilabel> button. +</para> +</note> + +<figure> + <title>The MPEG Encoder Dialog Preview</title> + <graphic srccredit="The MPEG Encoder Dialog Preview" fileref="mpeg_encode_dialog.png"/> +</figure> + +<para> +You can see some sample builts with this plugin here: +<ulink url="http://digikamplugins.free.fr/MPEGEncodeSamples/">url</ulink>. +</para> + +</sect1> +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/printwizard.docbook b/doc/kipi-plugins/printwizard.docbook new file mode 100644 index 0000000..158aca7 --- /dev/null +++ b/doc/kipi-plugins/printwizard.docbook @@ -0,0 +1,44 @@ +<chapter id="printwizard"> +<chapterinfo> + +<title>Print Wizard</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi print wizard plugin is a tool for to print images at the same time. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The print wizard allows multiple images to be combined into 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 plugin. The +combined images can also be output directly to jpeg files. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/raw_converter_batch.png b/doc/kipi-plugins/raw_converter_batch.png Binary files differnew file mode 100644 index 0000000..3998ca3 --- /dev/null +++ b/doc/kipi-plugins/raw_converter_batch.png diff --git a/doc/kipi-plugins/raw_converter_single.png b/doc/kipi-plugins/raw_converter_single.png Binary files differnew file mode 100644 index 0000000..9903f32 --- /dev/null +++ b/doc/kipi-plugins/raw_converter_single.png diff --git a/doc/kipi-plugins/rawconverter.docbook b/doc/kipi-plugins/rawconverter.docbook new file mode 100644 index 0000000..f15a13a --- /dev/null +++ b/doc/kipi-plugins/rawconverter.docbook @@ -0,0 +1,116 @@ +<chapter id="rawconverter"> +<chapterinfo> + +<title>Raw Image Converter</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 <quote>Raw Image Converter</quote> plugin is a conversion tool for raw format images. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +With this Kipi-plugin you can import/convert your images stored in <emphasis>RAW format</emphasis> to three +formats of your choice (<guilabel>JPEG</guilabel>, <guilabel>TIFF</guilabel>, <guilabel>PPM</guilabel>). +</para> + +<para>Some considerations before your convert, and even before you shoot in raw format. RAW image file formats keep the original information of the exposure supposedly without loss (when compressed, they use reversible, lossless compressions algorithms). Many photographers prefer to take their picture in RAW mode because the camera's built-in conversion program is often less good then what you can achieve with digital image processing. The whitebalance of +the digital camera is registered but not applied to the image. Some CMOS CCD's create four color filter data, RGBG, Red, Green, Blue and another Green mask for contrast enhancement. The plugin can take this into account. +</para> + +<para> +The conversion is actually based on Dave Coffin's command line tool <emphasis>dcraw</emphasis> (Dave: "Don't expect dcraw to produce the same images as software provided by the camera vendor. Sometimes dcraw gives better results!"). +</para> + +<sect1 id="using-plugin-rawconversiondialog"> +<title>Single Conversion Dialog</title> + +<para> +Select the RAW file to convert and open the plugin from the host application. The <emphasis>Raw Image Converter</emphasis> window in single mode will appear. Click on <guilabel>Preview</guilabel> to show the effect of your settings taking shape. +</para> + +<para> +Now you can adjust the available check and value boxes to optimise the conversion process. The first checkbox indicates to use the camera settings for white balance. The essential parameters like brightness, and red/blue amplifier may be adjusted. If the result is not quite optimal, don't worry, it is always possible to finetune the image later on. +</para> + +<para> +A <guilabel>Four color RGBG</guilabel> conversion can be selected to use contrast information. (If your camera works in RGB mode, the RGBG setting has no effect). +</para> + +<para>If you're happy with the preview, choose one of three output formats to save the conversion result. The file name will stay the same, the extension only changes. <guilabel>JPEG</guilabel> uses the lossy algorithm and produces the smallest output file size. +</para> + +<para> +The tagged image format (<guilabel>TIFF</guilabel>) preserves all information of your image whilst using lossless LZW compression. +</para> + +<para> +The Portable PixMap format (<guilabel>PPM</guilabel>) produces the largest output file and contains most data. +</para> + +<tip><para> +If you intend to work a lot on your images or if it is likely that you have to reuse it later on, then don't use <guilabel>JPEG</guilabel> format because it allows a limited number of operations only before it deterioates visibly. <guilabel>TIFF</guilabel> and <guilabel>PPM</guilabel> are better suited to keep the original data. +</para></tip> + +<note><para> +If you choose <guilabel>JPEG</guilabel> as <guilabel>Save Format</guilabel> then the meta-data included in RAW file will be included in the <guilabel>JPEG</guilabel> files like Exif information. +</para></note> + +<para> +When you have finished click the <guilabel>Process</guilabel> button to start the conversion. If you want abort image conversion, press <guilabel>Abort</guilabel> button. +</para> + +<figure> + <title>The RAW Converter Dialog in Single Mode</title> + <graphic srccredit="The RAW Converter Dialog in Single Mode" fileref="raw_converter_single.png"/> +</figure> + +</sect1> + +<sect1 id="using-plugin-rawbatchdialog"> +<title>Batch Conversion Dialog</title> + +<para> +The batch mode converter allows you to convert several images in one go. Use this mode when you're are sure of the best settings, i.e. try it out in single conversion mode first. +</para> + +<para> +The available setting are mostly identical to the single mode dialog. Here you have the additional option to overwrite existing files (which you might have created in an earlier try). The preview option is not available here. A progress bar indicate the conversion status in live. +</para> + +<figure> + <title>The Batch RAW Converter Dialog</title> + <graphic srccredit="The Batch RAW Converter Dialog" fileref="raw_converter_batch.png"/> +</figure> + +</sect1> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> diff --git a/doc/kipi-plugins/recompressimages.docbook b/doc/kipi-plugins/recompressimages.docbook new file mode 100644 index 0000000..b23885d --- /dev/null +++ b/doc/kipi-plugins/recompressimages.docbook @@ -0,0 +1,49 @@ +<chapter id="recompressimages"> +<chapterinfo> + +<title>Recompress Images</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi recompress images plugin is a tool for recompressing the image files. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> + +This plugin can be used for batch recompress images in an Album. It use "convert" program from "ImageMagick" package. The image files formats supported are: + +</para> + +<itemizedlist> +<listitem><para>JPEG.</para></listitem> +<listitem><para>PNG.</para></listitem> +<listitem><para>TIFF.</para></listitem> +<listitem><para>TGA.</para></listitem> +</itemizedlist> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/renameimages.docbook b/doc/kipi-plugins/renameimages.docbook new file mode 100644 index 0000000..a873734 --- /dev/null +++ b/doc/kipi-plugins/renameimages.docbook @@ -0,0 +1,42 @@ +<chapter id="renameimages"> +<chapterinfo> + +<title>Rename Images</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Rename Images plugin is a tool for to rename the images files. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> + +This plugin can be used for batch rename image files in an Album. You can set the prefix name to use, the start index value, and the timestamp. + +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/resizeimages.docbook b/doc/kipi-plugins/resizeimages.docbook new file mode 100644 index 0000000..5685e04 --- /dev/null +++ b/doc/kipi-plugins/resizeimages.docbook @@ -0,0 +1,54 @@ +<chapter id="resizeimages"> +<chapterinfo> + +<title>Resize Images</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Resize Images plugin is a tool for resize or adapt the images dimensions. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +This plugin can be used for batch resize images in an image collection. It use "convert" program from "ImageMagick" package. You can resize up or down the images size. 3 resizing types have been implemented: +</para> + +<itemizedlist> +<listitem><para><emphasis>Proportional (1 dim.)</emphasis> : standard auto-resizing using one dimension. +The width or the height of the images will be automatically selected in depending of the images +orientation. The images aspect ratio are preserved.</para></listitem> +<listitem><para><emphasis>Proportional (2 dim.)</emphasis> : auto-resizing using two dimensions. +The images aspect ratio are preserved. For example, you can use that for to adapt your images size to your +screen size. </para></listitem> +<listitem><para><emphasis>Non proportional</emphasis> : non proportional resizing using two dimensions. +The images aspect ratio aren't preserved.</para></listitem> +<listitem><para><emphasis>Prepare to print</emphasis> : prepare the image for a photographic printing. +The user can set the print resolution and the photographic paper size. The target image will be adapted +to the good dimensions (included the background size, marging size, and background color).</para></listitem> +</itemizedlist> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/sendimages.docbook b/doc/kipi-plugins/sendimages.docbook new file mode 100644 index 0000000..35033b3 --- /dev/null +++ b/doc/kipi-plugins/sendimages.docbook @@ -0,0 +1,138 @@ +<chapter id="sendimages"> +<chapterinfo> + +<title>Send 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 <quote>Send Images</quote> plugin is a tool for sending images directly by e-mail. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +With this Kipi-plugin you can e-mail the selected images with your favorite e-mail agent. A resizing items operation is possible. You can use drag and drop to add more images in the list to send. +</para> + +<sect1 id="using-plugin-mailselectiondialog"> +<title>Image Selection Dialog</title> + +<para> +Upon opening of the plugin from the host application the <emphasis>Images</emphasis> window will appear with your +pre-selected images already in the list to be sent. With the <guilabel>Add Images</guilabel> button a file browser +opens to add more files as needed in the usual file selection manner. The image under the cursor in the list is displayed on the right side. +</para> + +<tip><para> +You can use drag and drop capability between the host application window and the image file list for add new +items to e-mail. +</para></tip> + +<para> +When clicking on the second button <guilabel>Remove Images</guilabel> the selected images (highlighted in the list) +will be removed from the send list. +</para> + +<para> +When you have finished selecting your files, click <guilabel>OK</guilabel> to open the 'new e-mail' dialog window +of your favorite e-mail client. You just need to add the addressee and the subject. The selected images will be already there as attachments. +</para> + +<warning><para> +Be sure not to overload your own or your addresses e-mail transmission limit, most providers limit the e-mail +size to some megabytes of data. Use several e-mails if you want to send a lot of data. +</para></warning> + +<figure> + <title>The Image Selection Dialog</title> + <graphic srccredit="The Image Selection Dialog" fileref="sendimages_imageselection.png"/> +</figure> + +</sect1> + +<sect1 id="using-plugin-mailsettingsdialog"> +<title>Mail Dialog</title> + +<para> +The mail dialog is used to change the settings of the images to be sent. These settings will be remembered when you close the plugin until you change them. +</para> + +<para> +Select your favorite e-mail client from the drop-down menu. (If you use <application>Thunderbird</application>, the field below will be available to select the correct path according to your installation). +</para> + +<note><para> +If you want to use GMail service, you need to install <application>GMailAgent</application> in your computer, available at <ulink url="http://gmailagent.sourceforge.net">this url</ulink>. +</para></note> + +<para> +If you select <guilabel>Add Comments in the Attached File</guilabel> the comments included with the images will be merged to a text file and attached in the mail. +</para> + +<para> +The next 3 items allow you to set-up the image quality to be sent. Select one of those. The <guilabel>New Images Compression</guilabel> ratio can be chosen with the slider or the value box. 75% is a standard compression ratio for <guilabel>JPEG</guilabel> files. Setting compression to 100% will result in a lossless compression at the cost of the largest file size. The difference in file size between 90% and 100% can be quite dramatic, whereas the gain in quality is minor. Very good quality is already obtained with 85% compression. +</para> + +<para> +The <guilabel>PNG</guilabel> format on <guilabel>New Images Format</guilabel> drop-down menu is not well adapted to reduce photographic images file size, but it is best suited for compressing lossless items like TIFF file format. <guilabel>PNG</guilabel> must be used if you use a speed internet dialup and if you want preserved the photo quality. Else, <guilabel>JPEG</guilabel> is the recommended format. +</para> + +<note><para> +If you choose <guilabel>JPEG</guilabel> as <guilabel>New Images Format</guilabel> and if the original files were in <guilabel>JPEG</guilabel> format, then the original Exif data included is preserved in e-mailed images. +</para></note> + +<figure> + <title>The Mail Dialog</title> + <graphic srccredit="The Mail Dialog" fileref="sendimages_mail.png"/> +</figure> + +</sect1> + +<sect1 id="using-plugin-emailimagesinaction"> +<title>E-mail Images in Action</title> + +<para> +A progress dialog giving a feedback indicate to user. Press <guilabel>Cancel</guilabel> button during this stage +if you want abort the process. +</para> + +<para> +When all jobs are completed, this dialog will not closed automaticly and user can consult the progress messages +if any errors occurs durring this stage. The mail agent will be started automaticly at end. Press <guilabel>Close</guilabel> button to close dialog. +</para> + +<figure> + <title>The E-mail Images Plugin in Action</title> + <graphic srccredit="The E-mail Images Plugin in Action" fileref="sendimages_progress.png"/> +</figure> + +</sect1> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +-->
\ No newline at end of file diff --git a/doc/kipi-plugins/sendimages_imageselection.png b/doc/kipi-plugins/sendimages_imageselection.png Binary files differnew file mode 100644 index 0000000..48ea197 --- /dev/null +++ b/doc/kipi-plugins/sendimages_imageselection.png diff --git a/doc/kipi-plugins/sendimages_mail.png b/doc/kipi-plugins/sendimages_mail.png Binary files differnew file mode 100644 index 0000000..3d76120 --- /dev/null +++ b/doc/kipi-plugins/sendimages_mail.png diff --git a/doc/kipi-plugins/sendimages_progress.png b/doc/kipi-plugins/sendimages_progress.png Binary files differnew file mode 100644 index 0000000..1f3c0b9 --- /dev/null +++ b/doc/kipi-plugins/sendimages_progress.png diff --git a/doc/kipi-plugins/slideshow.docbook b/doc/kipi-plugins/slideshow.docbook new file mode 100644 index 0000000..90c14c2 --- /dev/null +++ b/doc/kipi-plugins/slideshow.docbook @@ -0,0 +1,106 @@ +<chapter id="slideshow"> +<chapterinfo> + +<title>The Advanced Slide Show</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 <quote>Advanced Slide Show</quote> plugin creates a configurable full screen slideshow of your images. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +With this Kipi-plugin you create a perfect slide show with 3 mouse clicks. +</para> + +<sect1 id="using-plugin-slideshowsettings"> +<title>The Settings Dialog</title> + +<para> +Upon opening of the plugin from the host application the <emphasis>Advanced Slide Show</emphasis> window will appear asking questions as to how you want to stage your slideshow. You can choose between the selected images and all images in the same album. +</para> + +<para> +The <guilabel>Use OpenGL Slideshow Transitions</guilabel> checkbox enables very smooth image transitions using the OpenGL display mode. Be sure to have OpenGL enabled on your graphics card, since otherwise the slideshow will be very slow. +</para> + +<para> +The <guilabel>Print Filename</guilabel> checkbox enables the image filename to be displayed in the lower left corner. +</para> + +<para> +The <guilabel>Loop</guilabel> checkbox enabled will run the whole show in an endless loop (until manually stopped with +<keycombo><keycap>Esc</keycap></keycombo>). +</para> + +<para> +The <guilabel>Shuffle Image</guilabel> checkbox enables to display randomly the images (not using the current images collection order). +</para> + +<para> +The <guilabel>Delay Between Images</guilabel> may be set in millisecond steps. 1500 milliseconds correspond to 1.5 seconds and are a good default value. The best timing depends also a bit on your computer power and the transition effect. Try it out before you show it to your friends! +</para> + +<para> +There are more than a dozen <guilabel>Transition Effects</guilabel> available which you can choose from. +The <emphasis>Random</emphasis> selection will change the transition effect with every image. +</para> + +<figure> + <title>The Slideshow Dialog</title> + <graphic srccredit="The Slideshow Dialog" fileref="slideshow_dialog.png"/> +</figure> + +</sect1> + +<sect1 id="using-plugin-slideshowinaction"> +<title>Slide Show in Action</title> + +<para> +During slideshow, user can access to a tool bar on the upper left screen corner. Move the mouse cursor to the top left of the screen for enable it. +</para> + +<para> +With this tool bar, user can drive the progress, for pausing/playing slidesow, back to the preview image, go to the next image, and stoping slideshow. +</para> + +<para> +On the lower left screen corner you can see the current image file name, the current image id on the slideshow, and the total number of images include in. +</para> + +<figure> + <title>The Advanced Slideshow Plugin in Action</title> + <graphic srccredit="The Slideshow Plugin in Action" fileref="slideshow.png"/> +</figure> + +</sect1> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +-->
\ No newline at end of file diff --git a/doc/kipi-plugins/slideshow.png b/doc/kipi-plugins/slideshow.png Binary files differnew file mode 100644 index 0000000..d15e4ff --- /dev/null +++ b/doc/kipi-plugins/slideshow.png diff --git a/doc/kipi-plugins/slideshow_dialog.png b/doc/kipi-plugins/slideshow_dialog.png Binary files differnew file mode 100644 index 0000000..71012c3 --- /dev/null +++ b/doc/kipi-plugins/slideshow_dialog.png diff --git a/doc/kipi-plugins/timeadjust.docbook b/doc/kipi-plugins/timeadjust.docbook new file mode 100644 index 0000000..e8fb1ee --- /dev/null +++ b/doc/kipi-plugins/timeadjust.docbook @@ -0,0 +1,42 @@ +<chapter id="timeadjust"> +<chapterinfo> + +<title>Time Adjust</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi Time Adjust plugin is a tool for adjusting image files timestamp. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +The Kipi plugin <quote>Time Adjust</quote> currently has no +documentation. If you are interested in rectifying that situation, +please contact Kipi team mailing list <email>kde-imaging@kde.org</email>. +</para> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kipi-plugins/wallpaper.docbook b/doc/kipi-plugins/wallpaper.docbook new file mode 100644 index 0000000..3007d6f --- /dev/null +++ b/doc/kipi-plugins/wallpaper.docbook @@ -0,0 +1,50 @@ +<chapter id="wallpaper"> +<chapterinfo> + +<title>Wall Paper</title> + +<authorgroup> + <author> + <firstname>Gilles</firstname><surname>Caulier</surname> + <affiliation><address><email>caulier dot gilles at free.fr</email></address></affiliation> + </author> +</authorgroup> + +<abstract> +<para> +The Kipi wall paper plugin is a tool for push an image in the desktop background. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kipi</keyword> +</keywordset> +</chapterinfo> + +<title>Introduction</title> + +<para> +This plugin place the current selected image in the KDE desktop in according with the menu sub-option selected: +</para> + +<itemizedlist> +<listitem><para>Centered.</para></listitem> +<listitem><para>Tiled.</para></listitem> +<listitem><para>Centered tiled.</para></listitem> +<listitem><para>Centered max-aspect.</para></listitem> +<listitem><para>Tiled max-aspect.</para></listitem> +<listitem><para>Scaled.</para></listitem> +<listitem><para>Centered auto fit.</para></listitem> +</itemizedlist> + +</chapter> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + |
