[libgda] Documentation improvements

[Vivien Malerba <vivien src gnome org>]

commit 0cd1369c0b4816afae7bbc1925184643aa1fe015
Author: Vivien Malerba <malerba gnome-db org>
Date:   Thu Apr 15 21:38:31 2010 +0200

    Documentation improvements

 doc/C/GdaStatement.dia     |  Bin 0 -> 4131 bytes
 doc/C/GdaStatement.png     |  Bin 0 -> 74010 bytes
 doc/C/Makefile.am          |    2 +-
 doc/C/libgda-4.0-docs.sgml |   32 ++++++++++++++++++++-
 doc/C/packaging.xml        |   64 ++++++++++++++++++++++++++++++++++---------
 doc/C/packaging_ui.xml     |   58 +++++++++++++++++++++++++++++++--------
 6 files changed, 127 insertions(+), 29 deletions(-)
---
diff --git a/doc/C/GdaStatement.dia b/doc/C/GdaStatement.dia
new file mode 100644
index 0000000..b0c5014
Binary files /dev/null and b/doc/C/GdaStatement.dia differ
diff --git a/doc/C/GdaStatement.png b/doc/C/GdaStatement.png
new file mode 100644
index 0000000..8ccdf99
Binary files /dev/null and b/doc/C/GdaStatement.png differ
diff --git a/doc/C/Makefile.am b/doc/C/Makefile.am
index 5a982dc..f00f612 100644
--- a/doc/C/Makefile.am
+++ b/doc/C/Makefile.am
@@ -61,7 +61,7 @@ HTML_IMAGES = DataModels.png \
 	writable_data_model.png GdaDataModelIter.png \
 	data_validation_holder.png data_validation_proxy.png data_validation_set.png \
 	data_proxy1.png data_proxy2.png data_proxy3.png data_proxy4.png data_proxy5.png \
-	gda-sql-graph.png howto-exec.png \
+	gda-sql-graph.png howto-exec.png GdaStatement.png \
 	parser_gen.png parser_prov.png \
 	tree-overview.png tree-overview2.png \
 	SqlIdentifiers.png thread-wrapper.png \
diff --git a/doc/C/libgda-4.0-docs.sgml b/doc/C/libgda-4.0-docs.sgml
index 6442c5a..c463542 100644
--- a/doc/C/libgda-4.0-docs.sgml
+++ b/doc/C/libgda-4.0-docs.sgml
@@ -231,9 +231,9 @@
         </contrib>
       </author>
     </authorgroup>
-    <date>January 2009</date>
+    <date>April 2010</date>
     <copyright>
-      <year>1999 - 2009</year>
+      <year>1999 - 2010</year>
       <holder>The GNOME Foundation</holder>
     </copyright>
     <abstract>
@@ -631,6 +631,19 @@
 	       API will be added in the future.
 	   </para></listitem>
 	</itemizedlist>
+
+      <para>
+	The following schema illustrates how a statement is created and executed:
+	<mediaobject>
+	  <imageobject role="html">
+	    <imagedata fileref="GdaStatement.png" format="PNG"/>
+	  </imageobject>
+	  <textobject>
+	    <phrase>Statement execution illustrated</phrase>
+	  </textobject>
+	</mediaobject>
+      </para>
+
       </para>
       <para>
 	As each database implements its own SQL variant (all variants more or less close to the SQL92 or SQL99 standards), the
@@ -1543,6 +1556,21 @@ Description for type: DROP_COLUMN
 	</programlisting>
       </para>
     </chapter>
+
+    <chapter id="libgda-tools-controlcenter">
+      <title>Control center</title>
+      <para>
+	This tool is a graphical utility which allows the user to configure and test data sources (define DSN).
+      </para>
+    </chapter>
+
+    <chapter id="libgda-tools-gdabrowser">
+      <title>GdaBrowser</title>
+      <para>
+	This tool is a graphical utility which helps database administrators in their tasks.
+      </para>
+    </chapter>
+
   </part>
 
   <part id="part_libgda-reports">
diff --git a/doc/C/packaging.xml b/doc/C/packaging.xml
index 6bb632b..26e2d05 100644
--- a/doc/C/packaging.xml
+++ b/doc/C/packaging.xml
@@ -16,6 +16,10 @@
 	  </para>
 	</listitem>
 	<listitem>
+	  <para>the GObject introspection files (to be used by the GObject introspection framework)
+	  </para>
+	</listitem>
+	<listitem>
 	  <para>the tools, which require the runtime component
 	  </para>
 	</listitem>
@@ -93,21 +97,52 @@
   </sect1>
 
   <sect1>
