Git commit a6e753d096738aeb416fd9bc70ce230f9683f476 by Gilles Caulier. Committed on 22/08/2016 at 11:32. Pushed by cgilles into branch 'master'.
move acquire images tool to digiKam and cleanup D +- -- acquire-final-button.png D +- -- acquire-main-window.png D +- -- acquire-multiple-selections.png D +- -- acquire-no-scanner-found.png D +- -- acquire-other-options.png D +- -- acquire-preview-button.png D +- -- acquire-scanning.png D +- -- acquire-zoom-in.png D +- -- acquire-zoom-to-fit.png D +0 -258 acquireimages.docbook M +9 -47 index.docbook http://commits.kde.org/kipi-plugins-doc/a6e753d096738aeb416fd9bc70ce230f9683f476 diff --git a/acquire-final-button.png b/acquire-final-button.png deleted file mode 100644 index 179755b..0000000 Binary files a/acquire-final-button.png and /dev/null differ diff --git a/acquire-main-window.png b/acquire-main-window.png deleted file mode 100644 index d2ba51e..0000000 Binary files a/acquire-main-window.png and /dev/null differ diff --git a/acquire-multiple-selections.png b/acquire-multiple-selections.png deleted file mode 100644 index 4e2117e..0000000 Binary files a/acquire-multiple-selections.png and /dev/null differ diff --git a/acquire-no-scanner-found.png b/acquire-no-scanner-found.png deleted file mode 100644 index 3727670..0000000 Binary files a/acquire-no-scanner-found.png and /dev/null differ diff --git a/acquire-other-options.png b/acquire-other-options.png deleted file mode 100644 index e07a4f5..0000000 Binary files a/acquire-other-options.png and /dev/null differ diff --git a/acquire-preview-button.png b/acquire-preview-button.png deleted file mode 100644 index 39c7f4b..0000000 Binary files a/acquire-preview-button.png and /dev/null differ diff --git a/acquire-scanning.png b/acquire-scanning.png deleted file mode 100644 index 4418d6a..0000000 Binary files a/acquire-scanning.png and /dev/null differ diff --git a/acquire-zoom-in.png b/acquire-zoom-in.png deleted file mode 100644 index e209a92..0000000 Binary files a/acquire-zoom-in.png and /dev/null differ diff --git a/acquire-zoom-to-fit.png b/acquire-zoom-to-fit.png deleted file mode 100644 index 5a7b0f9..0000000 Binary files a/acquire-zoom-to-fit.png and /dev/null differ diff --git a/acquireimages.docbook b/acquireimages.docbook deleted file mode 100644 index 8dcaffc..0000000 --- a/acquireimages.docbook +++ /dev/null @@ -1,258 +0,0 @@ -<chapter id="acquireimages"> -<chapterinfo> - -<authorgroup> -<author> -<firstname>Kåre</firstname> -<surname>Särs</surname> -<affiliation> -<address><email>kare dot sars at iki dot fi</email></address> -</affiliation> -</author> -<author> -<firstname>Anne-Marie</firstname> -<surname>Mahfouf</surname> -<affiliation> -<address>&Anne-Marie.Mahfouf.mail;</address> -</affiliation> -</author> -</authorgroup> - -<abstract> -<para> -The Kipi acquire images plugin is a tool to scan images using a flat scanner. -</para> -</abstract> - -<keywordset> -<keyword>KDE</keyword> -<keyword>Kipi</keyword> -</keywordset> -</chapterinfo> - -<!-- This is a sligtly modified copy of skanlite documenatation without the settings section -Please keep both in sync - lueck 2012-07-24 - --> -<title>Acquire Images</title> - -<para>This plugin can be used to scan images using a flat scanner. -The plugin uses libksane, a &kde; interface for SANE library to control flat scanners.</para> -<para> -It can save images in all the formats supported by &kde;. For example the following formats: -<itemizedlist> -<listitem><para> -png (8 and 16 bits per color) -</para></listitem> -<listitem><para> -jpeg, jpg, jpeg 2000 -</para></listitem> -<listitem><para> -bmp -</para></listitem> -</itemizedlist> -</para> - -<note><para>You can check the status of your scanner support from the SANE project website by entering the information on this search page: <ulink url="http://www.sane-project.org/cgi-bin/driver.pl";>http://www.sane-project.org/cgi-bin/driver.pl</ulink>.</para></note> - -<sect1 id="scanner-selection"> -<title>Scanner Selection</title> -<para>If the selected scanner cannot be opened or if no default scanner is provided, a scanner selection dialog is opened. -</para> -<para> -The user can choose the scanner to be used and press <guibutton>OK</guibutton> to open the scanner. Pressing <guibutton>Cancel</guibutton> will cause the plugin to exit. -</para> - -<screenshot> - <screeninfo>No scanner found</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="acquire-no-scanner-found.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>No scanner found</phrase> - </textobject> - </mediaobject> -</screenshot> - -<para> -In case no devices were found, maybe because the scanner is not plugged in or -switched off, correct that. Then the <guibutton>Reload device list</guibutton> -can be used to reload the list of scanners.</para> -<note><para>Not all drivers/backends support this feature. In that case quit the plugin, -connect your scanner and restart the application.</para> -</note> - -</sect1> - -<sect1 id="main-window"> -<title>Main Window</title> -<screenshot> - <screeninfo>Main window</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="acquire-main-window.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Main window</phrase> - </textobject> - </mediaobject> -</screenshot> - -<para> -In the main window, the user has two sets of scan options: <guilabel>Basic Options</guilabel> and <guilabel>Scanner Specific Options</guilabel>. The <guilabel>Basic Options</guilabel> tab contains the most common parameters that the SANE scanner backends provide, while the <guilabel>Scanner Specific Options</guilabel> tab contains all the options of the backend. The options listed here depend on SANE support for your driver: libksane (which the plugin uses) should be able to display most of the types of parameters that SANE provides (analog gamma tables are not supported at this time). -</para> - -<screenshot> - <screeninfo>Scanner Specific Options tab</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="acquire-other-options.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Scanner Specific Options tab</phrase> - </textobject> - </mediaobject> -</screenshot> - -<para> -The scanner specific options contains more detailed options of the backends. The plugin does not have any special handling for these options. -</para> - -<para>If you are satisfied with your settings, you can use the little arrow on the top of the options splitter. -When clicked it collapses or expands the options. The collapser can overlap the preview area, but fades -away when the mouse cursor moves out of the collapser.</para> -</sect1> - -<sect1 id="scanning"> -<title>Scanning</title> -<para> -To scan an image, the user can start with a preview scan and then select the part of the scan area to do the final scan on. The preview scan is started by pressing the preview button. -</para> - -<screenshot> - <screeninfo>The Preview Button</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="acquire-preview-button.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>The Preview Button</phrase> - </textobject> - </mediaobject> -</screenshot> - -<para> -When the preview is scanned the area for the final image can be selected. -</para> -<screenshot> - <screeninfo>Selection and zoom</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="acquire-zoom-in.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Selection and zoom</phrase> - </textobject> - </mediaobject> -</screenshot> -<para> -To better select the image the user can zoom in, out, to the current selection or zoom to fit the whole preview to the window. -</para> -<screenshot> - <screeninfo>The "zoom to fit" button</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="acquire-zoom-to-fit.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>The "zoom to fit" button</phrase> - </textobject> - </mediaobject> -</screenshot> - -<para> -When the image is selected the final image can be acquired by pressing the final scan button. -</para> - -<screenshot> - <screeninfo>The final scan button</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="acquire-final-button.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>The final scan button</phrase> - </textobject> - </mediaobject> -</screenshot> - -<para> -You will see the progress of the scan. -</para> -<screenshot> - <screeninfo>Scanning in progress</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="acquire-scanning.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Scanning in progress</phrase> - </textobject> - </mediaobject> -</screenshot> -</sect1> - -<sect1 id="scanning-multiple-selections"> -<title>Scanning Multiple Selections</title> -<para> -Sometimes you need only certain parts of an image. -Instead of scanning the whole picture and then using a graphics -application (⪚ &kolourpaint;) to save the different image parts into separate -files, use the plugins multiple selection feature. -</para> -<screenshot> - <screeninfo>Multiple Selections</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="acquire-multiple-selections.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Multiple Selections</phrase> - </textobject> - </mediaobject> -</screenshot> -<para>Scan a preview and then use the &LMB; to select the first part of the image in the preview. -Hover the selected area with mouse cursor and click on the green <guiicon>+</guiicon> icon -to select the area. Selected areas are indicated by a red border. -Now select the next parts of the image in the same way.</para> -<para>To remove a single selection hover the area with the mouse cursor and click on the red -<guiicon>-</guiicon> icon. With <guilabel>Clear Selections</guilabel> from the context menu launched with the -&RMB; all selections in a preview can be removed. -</para> -<para>If you placed two separate images or photos on you scanner and started a preview -the plugin automatically preselect the different areas. -</para> -<para>If you are satisfied with your choice starting the final batch scan of all selections. -The selected parts of the image are scanned and saved separately into different files. -</para> -</sect1> - -<sect1 id="help"> -<title>Help and Close</title> -<para> -At the bottom of the main window you find the <guibutton>Help</guibutton> and <guibutton>Close</guibutton> buttons.</para> - -<para>The <guibutton>Help</guibutton> button brings up the menu described in the section -<ulink url="help:/fundamentals/ui.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals. -The <guibutton>Close</guibutton> button is used to exit the plugin.</para> -</sect1> - -</chapter> - -<!-- -Local Variables: -mode: sgml -sgml-omittag: nil -sgml-shorttag: t -End: ---> diff --git a/index.docbook b/index.docbook index 45f6406..abb7313 100644 --- a/index.docbook +++ b/index.docbook @@ -4,7 +4,6 @@ <!ENTITY package "extragear-graphics"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE" > <!-- change language only here --> - <!ENTITY doc-acquireimages SYSTEM "acquireimages.docbook"> <!ENTITY doc-colorimages SYSTEM "colorimages.docbook"> <!ENTITY doc-convertimages SYSTEM "convertimages.docbook"> <!ENTITY doc-effectimages SYSTEM "effectimages.docbook"> @@ -29,39 +28,23 @@ <bookinfo> <title>The Kipi Plugins Handbook</title> -<authorgroup> - <author> - <firstname>Gilles</firstname><surname>Caulier</surname> - <affiliation><address><email>caulier dot gilles at gmail dot com</email></address></affiliation> - </author> - - <author> - <firstname>Gerhard</firstname><surname>Kulzer</surname> - <affiliation><address><email>gerhard_at_kulzer.net</email></address></affiliation> - </author> - -<!-- TRANS:ROLES_OF_TRANSLATORS --> - -</authorgroup> - -<date>2008-02-13</date> -<releaseinfo>0.1.3</releaseinfo> <!-- Used Kicker version here --> +<date>2016-08-21</date> +<releaseinfo>5.0</releaseinfo> <!-- Used Kicker version here --> <copyright> -<year>2004-2008</year> -<holder>The Kipi developers team</holder> +<year>2001-2016</year> +<holder>The digiKam developers team</holder> </copyright> <legalnotice id="legalnotice">&FDLNotice;</legalnotice> <abstract> <para> -This is the handbook for the plugins of Kipi, the &kde; Image Plugins Interface. +This is the handbook for the plugins of Kipi project. </para> </abstract> <keywordset> -<keyword>KDE</keyword> <keyword>Kipi</keyword> <keyword>Plugins</keyword> </keywordset> @@ -72,10 +55,9 @@ This is the handbook for the plugins of Kipi, the &kde; Image Plugins Interface. <title>Introduction to Kipi Plugins</title> <para> -One of the nicest things about &kde; photo management programs like &digikam;, -<application>KPhotoAlbum</application>, <application>Gwenview</application> and -<application>ShowImg</application> is how easily their functionality can be -extended, by using plugins. The Kde Image Plugins Interface (KIPI) project can +One of the nicest things about &digikam; photo management programs, +is how easily their functionality can be +extended, by using plugins. The KIPI project can manipulate image files in almost any way that users can. Their advantage is that it is much easier to add capabiltiies to the host application by writing a small plugin rather than by modifying the host application's core. Many valuable plugins @@ -83,7 +65,7 @@ have C++ source code that only amounts to 100-200 lines or so. </para> <para> -Kipi plugins are additional functions for the &kde; Image Managment Host Programs. +Kipi plugins are additional functions for &digikam; Host Programs. They can add extra menus and shortcuts, and extend the host program's features. You can install as many or as few as you like, from within host programs. </para> @@ -99,12 +81,6 @@ The plugins available in this handbook are: <itemizedlist> <listitem> -<para><link linkend="acquireimages">Acquire Images plugin</link></para> -</listitem> -<listitem> -<para>The Calendar plugin is a tool to create calendar from image collections</para> -</listitem> -<listitem> <para><link linkend="colorimages">Color Images plugin</link></para> </listitem> <listitem> @@ -117,16 +93,9 @@ The plugins available in this handbook are: <para><link linkend="filterimages">Filter Images plugin</link></para> </listitem> <listitem> -<para>The Find Duplicate Images plugin is a tool for find duplicate -photograph on your image collections</para> -</listitem> -<listitem> <para><link linkend="flickrexport">Remote Flickr Export plugin</link></para> </listitem> <listitem> -<para>The Gallery Export plugin is a tool for export image collections to a remote Gallery server</para> -</listitem> -<listitem> <para><link linkend="geolocation">Geolocation plugin</link></para> </listitem> <listitem> @@ -162,9 +131,6 @@ photograph on your image collections</para> <listitem> <para><link linkend="slideshow">Slide Show plugin</link></para> </listitem> -<listitem> -<para>The Time Adjust plugin is a tool for adjusting image files timestamp</para> -</listitem> </itemizedlist> <para id="missing-plugin-docs"> @@ -175,7 +141,6 @@ please contact the Kipi team mailing list at <email>[email protected]</email>. </chapter> -&doc-acquireimages; &doc-colorimages; &doc-convertimages; &doc-effectimages; @@ -193,9 +158,6 @@ please contact the Kipi team mailing list at <email>[email protected]</email>. &doc-resizeimages; &doc-sendimages; &doc-slideshow; -<!--disabled due to lack of dbus command - http://lists.kde.org/?l=kde-imaging&m=131279555904019&w=2 -&doc-wallpaper;--> <chapter id="credits"> <title>Credits and License</title>
