[telepathy-doc/master] Stub for a Tube HOWTO

Danielle Madeley danielle.madeley at collabora.co.uk
Thu Nov 12 16:47:35 PST 2009


---
 docs/book/C/telepathy.xml    |   35 +++++++++++++----------------------
 docs/book/C/tube-example.xml |   17 +++++++++++++++++
 docs/book/Makefile.am        |    3 ++-
 3 files changed, 32 insertions(+), 23 deletions(-)
 create mode 100644 docs/book/C/tube-example.xml

diff --git a/docs/book/C/telepathy.xml b/docs/book/C/telepathy.xml
index fabf0bd..62014d2 100644
--- a/docs/book/C/telepathy.xml
+++ b/docs/book/C/telepathy.xml
@@ -72,42 +72,33 @@
 <xi:include href="contactinfo.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 <xi:include href="messaging.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 <xi:include href="filetransfer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-<xi:include href="tubes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
-<!--
-Note: The following sections are more tutorial-like, describing how to implement 
-real functionality, with full examples. The full examples will have a very 
-simple GTK+ UI and will be implemented with dbus-glib. There will also be small 
-code snippets which will also be in dbus-glib, but python versions could be 
-added in future.
--->
+<chapter id="chapter.streamedmedia">
+ <title>Streamed Media (VoIP)</title>
+</chapter>
+
+<xi:include href="tubes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+<xi:include href="services.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
-<chapter id="chapter.chat-client">
-  <title>Implementing a Chat Client</title>
+<chapter id="chapter.chat-example">
+  <title>Example: Implementing a Chat Client</title>
   <para>TODO:
  - Text Channels (Messages Interface?)
   </para>
 </chapter>
 
-<chapter id="chapter.voip-client">
-  <title>Creating a VoIP Client</title>
+<chapter id="chapter.voip-example">
+  <title>Example: Implementing a VoIP Client</title>
   <para>TODO: 
   (Streaming Audio/Video)
   - Will require some gstreamer knowledge for recording and playback.
   </para>
 </chapter>
 
-<chapter id="chapter.networked-application">
-  <title>Making an application networked</title> <!-- TODO: Rename the title. -->
-  <para>TODO:
-  - For instance, turn-based Tic-Tac-Toe.
-  </para>
-</chapter>
-
-<xi:include href="services.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+<xi:include href="tube-example.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
-<index id="refindex">
-</index>
+<!-- index id="refindex">
+</index -->
 
 <appendix id="source-code">
  <title>Example Source Code</title>
diff --git a/docs/book/C/tube-example.xml b/docs/book/C/tube-example.xml
new file mode 100644
index 0000000..0fac580
--- /dev/null
+++ b/docs/book/C/tube-example.xml
@@ -0,0 +1,17 @@
+<?xml version='1.0'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+               "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+
+  <!ENTITY mdash "&#8212;">
+  <!ENTITY url_spec "http://telepathy.freedesktop.org/spec/">
+]>
+
+<chapter id="chapter.tube-example">
+  <title>Example: Implementing a Telepathy Tube Client</title>
+  <para>
+   This chapter provides a worked example of how to implement a Telepathy
+   Tube client. Before launching into this chapter, you should at least have
+   read <xref linkend="chapter.basics"/> and skim-read
+   <xref linkend="chapter.tubes"/> and <xref linkend="chapter.services"/>.
+  </para>
+</chapter>
diff --git a/docs/book/Makefile.am b/docs/book/Makefile.am
index fd7248e..af98ba5 100644
--- a/docs/book/Makefile.am
+++ b/docs/book/Makefile.am
@@ -25,7 +25,8 @@ DOC_INCLUDES = \
 	messaging.xml \
 	filetransfer.xml \
 	tubes.xml \
-	services.xml
+	services.xml \
+	tube-example.xml
 
 # these are figures that need to be rasterised
 DOC_FIGURES_SRC = \
-- 
1.5.6.5




More information about the telepathy-commits mailing list