[kde-doc-english] [skanlite] doc: Update the documentation to reflect the current situation

Kåre Särs kare.sars at iki.fi
Fri Feb 8 20:13:52 UTC 2013


Git commit 1be46fd8f9ddf7c7085a1fa45eec07fd7136f5d5 by Kåre Särs.
Committed on 08/02/2013 at 21:11.
Pushed by sars into branch 'master'.

Update the documentation to reflect the current situation

M  +-    --    doc/choose-scanner.png
M  +37   -19   doc/index.docbook
M  +-    --    doc/main-window.png
A  +-    --    doc/save-location.png

http://commits.kde.org/skanlite/1be46fd8f9ddf7c7085a1fa45eec07fd7136f5d5

diff --git a/doc/choose-scanner.png b/doc/choose-scanner.png
index 264fed2..9f12d36 100644
Binary files a/doc/choose-scanner.png and b/doc/choose-scanner.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 41faa2e..4596db4 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -31,7 +31,7 @@
 </authorgroup>
 
 <copyright>
-<year>2008</year>
+<year>2008, 2013</year>
 <holder>Kåre Särs</holder>
 </copyright>
 <copyright>
@@ -41,8 +41,8 @@
 
 <legalnotice>&FDLNotice;</legalnotice>
 
-<date>2011-11-29</date>
-<releaseinfo>0.8</releaseinfo>
+<date>2013-02-08</date>
+<releaseinfo>1.0</releaseinfo>
 
 <abstract>
 <para>
@@ -303,15 +303,15 @@ By clicking the <guibutton>Settings</guibutton> button, the settings dialog is b
 </para>
 
 <screenshot>
-     <screeninfo>Here's a screenshot of &skanlite; settings dialog</screeninfo>
-	<mediaobject>
-	  <imageobject>
-	    <imagedata fileref="settings.png" format="PNG"/>
-	  </imageobject>
-	    <textobject>
-	    <phrase>&skanlite; settings dialog</phrase>
-	  </textobject>
-	</mediaobject>
+    <screeninfo>Here's a screenshot of &skanlite; settings dialog</screeninfo>
+    <mediaobject>
+        <imageobject>
+            <imagedata fileref="settings.png" format="PNG"/>
+        </imageobject>
+        <textobject>
+            <phrase>&skanlite; settings dialog</phrase>
+        </textobject>
+    </mediaobject>
 </screenshot>
 
 <para><variablelist>
@@ -322,26 +322,44 @@ By clicking the <guibutton>Settings</guibutton> button, the settings dialog is b
 </varlistentry>
 <varlistentry>
 <term><guilabel>Save Mode:</guilabel></term>
-<listitem><para> This setting allows you to choose how &skanlite; will save the images. If you choose <guilabel>Open the save dialog for every image</guilabel> then the save dialog will be opened for every scanned image. If you prefer &skanlite; to auto-save (by auto-generating a name and saving the image in a predefined folder) then you can choose <guilabel>Save without asking for a filename</guilabel> 
-or <guilabel>Open the save dialog for the first image only</guilabel>.
-</para></listitem>
+<listitem>
+<para> This setting allows you to choose how &skanlite; will save the images. If you choose <guilabel>Open the save dialog for every image</guilabel> the save dialog will be opened for every scanned image. If you prefer &skanlite; to auto-save (by auto-generating a name and saving the image in a predefined folder) you can choose <guilabel>Open the save dialog for the first image only</guilabel>. This option will open the following "Save Location" dialog for the first scanned image.</para>
+<para>
+    <screenshot>
+        <screeninfo>Here's a screenshot of &skanlite; save location dialog</screeninfo>
+        <mediaobject>
+            <imageobject>
+                <imagedata fileref="save-location.png" format="PNG"/>
+            </imageobject>
+            <textobject>
+                <phrase>&skanlite; Save Location dialog.</phrase>
+            </textobject>
+        </mediaobject>
+    </screenshot>
+</para>
+</listitem>
 </varlistentry>
+
 <varlistentry>
 <term><guilabel>Save Location:</guilabel></term>
-<listitem><para> This setting defines where the images should be saved when <guilabel>Save without asking for a filename</guilabel> is chosen in the previous option. If the save dialog is to be opened for every image the default save location for the dialog will be the same as this parameter. The default save location is your home folder and you can change this location by clicking on the <guibutton>...</guibutton> button.
-</para></listitem>
+<listitem><para> This setting defines the default save location and file naming. The default save location is your home folder and you can change this location by clicking on the <guibutton>...</guibutton> button.
+</para>
+</listitem>
 </varlistentry>
 
 <varlistentry>
 <term><guilabel>Name Format:</guilabel></term>
 <listitem><para> This parameter defines the image prefix for the auto-saved images and is also the suggested name for the image in the save dialog. The auto-saved image will have a numeric suffix (the ### will be replaced by numbers) that is increased every time an image is saved.
-</para><para>You can also choose the save format of the file, default is png.</para></listitem>
+</para><para>You can also choose the save format of the file, default is png.</para>
+</listitem>
 </varlistentry>
+
 <varlistentry>
 <term><guilabel>Specify save quality:</guilabel></term>
 <listitem><para>The user can chose to specify the image quality to be used for saving the images. The image quality setting affects the compression level used for saving. If <guilabel>Specify save quality</guilabel> is not checked, the quality is the default value chosen by &Qt;.
 </para></listitem>
 </varlistentry>
+
 <varlistentry>
 <term><guilabel>Set preview resolution (DPI)</guilabel></term>
 <listitem><para>&skanlite; is using heuristics to try to get a sane resolution, 
@@ -352,7 +370,7 @@ resolution can be manually set with this option.
 <varlistentry>
 <term><guilabel>Disable automatic selections</guilabel></term>
 <listitem><para>By default automatic selections are enabled; and after a preview, 
-libksane does try to automatically select the images in the preview and should 
+libksane does try to automatically select the images in the preview and should
 batch scan the selected areas. ⪚ if you place two photos 
 on the scanner and do a preview, &skanlite; will automatically add 
 selections of the photos.</para>
diff --git a/doc/main-window.png b/doc/main-window.png
index f4b4f39..b7d0c85 100644
Binary files a/doc/main-window.png and b/doc/main-window.png differ
diff --git a/doc/save-location.png b/doc/save-location.png
new file mode 100644
index 0000000..7e1f020
Binary files /dev/null and b/doc/save-location.png differ


More information about the kde-doc-english mailing list