docs/book/C/telepathy.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

<?xml version='1.0'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
               "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

  <!-- These entities are used in the generated .omf files, 
       along with the author tags,
       allowing the Yelp help browser to know about the document.
 
       The legal.xml file contains legal information, there is no need to edit the file. 
       Use the appversion entity to specify the version of the application.
       Use the manrevision entity to specify the revision number of this manual.
       Use the date entity to specify the release date of this manual.
       Use the app entity to specify the name of the application. -->
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY mdash "&#8212;">
]>

<book id="index">
  <bookinfo>
    <title>Telepathy Developer's Manual</title>

    <revhistory>
      <revision> 
        <revnumber>0.1</revnumber> 
          <date>UNRELEASED</date> 
          <revdescription> 
            <para role="author">Danielle Madeley</para> 
            <para role="author">Murray Cumming</para> 
            <para role="publisher">Collabora, Ltd.</para> 
	  </revdescription> 
      </revision>
    </revhistory> 

    <authorgroup>
      <author role="maintainer">
        <firstname>Danielle</firstname>
        <surname>Madeley</surname>
        <affiliation>
          <orgname>Collabora Ltd.</orgname>
          <address> <email>danielle.madeley@collabora.co.uk</email> </address>
        </affiliation>
      </author>
      <author> 
        <firstname>Murray</firstname> 
        <surname>Cumming</surname> 
        <affiliation> 
          <orgname>Openismus GmbH</orgname> 
          <address> <email>murrayc@openismus.com</email> </address> 
        </affiliation> 
      </author> 
    </authorgroup>
      
    <copyright>
      <year>2008-9</year>
      <holder>Collabora Ltd.</holder>
    </copyright>

    <abstract role="description">
      <para>Software development manual for Telepathy.</para>

      <para>This manual is written using <ulink
        url="http://www.docbook.org/">DocBook</ulink>, and its source is kept
        <ulink url="http://git.collabora.co.uk/?p=telepathy-doc.git">on
        git.collabora.co.uk</ulink>. Contributions and fixes are welcome on the
        <ulink
        url="http://lists.freedesktop.org/mailman/listinfo/telepathy">Telepathy
        mailing list</ulink> or attached to bugs on <ulink
        url="https://bugs.freedesktop.org/enter_bug.cgi?product=Telepathy&amp;component=tp-doc">bugs.freedesktop.org
        (in the “Telepathy” product and “tp-doc” component)</ulink>.</para>
    </abstract>

  <xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

  </bookinfo>
      
<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="basics.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="accounts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="channel-dispatcher.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="connection.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="channel.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<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"/>

<chapter id="chapter.streamedmedia">
 <title>Calls (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-example">
  <title>Example: Implementing a Chat Client</title>
  <para>TODO:
 - Text Channels (Messages Interface?)
  </para>
</chapter>

<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>

<xi:include href="tube-example.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<!-- index id="refindex">
</index -->

<appendix id="source-code">
 <title>Example Source Code</title>
</appendix>

</book>