+    <title>GObject introspection</title>
+    <para>
+      If GObject introspection has been compiled, &LIBGDA;'s introspection files are:
+      <programlisting>
+|-- share
+|   `-- gir-1.0
+|       `-- Gda-4.0.gir
+`-- lib
+    `-- girepository-1.0
+        `-- Gda-4.0.typelib
+      </programlisting>
+    </para>
+  </sect1>
+
+  <sect1>
     <title>Tools</title>
     <para>
       &LIBGDA;'s offers several tools, the most useful being an SQL console which allows one to issue SQL statement
       from the command line. This component has the following files:
-      <programlisting>
+    </para>
+    <sect2>
+      <title>Diagnostic tools</title>
+      <para>
+	The diagnostic tools are usefull to test connections. This component has the following files:
+	<programlisting>
+.
+`-- bin
+    |-- gda-list-config -> gda-list-config-4.0
+    |-- gda-list-config-4.0
+    |-- gda-list-jdbc-providers-4.0
+    |-- gda-list-server-op -> gda-list-server-op-4.0
+    |-- gda-list-server-op-4.0
+    `-- gda-test-connection-4.0
+      </programlisting>
+      </para>
+      <para>
+	This component should be made dependent on the runtime component.
+      </para>
+    </sect2>
+    <sect2>
+      <title>SQL console</title>
+      <para>
+	<programlisting>
 .
 |-- bin
-|   |-- gda-list-config -> gda-list-config-4.0
-|   |-- gda-list-config-4.0
-|   |-- gda-list-jdbc-providers-4.0
-|   |-- gda-list-server-op -> gda-list-server-op-4.0
-|   |-- gda-list-server-op-4.0
-|   |-- gda-sql -> gda-sql-4.0
-|   |-- gda-sql-4.0
-|   `-- gda-test-connection-4.0
+|   `-- gda-sql-4.0
  `-- share
     |   `-- web
     |       |-- cnc.js
@@ -123,11 +158,12 @@
         `-- man1
             |-- gda-sql-4.0.1
             `-- gda-sql.1 -> gda-sql-4.0.1
-      </programlisting>
-    </para>
-    <para>
-      This component should be made dependent on the runtime component.
-    </para>
+	</programlisting>
+      </para>
+      <para>
+	This component should be made dependent on the runtime component.
+      </para>
+    </sect2>
   </sect1>
 
   <sect1>
diff --git a/doc/C/packaging_ui.xml b/doc/C/packaging_ui.xml
index 4cb3da6..a2e1ac5 100644
--- a/doc/C/packaging_ui.xml
+++ b/doc/C/packaging_ui.xml
@@ -15,6 +15,10 @@
 	  </para>
 	</listitem>
 	<listitem>
+	  <para>the GObject introspection files (to be used by the GObject introspection framework)
+	  </para>
+	</listitem>
+	<listitem>
 	  <para>the tools, which require the runtime component
 	  </para>
 	</listitem>
@@ -73,22 +77,56 @@
   </sect1>
 
   <sect1>
-    <title>Tools</title>
+    <title>GObject introspection</title>
     <para>
-      This component has the following files:
+      If GObject introspection has been compiled, &LIBGDA;'s UI extension's introspection files are:
       <programlisting>
+|-- share
+|   `-- gir-1.0
+|       `-- Gdaui-4.0.gir
+`-- lib
+    `-- girepository-1.0
+        `-- Gdaui-4.0.typelib
+      </programlisting>
+    </para>
+  </sect1>
+
+  <sect1>
+    <title>Tools</title>
+    <sect2>
+      <title>Control center</title>
+      <para>
+	The control center's files are:
+	<programlisting>
 .
 |-- bin
-|   |-- gda-browser-4.0
 |   `-- gda-control-center-4.0
 `-- share
     |-- applications
-    |   |-- gda-browser-4.0.desktop
     |   `-- gda-control-center-4.0.desktop
     |-- libgda-4.0
     |   `-- pixmaps
     |       `-- gdaui-generic.png
     `-- pixmaps
+        |-- gda-control-center-newcnc.png
+        `-- gda-control-center.png
+	</programlisting>
+      </para>
+    </sect2>
+
+<sect2>
+      <title>Gda browser</title>
+      <para>
+	The <link linkend="libgda-tools-gdabrowser">GdaBrowser</link> can be packaged separately, but it depends on
+	the runtime component and the UI extension runtime component.
+	<programlisting>
+.
+|-- bin
+|   `-- gda-browser-4.0
+`-- share
+    |-- applications
+    |   `-- gda-browser-4.0.desktop
+    `-- pixmaps
         |-- gda-browser-auth-big.png
         |-- gda-browser-auth.png
         |-- gda-browser-bookmark.png
@@ -104,14 +142,10 @@
         |-- gda-browser-reference.png
         |-- gda-browser-schema.png
         |-- gda-browser-table.png
-        |-- gda-browser.png
-        |-- gda-control-center-newcnc.png
-        `-- gda-control-center.png
-      </programlisting>
-    </para>
-    <para>
-      This component should be made dependent on the runtime component above.
-    </para>
+        `-- gda-browser.png
+	</programlisting>
+      </para>
+    </sect2>
   </sect1>
 
   <sect1>