[documentation/digikam-doc/sphinx] /: add batch queue section
Gilles Caulier
null at kde.org
Sun Dec 18 10:04:49 GMT 2022
Git commit e4a7873c20640fd8a1e75a6095c1365a609cb0b8 by Gilles Caulier.
Committed on 18/12/2022 at 10:04.
Pushed by cgilles into branch 'sphinx'.
add batch queue section
D +0 -100 attic/digikam/using-bqm.docbook
A +25 -0 batch_queue.rst
A +- -- batch_queue/images/using-raw-converter.png
A +42 -0 batch_queue/raw_converter.rst
M +4 -0 index.rst
https://invent.kde.org/documentation/digikam-doc/commit/e4a7873c20640fd8a1e75a6095c1365a609cb0b8
diff --git a/attic/digikam/using-bqm.docbook b/attic/digikam/using-bqm.docbook
deleted file mode 100644
index aa8ea5c..0000000
--- a/attic/digikam/using-bqm.docbook
+++ /dev/null
@@ -1,100 +0,0 @@
-<sect1 id="using-bqm"> <title>The &digikam; Batch Queue Manager</title>
-<anchor id="bqm.anchor"/>
-
- <sect2 id="bqm-mainwindow"> <title>The Batch Queue Manager Window</title>
-
- <para>
- TODO
- </para>
-
- </sect2>
-
- <sect2 id="bqm-rawworkflow"> <title>Batch RAW Workflow</title>
-
- <sect3><title>Introduction to Raw Converter</title>
-
- <para>
- With the Batch Queue Manager, you can import/convert your images stored in
- <emphasis>RAW format</emphasis> to a target formats as (<guilabel>JPEG</guilabel>,
- <guilabel>TIFF</guilabel>, or <guilabel>PNG</guilabel>).
- </para>
-
- <para>There are ome 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 of lesser quality than 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
- types of color filter data: RGBG, Red, Green, Blue and another Green mask for
- contrast enhancement. This tool can take this into account.
- </para>
-
- <para>
- The conversion is actually based on <command>libraw</command>. Don't expect to produce the same images
- as software provided by the camera vendor but sometimes libraw gives better results.
- </para>
-
- </sect3>
-
- <sect3 id="using-rawconverter"> <title>Using Raw Converter</title>
-
- <para>
- Select the RAW files to convert and load them to a dedicate batch queue.
- </para>
-
- <para>
- In Batch Queue Manager settings view, you can adjust the available check and value boxes
- to optimize the RAW 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 fine-tune
- the image later on.
- </para>
-
- <para>
- A <guilabel>Interpolate RGB as four colors</guilabel> conversion can be selected to use contrast
- information. (If your camera works in RGB mode, the RGBG setting has no effect).
- </para>
-
- <para>You must choose one output formats to save the conversion result by placing the
- target file format conversion tool. The file name will stay the same by default, only the extension changes.
- <guilabel>JPEG</guilabel> uses the lossy algorithm and produces the smallest output
- file size. In opposite the tagged image format (<guilabel>TIFF</guilabel>) preserves all information of
- your image while using lossless LZW compression.
- </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 before it deteriorates visibly.
- <guilabel>TIFF</guilabel> and <guilabel>PNG</guilabel> are better suited to keep
- the original data.
- </para></tip>
-
- <note><para>
- If you choose <guilabel>JPEG</guilabel>, or <guilabel>TIFF</guilabel>, or <guilabel>PNG</guilabel> as the <guilabel>Save Format</guilabel> then the metadata included in RAW file will be included in the target
- files as Exif information.
- </para></note>
-
- <para>
- When you have finished to setup the queue, click the <guibutton>Process</guibutton> button to start the
- conversion. If you want abort image conversion, press the <guibutton>Abort</guibutton>
- button.
- </para>
-
- <!-- TODO : add a screenshot of BQM RAW conversion in action -->
-
- </sect3>
-
- </sect2>
-
-</sect1>
-
-<!--
-Local Variables:
-mode: sgml
-sgml-omittag: nil
-sgml-shorttag: t
-End:
--->
diff --git a/batch_queue.rst b/batch_queue.rst
new file mode 100644
index 0000000..f87cba6
--- /dev/null
+++ b/batch_queue.rst
@@ -0,0 +1,25 @@
+.. meta::
+ :description: Using the digiKam batch queue manager
+ :keywords: digiKam, documentation, user manual, photo management, open source, free, help, learn
+
+.. metadata-placeholder
+
+ :authors: - Gilles Caulier <caulier dot gilles at gmail dot com>
+
+ :license: Creative Commons License SA 4.0
+
+.. _batch_queue:
+
+#######################
+The Batch Queue Manager
+#######################
+
+Using the digiKam batch queue manager
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+ :glob:
+
+ batch_queue/batchqueue_overview.rst
+ batch_queue/raw_converter.rst
diff --git a/batch_queue/images/using-raw-converter.png b/batch_queue/images/using-raw-converter.png
new file mode 100644
index 0000000..c5c8674
Binary files /dev/null and b/batch_queue/images/using-raw-converter.png differ
diff --git a/batch_queue/raw_converter.rst b/batch_queue/raw_converter.rst
new file mode 100644
index 0000000..13ed8cc
--- /dev/null
+++ b/batch_queue/raw_converter.rst
@@ -0,0 +1,42 @@
+.. meta::
+ :description: digiKam Raw Converter from Batch Queue Manager
+ :keywords: digiKam, documentation, user manual, photo management, open source, free, learn, easy
+
+.. metadata-placeholder
+
+ :authors: - Gilles Caulier <caulier dot gilles at gmail dot com>
+
+ :license: Creative Commons License SA 4.0
+
+.. _raw_converter:
+
+Raw Converter
+=============
+
+.. contents::
+
+With the Batch Queue Manager, you can import/convert your images stored in RAW format to a target formats as (JPEG, TIFF, or PNG).
+
+There are ome 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 of lesser quality than 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 types of color filter data: RGBG, Red, Green, Blue and another Green mask for contrast enhancement. This tool can take this into account.
+
+The conversion is actually based on libraw. Don't expect to produce the same images as software provided by the camera vendor but sometimes libraw gives better results.
+
+Select the RAW files to convert and load them to a dedicate batch queue.
+
+In Batch Queue Manager settings view, you can adjust the available check and value boxes to optimize the RAW 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 fine-tune the image later on.
+
+A Interpolate RGB as four colors conversion can be selected to use contrast information. (If your camera works in RGB mode, the RGBG setting has no effect).
+
+You must choose one output formats to save the conversion result by placing the target file format conversion tool. The file name will stay the same by default, only the extension changes. JPEG uses the lossy algorithm and produces the smallest output file size. In opposite the tagged image format (TIFF) preserves all information of your image while using lossless LZW compression.
+
+.. tip::
+
+ 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 JPEG format because it allows a limited number of operations before it deteriorates visibly. TIFF and PNG are better suited to keep the original data.
+
+.. note::
+
+ If you choose JPEG, or TIFF, or PNG as the Save Format then the metadata included in RAW file will be included in the target files as Exif information.
+
+When you have finished to setup the queue, click the Process button to start the conversion. If you want abort image conversion, press the Abort button.
+
+.. figure:: images/using-raw-converter.png
diff --git a/index.rst b/index.rst
index 5a11cd9..5414c40 100644
--- a/index.rst
+++ b/index.rst
@@ -185,6 +185,10 @@ The Batch Queue Manager
:ref:`batchqueue_overview`
+ .. container:: tile no-descr
+
+ :ref:`raw_converter`
+
.. toctree::
:maxdepth: 2
:hidden:
More information about the kde-doc-english
mailing list