[Telepathy-commits] [telepathy-doc/master] * docs/book/C/telepathy.xml: Added several indexterm tags. It would be nice if chapter headings appeared there automatically.

Murray Cumming murrayc at murrayc.com
Mon Feb 9 01:27:04 PST 2009 

---
 ChangeLog                 |    5 +++++
 docs/book/C/telepathy.xml |   23 +++++++++++++++++++++--
 2 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 4804fac..e5a98da 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2009-02-06  Murray Cumming  <murrayc at openismus.com>
 
+	* docs/book/C/telepathy.xml: Added several indexterm tags. It would be 
+	nice if chapter headings appeared there automatically.
+
+2009-02-06  Murray Cumming  <murrayc at openismus.com>
+
 	* docs/book/C/telepathy.xml: Channels: Write a short introduction, 
 	mentioning the simple channel types. Moved content into other chapters 
 	for ContactList Channel and Text Channel chapters. This seems better 
diff --git a/docs/book/C/telepathy.xml b/docs/book/C/telepathy.xml
index 56e3184..35d66e5 100644
--- a/docs/book/C/telepathy.xml
+++ b/docs/book/C/telepathy.xml
@@ -236,6 +236,8 @@ of the Telapathy specification.
 
     <sect1 id="sec-dbus-glib">
       <title>Using D-Bus from C, with glib</title>
+      <indexterm><primary>dbus-glib</primary></indexterm>
+      <indexterm><primary>glib</primary></indexterm>
 
       <sect2 id="sec-dbus-glib-methods">
         <title>Calling Methods</title>
@@ -261,6 +263,7 @@ of the Telapathy specification.
 
     <sect1 id="sec-dbus-python">
       <title>Using D-Bus from Python</title>
+      <indexterm><primary>Python</primary></indexterm>
 
       <sect2 id="sec-dbus-python-methods">
         <title>Calling Methods</title>
@@ -306,6 +309,8 @@ of the Telapathy specification.
 
 <chapter id="chapter-language-bindings">
     <title>Language Bindings</title>
+    <indexterm><primary>Language Bindings</primary></indexterm>
+
     <para>As mentioned in the <link linkend="chapter-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. -->
 
@@ -313,6 +318,8 @@ of the Telapathy specification.
   
     <sect1 id="sec-language-bindings-telepathy-glib">
       <title>telepathy-glib</title>
+      <indexterm><primary>telepathy-glib</primary></indexterm>
+
       <para>The C examples in this book will use telepathy-glib, which provides a GObject-based API for the Telepathy framework.</para>
 
       <!-- TODO: Mention this? 
@@ -416,6 +423,7 @@ AC_SUBST(EXAMPLE_LIBS)
 
 <chapter id="chapter-connection-manager">
   <title>Connection Manager</title>
+  <indexterm><primary>Connection Manager</primary></indexterm>
 
   <para>As mentioned in the <link linkend="sec-basics-connection-managers">Basics</link> chapter, each Connection Manager service provides support for a communication protocol. Each one implements the <ulink url="&url_spec_base;ConnectionManager"><interfacename>ConnectionManager</interfacename></ulink> D-Bus interface, allowing you to request a connection, among other things. See the <link linkend="chapter-connection">Connection</link> chapter for more details about connecting.</para>
 
@@ -436,6 +444,7 @@ AC_SUBST(EXAMPLE_LIBS)
 
 <chapter id="chapter-connection">
   <title>Connection</title>
+  <indexterm><primary>Connection</primary></indexterm>
   
   <sect1>
     <title>Connecting</title>
@@ -451,7 +460,7 @@ AC_SUBST(EXAMPLE_LIBS)
 
     <note><para>See the <link linkend="sec-language-bindings-telepathy-glib-generated">Language Bindings</link> chapter for an explanation of hand-coded and generated API in telepathy-glib.</para></note>
 
-    <para>See the <link linkend="chapter-channel">Channels</link> section about obtaining and using <interfacename>Channel</interfacename>s from the <interfacename>Connection</interfacename> with which you can list groups of contacts.</para>
+    <para>See the <link linkend="chapter-channel">Channel</link> chapter about obtaining and using <interfacename>Channel</interfacename>s from the <interfacename>Connection</interfacename> with which you can list groups of contacts and communicate with those contacts.</para>
 
     <!-- TODO: Mention these interfaces, mentioned by smcv on irc: Requests and Contacts are "recommended" (every protocol ought to be able to support them), and are only non-core because they're new (so clients can discover whether they're present)
  murrayc: when we eventually remove deprecated stuff, it's likely that Requests and Contacts will become part of Connection -->
