[libgda/LIBGDA_4.2] GdaBrowser: improved inline help

[Vivien Malerba <vivien src gnome org>]

commit 5f34f4e811a6ee59fd4e2836555eb8d737d45dce
Author: Vivien Malerba <malerba gnome-db org>
Date:   Fri Mar 18 20:54:04 2011 +0100

    GdaBrowser: improved inline help

 tools/browser/connection-binding-properties.c |   18 +++++++++
 tools/browser/help/C/features.page            |   47 ++++++++++++++++++++----
 tools/browser/help/C/virtual-connections.page |   29 +++++++++++++++
 tools/browser/help/Makefile.am                |    3 +-
 4 files changed, 88 insertions(+), 9 deletions(-)
---
diff --git a/tools/browser/connection-binding-properties.c b/tools/browser/connection-binding-properties.c
index bf613ce..f73942b 100644
--- a/tools/browser/connection-binding-properties.c
+++ b/tools/browser/connection-binding-properties.c
@@ -113,6 +113,16 @@ connection_binding_properties_dispose (GObject *object)
 	parent_class->dispose (object);
 }
 
+#ifdef HAVE_GDU
+static void
+help_clicked_cb (GtkButton *button, G_GNUC_UNUSED ConnectionBindingProperties *cprop)
+{
+        browser_show_help ((GtkWindow*) gtk_widget_get_toplevel ((GtkWidget*) button),
+                           "virtual-connections");
+        g_signal_stop_emission_by_name (button, "clicked");
+}
+#endif
+
 /**
  * connection_binding_properties_new_create
  * @bcnc: a #BrowserConnection
@@ -147,6 +157,14 @@ connection_binding_properties_new_create (BrowserConnection *bcnc)
 
 	gtk_widget_show (gtk_dialog_add_button (GTK_DIALOG (cprop), _("Create connection"), GTK_RESPONSE_OK));
 	gtk_widget_show (gtk_dialog_add_button (GTK_DIALOG (cprop), GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL));
+#ifdef HAVE_GDU
+        GtkWidget *help_btn;
+        help_btn = gtk_button_new_from_stock (GTK_STOCK_HELP);
+        g_signal_connect (help_btn, "clicked",
+                          G_CALLBACK (help_clicked_cb), cprop);
+        gtk_widget_show (help_btn);
+        gtk_dialog_add_action_widget (GTK_DIALOG (cprop), help_btn, GTK_RESPONSE_HELP);
+#endif
 
 	return (GtkWidget*) cprop;
 }
diff --git a/tools/browser/help/C/features.page b/tools/browser/help/C/features.page
index 951432a..82ef91a 100644
--- a/tools/browser/help/C/features.page
+++ b/tools/browser/help/C/features.page
@@ -9,12 +9,43 @@
   <p>
     <app>gda-browser</app>'s current features are:
   </p>
-  <list>
-    <item><p>multiple simultaneous connections can be opened at once</p></item>
-    <item><p>multi threaded: each connection is handled in it own thread, meaning that no single
-	connection can lock the application</p></item>
-    <item><p>several windows can be opened for a single connection</p></item>
-    <item><p>full screen mode accessible to maximize the screen space usage</p></item>
-    <item><p>extensibility: the general framework is opened enough to add new integrated features</p></item>
-  </list>
+  <section>
+    <title>General user interface</title>
+    <list>	
+      <item><p>multi threaded: each connection is handled in it own thread, meaning that no single
+      connection can lock the application</p></item>
+      <item><p>several windows can be opened for a single connection</p></item>
+      <item><p>full screen mode accessible to maximize the screen space usage</p></item>
+    </list>
+  </section>
+  <section>
+    <title>Connection management</title>
+    <list>
+      <item><p>multiple simultaneous connections can be opened at once</p></item>
+      <item><p>connections binding: it is possible to <link type="topic" xref="virtual-connections">"bind"</link> several connections into one to execute SQL commands on several connections at once</p></item>
+      <item><p>multi threaded: each connection is handled in it own thread, meaning that no single
+      connection can lock the application</p></item>
+    </list>
+  </section>
+  <section>
+    <title>Activities</title>
+    <p>
+      The activities are grouped by theme around the notion of <link type="topic" xref="general-ui">perspectives</link>, the following are currently implemented:
+    </p>
+    <list>	
+      <item><p>analyse the database schema (tables, relations, ...), see the
+      the <link xref="schema-browser-perspective">Schema browser perspective</link></p></item>
+      <item><p>execute SQL commands, see the
+      <link xref="query-execution-perspective">Query execution perspective</link></p></item>
+      <item><p>analyse the table's contents, see the
+      <link xref="data-manager-perspective">Data manager perspective</link></p></item>
+    </list>
+  </section>
+  <section>
+    <title>Openness</title>
+    <list>
+      <item><p>CSV and other text files can be imported and used in conjunction with <link type="topic" xref="virtual-connections">connection binding</link></p></item>
+      <item><p>the general framework is opened enough to add new integrated features; specifically anyone can develop new <link type="topic" xref="general-ui">perspectives</link></p></item>      
+    </list>
+  </section>
 </page>
diff --git a/tools/browser/help/C/virtual-connections.page b/tools/browser/help/C/virtual-connections.page
new file mode 100644
index 0000000..678e342
--- /dev/null
+++ b/tools/browser/help/C/virtual-connections.page
@@ -0,0 +1,29 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="virtual-connections">
+  <info>
+    <title type="sort">1</title>
+    <link type="guide" xref="features"/>
+  </info>
+  <title>Connections binding</title>
+  <p>
+    Connection binding is a feature which allows to "bind" several connections and/or imported
+    data sets into a single connection, which can be used almost like a regular connection.
+  </p>
+  <p>
+    This feature is usefull when one needs to execute an SQL command (for example to extract data)
+    takinginto account data actually stored in different databases. Without this feature, the way
+    to achieve the same result is by exporting the necessary data from each database and work on
+    the data outside of the databases.
+  </p>
+  <p>
+    To create a new "bound" connection (or "virtual" connection), use the
+    <guiseq><gui>Connection</gui><gui>Bind connection</gui></guiseq> menu, or the
+    <keyseq><key>Ctrl</key><key>i</key></keyseq> shortcut. This pops up a new dialog window
+    from which "items" to be included in the "bound" connection can be defined:
+  </p>
+  <list>	
+    <item><p>Bind a connection to include all the tables of that connection</p></item>
+    <item><p>Bind a data set to import data from a text file as a single table</p></item>
+  </list>
+</page>
diff --git a/tools/browser/help/Makefile.am b/tools/browser/help/Makefile.am
index 647aa10..b592462 100644
--- a/tools/browser/help/Makefile.am
+++ b/tools/browser/help/Makefile.am
@@ -39,7 +39,8 @@ DOC_PAGES = \
 	schema-browser-perspective.page \
 	transactions.page \
 	table-insert-data.page \
-	variables.page
+	variables.page \
+	virtual-connections.page
 
 DOC_LINGUAS = de es sl