[digikam-doc] digikam: first pass to fix and improve intro-database docbook syntax
Gilles Caulier
caulier.gilles at gmail.com
Tue Aug 30 04:46:24 UTC 2016
Git commit 2d592b8cc4b99bc4358c72ce43bef6b94fa23b7b by Gilles Caulier.
Committed on 30/08/2016 at 04:45.
Pushed by cgilles into branch 'master'.
first pass to fix and improve intro-database docbook syntax
M +5 -5 digikam/editor-decorate-texture.docbook
M +127 -67 digikam/intro-database.docbook
M +2 -2 digikam/using-dam-build.docbook
http://commits.kde.org/digikam-doc/2d592b8cc4b99bc4358c72ce43bef6b94fa23b7b
diff --git a/digikam/editor-decorate-texture.docbook b/digikam/editor-decorate-texture.docbook
index ad9383d..9b6eae8 100644
--- a/digikam/editor-decorate-texture.docbook
+++ b/digikam/editor-decorate-texture.docbook
@@ -6,7 +6,7 @@
<abstract>
<para>
- The &digikam; <emphasis>Apply Texture</emphasis> is a tool for applying decorative textures to an image.
+ The &digikam; <emphasis>Apply Texture</emphasis> is a tool for applying decorative textures to an image.
</para>
</abstract>
@@ -27,15 +27,15 @@
</para>
<para>
- Two options give you control over the texture applying on image:
+ Two options give you control over the texture applying on image:
</para>
<para>
- <guilabel>Type</guilabel>: this option specifies the decorative texture style to apply under the image.
+ <guilabel>Type</guilabel>: this option specifies the decorative texture style to apply under the image.
</para>
<para>
- <guilabel>Relief</guilabel>: dragging this option to the right increases the appearance of depth or three-dimensionality of the texture on image.
+ <guilabel>Relief</guilabel>: dragging this option to the right increases the appearance of depth or three-dimensionality of the texture on image.
</para>
</sect4>
@@ -43,7 +43,7 @@
<sect4 id="inaction-texture"> <title>The Texture tool in action</title>
<para>
- A <guilabel>Paper</guilabel> texture effect apply to a photograph is available below. The original image is (1), the target image is (2). <guilabel>Relief</guilabel> factor used is 200.
+ A <guilabel>Paper</guilabel> texture effect apply to a photograph is available below. The original image is (1), the target image is (2). <guilabel>Relief</guilabel> factor used is 200.
</para>
<para><inlinemediaobject><imageobject>
diff --git a/digikam/intro-database.docbook b/digikam/intro-database.docbook
index 03c63fd..e695c29 100644
--- a/digikam/intro-database.docbook
+++ b/digikam/intro-database.docbook
@@ -1,70 +1,130 @@
-<sect1 id="intro-database"> <title>The &digikam; Database</title>
-
- <para>
- The DigiKam actually manages more than one databases. For convenience, it is broadly categorized in three:</para><para>
- 1)Core database for all collection properties, i.e it hosts all albums, images and searches data.</para><para>
- 2)Thumbnails database for compressed thumbnails i.e. to host image thumbs with wavelets compression images.</para><para>
- 3)Face database for storing face recognition metadata i.e. to host face histogram for faces recognition.</para><para>
- Currently, digiKam uses either SQLite or MySQL databases for storing data. (PostgreSQL support is planned for future).
- </para>
-
- <para>
- SQLITE</para>
-
- <para>
-
- By default, digiKam uses SQLite as its back-end for storing important metadata and thumbnails. Two SQLite databases used for storing them are digikam4.db and thumbnails.db respectively.
-
- To make your application run fast and smoothly, it is recommended to check and optimize your databases once in awhile. This could be achieved using sqlite3 packages or sqlite browser (high quality, easy to use visual tool for managing database objects).
- For Ubuntu and its derivatives, it could be retrieved using sudo apt-get install sqlite3 or sudo apt-get install sqlitebrowser. Now all remains is to open the terminal, switch to the directory where databases and stored, and voila!
-
- Note: Take care to use a place hosted by fast hardware (such as SSD) with enough free space especially for thumbnails database. A remote file system such as NFS cannot be used here. For performance reasons, it recommended to avoid removable media.
- </para>
-
- <para>
- MYSQL</para>
-
- <para>
- DigiKam also provides support for popular MySQL database engine.Of course, you might wonder why you’d want to switch to MySQL when SQLite already does a good job of managing the data? Using MySQL as digiKam’s database back-end allows you to store the data on a remote server. This way, you can use multiple digiKam installations (e.g. On your notebook and PC) to access and manage your photo collections. You can also use MySQL tools to backup and analyze digiKam’s data.
-
- Obviously, to use DigiKam with MySQL, you would require a MySQL server. Or, you could also install MariaDB, which serves the purpose well.(Could be installed easily using this <ulink url="http://www.liquidweb.com/kb/how-to-install-mariadb-5-5-on-ubuntu-14-04-lts/">link</ulink>.
-
- To switch from SQLite to MySQL database, go to Settings | Configure DigiKam and then under Settings section, select a database from the drop down list.
-
- 1)MySQL Internal - This allows to run an internal database server on your system. DigiKam uses Unix socket for the connection.
- 2)MySQL Remote - Use this if you’ve your data on remote server and and you’re on a different machine trying to access the collection.
-
- </para>
-
- <para>
- Database Remote Server Instructions</para>
-
- <para>
- Follow the instructions below, if you don’t have a dedicated user account and a digiKam DB already set up. Run the commands in MySQL server (after replacing password with correct one) : </para><para>
-
- 1)CREATE USER ''@'%' IDENTIFIED BY 'password';</para><para>
- 2)GRANT ALL ON *.* TO ''@'%' IDENTIFIED BY 'password';</para><para>
- 3)CREATE DATABASE digikam;</para><para>
- 4)GRANT ALL PRIVILEGES ON digikam.* TO ''@'%';</para><para>
- 5)FLUSH PRIVILEGES;</para><para>
-
- Note: If you have an enormous collection, you should start the MySQL server with “mysql --max_allowed_packet = 128M”</para><para>
-
- Now, in digiKam, go to Settings | Configure DigiKam and then under Settings section, select “MySQL Server” from the drop down list.
- </para>
-
- <para>
- <inlinemediaobject><imageobject>
- <imagedata fileref="&path;intro-database-instructions.png" format="PNG" /></imageobject>
- </inlinemediaobject>
- </para>
-
- <para>
- Enter the IP address of your MySQL server in the Host Name field and specify the correct port in the Port field (the default port is 3306). In the Schema Name field, enter the name of the database for storing photo metadata, and specify the name of the database for storing thumbnails in the Thumbnails Schema Name field. Enter your MySQL username and password in the appropriate fields. To check whether the database connection works properly, press the Check DB Connection button. If everything works as it’s supposed to, switch to the Collections sections, and add the directories containing your photos. Hit OK, and wait till digiKam populates the databases with data from photos. This can take a while if you have a lot of photos.
-
- </para>
-
- </sect1>
+<sect1 id="intro-database">
+ <title>The &digikam; Database</title>
+
+ <sect2 id="intro-database-intro">
+ <title>Introduction</title>
+
+ <para>
+ The &digikam; actually manages more than one databases. For convenience, it is broadly categorized in three:
+
+ <orderedlist>
+
+ <listitem><para>
+ Core database for all collection properties, i.e it hosts all albums, images and searches data.
+ </para></listitem>
+
+ <listitem><para>
+ Thumbnails database for compressed thumbnails i.e. to host image thumbs with wavelets compression images.
+ </para></listitem>
+
+ <listitem><para>
+ Face database for storing face recognition metadata i.e. to host face histogram for faces recognition.
+ </para></listitem>
+
+ </orderedlist>
+
+ </para>
+
+ </sect2>
+
+ <sect2 id="intro-database-sqlite">
+ <title>The Sqlite Database</title>
+
+ <para>
+ By default, &digikam; uses SQLite as its back-end for storing important metadata and thumbnails. Tree SQLite files used for storing them are digikam4.db, thumbnails-digikam.db, and recognition.db respectively.
+ </para>
+
+ <para>
+ To make your application run fast and smoothly, it is recommended to check and optimize your databases once in awhile. This could be achieved using sqlite3 packages or sqlite browser (high quality, easy to use visual tool for managing database objects). For Ubuntu and its derivatives, it could be retrieved using sudo apt-get install sqlite3 or sudo apt-get install sqlitebrowser. Now all remains is to open the terminal, switch to the directory where databases and stored, and voila!
+ </para>
+
+ <note><para>
+ Take care to use a place hosted by fast hardware (such as SSD) with enough free space especially for thumbnails database. A remote file system such as NFS cannot be used here. For performance reasons, it recommended to avoid removable media.
+ </para></note>
+
+ </sect2>
+
+ <sect2 id="intro-database-mysql">
+ <title>The MySQL Database</title>
+
+ <sect3>
+ <title>MySQL Versus QSlite</title>
+
+ <para>
+ &digikam; also provides support for popular MySQL database engine. Of course, you might wonder why you’d want to switch to MySQL when SQLite already does a good job of managing the data? Using MySQL as &digikam;’s database back-end allows you to store the data on a remote server. This way, you can use multiple &digikam; installations (e.g. On your notebook and PC) to access and manage your photo collections. You can also use MySQL tools to backup and analyze &digikam;’s data.
+ </para>
+
+ <para>
+
+ To switch from SQLite to MySQL database, go to <guimenu>Settings</guimenu><guimenuitem>Configure &digikam;</guimenuitem> and then under <guilabel>Settings</guilabel> section, select a database from the drop down list.
+
+ <orderedlist>
+
+ <listitem><para>
+ MySQL Internal: This allows to run an internal database server on your system. DigiKam uses Unix socket for the connection.
+ </para></listitem>
+
+ <listitem><para>
+ MySQL Remote: Use this if you’ve your data on remote server and and you’re on a different machine trying to access the collection.
+ </para></listitem>
+
+ </orderedlist>
+
+ </para>
+
+ </sect3>
+
+ <sect3>
+ <title>The MySQL Internal Server</title>
+
+ <para>
+ TODO
+ </para>
+
+ </sect3>
+
+ <sect3>
+ <title>The MySQL Remote Server</title>
+
+ <para>
+ Obviously, to use &digikam; with a remote MySQL, you would require a MySQL server. Or, you could also install MariaDB, which serves the purpose well.(Could be installed easily using this <ulink url="http://www.liquidweb.com/kb/how-to-install-mariadb-5-5-on-ubuntu-14-04-lts/">link</ulink>.
+ </para>
+
+ <para>
+ Follow the instructions below, if you don’t have a dedicated user account and a &digikam; database already set up. Run the commands in MySQL server (after replacing password with correct one):
+ </para>
+
+ <blockquote><screen>
+ CREATE USER ''@'%' IDENTIFIED BY 'password';
+ GRANT ALL ON *.* TO ''@'%' IDENTIFIED BY 'password';
+ CREATE DATABASE digikam;
+ GRANT ALL PRIVILEGES ON digikam.* TO ''@'%';
+ FLUSH PRIVILEGES;
+ </screen></blockquote>
+
+ <note><para>
+ Note: If you have an enormous collection, you should start the MySQL server with “mysql --max_allowed_packet = 128M”
+ </para></note>
+
+ <para>
+ Now, in &digikam;, go to <guimenu>Settings</guimenu><guimenuitem>Configure &digikam;</guimenuitem> and then under <guilabel>Settings</guilabel> section, select <guilabel>MySQL Server</guilabel> from the drop down list.
+ </para>
+
+ <para>
+ <inlinemediaobject><imageobject>
+ <imagedata fileref="&path;intro-database-instructions.png" format="PNG" /></imageobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>
+ Enter the IP address of your MySQL server in the Host Name field and specify the correct port in the Port field (the default port is 3306). In the Schema Name field, enter the name of the database for storing photo metadata, and specify the name of the database for storing thumbnails in the Thumbnails Schema Name field. Enter your MySQL username and password in the appropriate fields. To check whether the database connection works properly, press the Check DB Connection button. If everything works as it’s supposed to, switch to the Collections sections, and add the directories containing your photos. Hit OK, and wait till digiKam populates the databases with data from photos. This can take a while if you have a lot of photos.
+ </para>
+
+ </sect3>
+
+ </sect2>
+
+</sect1>
<!--
Local Variables:
diff --git a/digikam/using-dam-build.docbook b/digikam/using-dam-build.docbook
index 8be762e..6bfecfc 100644
--- a/digikam/using-dam-build.docbook
+++ b/digikam/using-dam-build.docbook
@@ -18,11 +18,11 @@
<para>
&digikam; provides a number of methods to classify photographs: filenames, albums, collections, date + time, tags, rating, GPS position and captions. As if this was not enough, you can search many standard metadata items like camera model, lens, coordinates, image size and many more. Metadata categories as listed here are in fact different 'views' of your photo library. Combining these views is<emphasis> the </emphasis>very powerful method to narrow down the search for a file and to find it quickly. Imagine having 800 photos of your loved one. Searching for 'Mary', having more than '***' rating, shot in 'France' will surely leave you with very few candidates. In terms of selection criteria for a DAM system, &digikam; fares very well in terms of completeness, versatility, speed, scalability, accuracy and openness.
</para>
-
+
<para>
The key thing to remember is that you don't know how you or somebody else will try to find an image 2 years ahead of our time. You will remember past events in a different context, it's a fact of life. So if can narrow down your search by remembering place or time or camera or theme or rating or owner you stand an infinitely better chance to find it quickly than by just one of those criteria or none. At the beginning, at the time of taking a photograph, all metadata is in your head (except for the EXIF data). If you do not transcribe some of it into your DAM system, it will be lost eventually as much as every event fades into oblivion over time.
</para>
-
+
<para>
One distinction has to be interjected here between <command>private</command> and <command>public metadata</command>. One could say that all file-embedded attributes are potentially public since the images may be exported, sold, and copied to other places and people. On the other hand all non-embedded metadata in the database can be considered private as they stay in the database and go nowhere else. By adjusting &digikam;'s settings accordingly you can control what kind of data remains private and what will be embedded and eventually become public.
</para>
More information about the kde-doc-english
mailing list