@@ -465,6 +474,7 @@ AC_SUBST(EXAMPLE_LIBS)
 
   <sect1>
     <title>Presence</title>
+    <indexterm><primary>Presence</primary></indexterm>
     <para>If a protocol has a concept of presence, showing when users are online or available, then that <interfacename>ConnectionManager</interfacename>'s <interfacename>Connection</interfacename> will provide the <ulink url="&url_spec_base;Connection.Interface.SimplePresence"><interfacename>SimplePresence</interfacename></ulink> interface. This interface has functions to set and get the current presence for the connected account. It also has a <ulink url="&url_spec_base;Connection.Interface.SimplePresence.PresencesChanged">PresencesChanged</ulink> signal to detect changes to the presence caused by other clients.</para>
 
     <sect2>
@@ -558,6 +568,7 @@ AC_SUBST(EXAMPLE_LIBS)
 
 <chapter id="chapter-channel">
   <title>Channel</title>
+  <indexterm><primary>Channel</primary></indexterm>
 
   <para>Each <interfacename>Connection</interfacename> provides <ulink url="&url_spec_base;Channel"><interfacename>Channel</interfacename></ulink>s, which allow the local application to exchange data with the remote server, for instance to retrieve a list of contacts in a chat room, or to send a message to a contact. There are various types of <interfacename>Channel</interfacename> for each type of data that might be exchanged, some of which are mentioned in detail in subsequent chapters. These D-Bus interfaces have names prefixed by &quot;org.freedesktop.Telepathy.Channel.Type&quot; For instance:</para>
 
@@ -598,7 +609,7 @@ AC_SUBST(EXAMPLE_LIBS)
   <!-- TODO: Mention that the base Channel interface provides channel type, handle and Interfaces 
      properties, and Close method, Closed signal? Only if we can say how it might be used. -->
 
-  <para>These <interfacename>Channel</interfacename>s can be created via the <interfacename>Connection</interfacename>'s <ulink url="&url_spec_base;Connection.RequestChannel"><methodname>RequestChannel()</methodname></ulink> method.</para> <!-- TODO: , which takes the D-Bus interface name of the required <interfacename>Channel</interfacename> type, TODO: How are the handle type and handle parameters used for different channel types? -->
+  <para>These <interfacename>Channel</interfacename>s can be created via the <interfacename>Connection</interfacename>'s <ulink url="&url_spec_base;Connection.RequestChannel"><methodname>RequestChannel()</methodname></ulink> D-Bus method. <!-- TODO: , which takes the D-Bus interface name of the required <interfacename>Channel</interfacename> type, TODO: How are the handle type and handle parameters used for different channel types? --> Telepathy-glib provides the <ulink url="&url_telepathy_glib_base;connection.html#tp_cli_connection_call_request_channel"><function>tp_cli_connection_call_request_channel()</function></ulink> function for this purpose.</para>
 
   <!-- TODO: Mention channels that are not directly created by the application: Davyd's text: "in response to communication initiated by someone else, in which case their advent is heralded by the NewChannel signal." -->
 
@@ -652,6 +663,9 @@ AC_SUBST(EXAMPLE_LIBS)
 
 <chapter id="chapter-channel-contactlist">
   <title>ContactList Channel</title>
+  <indexterm><primary>ContactList</primary></indexterm>
+
+  <para>This channel provides a list of people on the server, such as the contacts to whose presence information you are subscribed or the contacts to whom you publish your presence information. </para>
 
   <para>TODO: - Provides a <ulink url="&url_spec_base;Channel.Interface.Group">Group</ulink> interface.
        - Contains many members (Contact handles). 
@@ -676,6 +690,7 @@ AC_SUBST(EXAMPLE_LIBS)
 
 <chapter id="chapter-channel-text">
   <title>Text Channel</title>
+  <indexterm><primary>Text</primary></indexterm>
 
   <para>TODO: Notes: - Text channels may have ChatState (typing notification), Messages (rich 
      messages), Password interfaces
@@ -691,6 +706,8 @@ AC_SUBST(EXAMPLE_LIBS)
 
 <chapter id="chapter-group">
    <title>Group Interface</title>
+   <indexterm><primary>Group</primary></indexterm>
+
    <para>TODO:
    (used in lots of different channels) (TODO: which ones? how? examples?)
    - This is partitioned into:
@@ -705,6 +722,8 @@ AC_SUBST(EXAMPLE_LIBS)
 
 <chapter id="chapter-tubes">
   <title>Tubes</title>
+  <indexterm><primary>Tube</primary></indexterm>
+
   <para>TODO:
    - Helps me to implement an ad-hoc protocol or data-exchange structure above 
      what the IM protocol does.
-- 
1.5.6.5

More information about the telepathy-commits mailing list