[Telepathy-commits] [telepathy-doc/master] 2009-12-20 Murray Cumming <murrayc at murrayc.com>

Murray Cumming murrayc at murrayc.com
Thu Jan 22 09:50:05 PST 2009


* docs/book/C/telepathy.xml: Basics: Add a Language Bindings sub-section
as a way to mention telepathy-glib, which we use (so far) for all our
examples.
---
 ChangeLog                 |    6 ++++++
 docs/book/C/telepathy.xml |   15 ++++++++++++---
 docs/book/Makefile.am     |    2 +-
 3 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index ca210b8..354135e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
 2009-12-20  Murray Cumming  <murrayc at murrayc.com>
 
+	* docs/book/C/telepathy.xml: Basics: Add a Language Bindings sub-section 
+	as a way to mention telepathy-glib, which we use (so far) for all our 
+	examples.
+
+2009-12-20  Murray Cumming  <murrayc at murrayc.com>
+
 	* docs/book/C/telepathy.xml: Basics: Move the boring stuff about 
 	Introspect() into a notes section because it is too soon to get scary.
 
diff --git a/docs/book/C/telepathy.xml b/docs/book/C/telepathy.xml
index 76657a5..ea92c4d 100644
--- a/docs/book/C/telepathy.xml
+++ b/docs/book/C/telepathy.xml
@@ -97,7 +97,9 @@ of the Telapathy specification.
 
   <sect1 id="sec-basics-dbus">
     <title>Using D-Bus</title>
-    <para>Telepathy is a D-Bus API. Telepathy components conform to the <ulink url="&url_spec;">Telepathy D-Bus Specification</ulink>, which is therefore also the main Telepathy API reference. D-Bus is an IPC (Inter-process communication) system, allowing different software components to be implemented in different processes, with different programming languages. It also allows multiple applications to easily share functionality from a single process.</para>
+    <para>Telepathy is a D-Bus API. Telepathy components conform to the <ulink url="&url_spec;">Telepathy D-Bus Specification</ulink>, which is therefore also the main Telepathy API reference.</para>
+    <para>D-Bus is an IPC (Inter-process communication) system, allowing different software components to be implemented in different processes, with different programming languages. It also allows multiple applications to easily share functionality from a single process.</para>
+    <!-- TODO: Mention basic D-Bus concepts, though try not to overwhelm the reader so early. -->
 
     <para>In the following sections you can see how a D-Bus API can be used from some common programming languages.</para>
 
@@ -124,8 +126,15 @@ of the Telapathy specification.
       </sect3>
 
     </sect2>
+   </sect1>
 
-  </sect1>
+   <sect1 id="sec-basics-language-bindings">
+    <title>Language Bindings</title>
+    <para>As mentioned in the <link linkend="sec-basics-dbus">Using D-Bus</link> section, many programming languages have their own generic ways of using D-Bus APIs. In addition, there are some Telepathy-specific APIs to make the use of Telepathy even easier. For instance, <ulink url="http://telepathy.freedesktop.org/wiki/Telepathy%20GLib">telepathy-glib</ulink> provides an API that is familiar to users of Glib and GTK+, using the GObject system and related conventions.</para>
+    <para>Likewise, the <ulink url="http://telepathy.freedesktop.org/wiki/TelepathyQt">Telepathy-Qt</ulink> project provides a more Qt-like API for Telepathy and <ulink url="http://telepathy.freedesktop.org/wiki/Telepathy%20Python">Telepathy-Python</ulink> does the same for Python.</para> <!-- TODO: Link to Telepathy-Qt4 when it is ready. -->
+    <para>The C examples in this book will use telepathy-glib.</para>
+
+   </sect1>
 
   <sect1 id="sec-basics-connection-managers">
     <title>Connection Managers</title>
@@ -147,7 +156,7 @@ of the Telapathy specification.
 
   <sect1 id="sec-basics-mission-control">
     <title>Mission Control</title>
-    <para>TODO: Notes: desktop-wide accounts and dispatching to applications.
+    <para>TODO: Notes: desktop-wide accounts and dispatching to applications. TODO: Should we even mention this before the new (5?) version is ready?
     </para>
   </sect1>
 
diff --git a/docs/book/Makefile.am b/docs/book/Makefile.am
index 0c56d5c..76b19bf 100644
--- a/docs/book/Makefile.am
+++ b/docs/book/Makefile.am
@@ -97,7 +97,7 @@ include $(top_srcdir)/docs/Makefile_web.am_fragment
 
 post-online: post-html post-pdf
 
-post-html: html
+post-html: html pdf
 	rsync $(rsync_args) -r html/ murrayc@$(web_host):$(web_path_docs)/html/
 	rsync $(rsync_args) -r pdf/ murrayc@$(web_host):$(web_path_docs)/pdf/
 
-- 
1.5.6.5



More information about the Telepathy-commits mailing list