[digikam-doc] digikam: move acquire images tool to digiKam and cleanup
Gilles Caulier
caulier.gilles at gmail.com
Mon Aug 22 11:34:09 UTC 2016
Git commit 352b0b934cf46845a2c0d0fb5e744bebce1fcd5f by Gilles Caulier.
Committed on 22/08/2016 at 11:33.
Pushed by cgilles into branch 'master'.
move acquire images tool to digiKam and cleanup
A +- -- digikam/acquire-final-button.png
A +- -- digikam/acquire-main-window.png
A +- -- digikam/acquire-multiple-selections.png
A +- -- digikam/acquire-no-scanner-found.png
A +- -- digikam/acquire-other-options.png
A +- -- digikam/acquire-preview-button.png
A +- -- digikam/acquire-scanning.png
A +- -- digikam/acquire-zoom-in.png
A +- -- digikam/acquire-zoom-to-fit.png
M +10 -0 digikam/credits-annex.docbook
M +21 -13 digikam/index.docbook
M +0 -1 digikam/photo-editing.docbook
A +240 -0 digikam/tool-acquireimages.docbook
http://commits.kde.org/digikam-doc/352b0b934cf46845a2c0d0fb5e744bebce1fcd5f
diff --git a/digikam/acquire-final-button.png b/digikam/acquire-final-button.png
new file mode 100644
index 0000000..179755b
Binary files /dev/null and b/digikam/acquire-final-button.png differ
diff --git a/digikam/acquire-main-window.png b/digikam/acquire-main-window.png
new file mode 100644
index 0000000..d2ba51e
Binary files /dev/null and b/digikam/acquire-main-window.png differ
diff --git a/digikam/acquire-multiple-selections.png b/digikam/acquire-multiple-selections.png
new file mode 100644
index 0000000..4e2117e
Binary files /dev/null and b/digikam/acquire-multiple-selections.png differ
diff --git a/digikam/acquire-no-scanner-found.png b/digikam/acquire-no-scanner-found.png
new file mode 100644
index 0000000..3727670
Binary files /dev/null and b/digikam/acquire-no-scanner-found.png differ
diff --git a/digikam/acquire-other-options.png b/digikam/acquire-other-options.png
new file mode 100644
index 0000000..e07a4f5
Binary files /dev/null and b/digikam/acquire-other-options.png differ
diff --git a/digikam/acquire-preview-button.png b/digikam/acquire-preview-button.png
new file mode 100644
index 0000000..39c7f4b
Binary files /dev/null and b/digikam/acquire-preview-button.png differ
diff --git a/digikam/acquire-scanning.png b/digikam/acquire-scanning.png
new file mode 100644
index 0000000..4418d6a
Binary files /dev/null and b/digikam/acquire-scanning.png differ
diff --git a/digikam/acquire-zoom-in.png b/digikam/acquire-zoom-in.png
new file mode 100644
index 0000000..e209a92
Binary files /dev/null and b/digikam/acquire-zoom-in.png differ
diff --git a/digikam/acquire-zoom-to-fit.png b/digikam/acquire-zoom-to-fit.png
new file mode 100644
index 0000000..5a7b0f9
Binary files /dev/null and b/digikam/acquire-zoom-to-fit.png differ
diff --git a/digikam/credits-annex.docbook b/digikam/credits-annex.docbook
index 9f99df9..345373b 100644
--- a/digikam/credits-annex.docbook
+++ b/digikam/credits-annex.docbook
@@ -53,6 +53,16 @@ Documentation copyrighted by:
<listitem>
<para>
+ 2007
+ <itemizedlist>
+ <listitem><para>Kåre Särs <email>kare dot sars at iki dot fi</email></para></listitem>
+ <listitem><para>Anne-Marie Mahfouf <email>&Anne-Marie.Mahfouf.mail;</email></para></listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
2003-2010
Gerhard Kulzer <email>gerhard_at_kulzer_dot_net</email>
</para>
diff --git a/digikam/index.docbook b/digikam/index.docbook
index 9128611..a96d3af 100644
--- a/digikam/index.docbook
+++ b/digikam/index.docbook
@@ -7,20 +7,22 @@
<!ENTITY digikam '<application>digiKam</application>'>
<!-- relative path to snapshots for digikam and showfoto -->
<!ENTITY path "">
- <!ENTITY doc-file-formats SYSTEM "file-formats.docbook">
- <!ENTITY doc-sidebar SYSTEM "sidebar.docbook">
+ <!ENTITY doc-file-formats SYSTEM "file-formats.docbook">
+ <!ENTITY doc-sidebar SYSTEM "sidebar.docbook">
<!-- image editor -->
- <!ENTITY doc-photo-editing SYSTEM "photo-editing.docbook">
- <!ENTITY doc-editor-color SYSTEM "editor-color.docbook">
- <!ENTITY doc-editor-enhance SYSTEM "editor-enhance.docbook">
- <!ENTITY doc-editor-transform SYSTEM "editor-transform.docbook">
- <!ENTITY doc-editor-filters SYSTEM "editor-filters.docbook">
- <!ENTITY doc-editor-decorate SYSTEM "editor-decorate.docbook">
- <!ENTITY doc-color-management SYSTEM "color-management.docbook">
+ <!ENTITY doc-photo-editing SYSTEM "photo-editing.docbook">
+ <!ENTITY doc-editor-color SYSTEM "editor-color.docbook">
+ <!ENTITY doc-editor-enhance SYSTEM "editor-enhance.docbook">
+ <!ENTITY doc-editor-transform SYSTEM "editor-transform.docbook">
+ <!ENTITY doc-editor-filters SYSTEM "editor-filters.docbook">
+ <!ENTITY doc-editor-decorate SYSTEM "editor-decorate.docbook">
+ <!ENTITY doc-color-management SYSTEM "color-management.docbook">
+<!-- tools -->
+ <!ENTITY doc-tool-acquireimages SYSTEM "tool-acquireimages.docbook">
<!-- menus -->
- <!ENTITY doc-menu-descriptions SYSTEM "menu-descriptions.docbook">
- <!ENTITY doc-ie-menu SYSTEM "ie-menu.docbook">
- <!ENTITY doc-credits-annexes SYSTEM "credits-annex.docbook">
+ <!ENTITY doc-menu-descriptions SYSTEM "menu-descriptions.docbook">
+ <!ENTITY doc-ie-menu SYSTEM "ie-menu.docbook">
+ <!ENTITY doc-credits-annexes SYSTEM "credits-annex.docbook">
<!-- Do not define any other entities; instead, use the entities
from kde-genent.entities and $LANG/user.entities. -->
@@ -462,7 +464,7 @@
<orderedlist>
- <listitem><para> Go one view backwards in the main window view history (Alt+Left)</para> </listitem>
+ <listitem><para>Go one view backwards in the main window view history (Alt+Left)</para> </listitem>
<listitem><para>Go one view forwards in the main window view history (Alt+Right)</para> </listitem>
@@ -2381,7 +2383,13 @@ Fun stuff
</chapter>
+<!-- ******** MISC TOOLS *************************************************** -->
+
+&doc-tool-acquireimages;
+
+
<!-- *********************************************************************** -->
+
&doc-menu-descriptions;
<!-- *********************************************************************** -->
diff --git a/digikam/photo-editing.docbook b/digikam/photo-editing.docbook
index 0370b3f..ac4ea54 100644
--- a/digikam/photo-editing.docbook
+++ b/digikam/photo-editing.docbook
@@ -195,4 +195,3 @@
&doc-editor-filters;
</sect1>
-
diff --git a/digikam/tool-acquireimages.docbook b/digikam/tool-acquireimages.docbook
new file mode 100644
index 0000000..93d1f30
--- /dev/null
+++ b/digikam/tool-acquireimages.docbook
@@ -0,0 +1,240 @@
+<chapter id="tool-acquireimages">
+<chapterinfo>
+
+<abstract>
+<para>
+The Acquire Images tool is dedicated to scan images using a flat scanner.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>Flat scanner</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 tool can be used to scan images using a flat scanner.
+The tool uses libksane, an interface for SANE library to control flat scanners.</para>
+<para>
+It can save images in all main image containers, as 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>
+tiff
+</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 tool 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 tool,
+connect your scanner and restart the application.</para>
+</note>
+
+</sect1>
+
+<sect1 id="main-dialog">
+<title>Main Dialog</title>
+<screenshot>
+ <screeninfo>Main dialog</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="acquire-main-dialog.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Main dialog</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 tool 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 tool 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 tool 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 tool 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>.
+The <guibutton>Close</guibutton> button is used to exit the tool.</para>
+</sect1>
+
+</chapter>
+
+<!--
+Local Variables:
+mode: sgml
+sgml-omittag: nil
+sgml-shorttag: t
+End:
+-->
More information about the kde-doc-english
mailing list