[telepathy-doc/master] Clean up XML entities, etc.
Davyd Madeley
davyd at madeley.id.au
Thu Apr 2 23:33:11 PDT 2009
---
docs/book/C/accounts.xml | 12 -----------
docs/book/C/basics.xml | 43 ++++++++++++++------------------------
docs/book/C/channel.xml | 16 +------------
docs/book/C/connection.xml | 16 +------------
docs/book/C/contactinfo.xml | 12 -----------
docs/book/C/introduction.xml | 15 +-----------
docs/book/C/legal.xml | 2 +-
docs/book/C/messaging.xml | 12 -----------
docs/book/C/telepathy.xml | 46 ++++++++++++-----------------------------
docs/book/C/tubes.xml | 22 --------------------
10 files changed, 37 insertions(+), 159 deletions(-)
diff --git a/docs/book/C/accounts.xml b/docs/book/C/accounts.xml
index 3b8b9bd..7c31762 100644
--- a/docs/book/C/accounts.xml
+++ b/docs/book/C/accounts.xml
@@ -2,18 +2,6 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY mdash "—">
- <!ENTITY appversion "0.7">
- <!ENTITY manrevision "0.2">
- <!ENTITY date "12 August 2008">
- <!ENTITY app_no_markup "Telepathy">
- <!ENTITY app "<application>&app_no_markup;</application>">
- <!ENTITY url_examples_base "./examples/">
- <!ENTITY url_spec "http://telepathy.freedesktop.org/spec.html">
- <!ENTITY url_spec_base "&url_spec;#org.freedesktop.Telepathy.">
- <!ENTITY url_telepathy_glib_base "http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-">
- <!ENTITY url_dbus_spec_base "http://dbus.freedesktop.org/doc/dbus-specification.html#">
- <!ENTITY url_dbus_glib_base "http://dbus.freedesktop.org/doc/dbus-glib/">
- <!ENTITY url_dbus_python_base "http://dbus.freedesktop.org/doc/dbus-python/api/">
]>
<chapter id="chapter.accounts">
diff --git a/docs/book/C/basics.xml b/docs/book/C/basics.xml
index e5c70ce..5905aed 100644
--- a/docs/book/C/basics.xml
+++ b/docs/book/C/basics.xml
@@ -2,17 +2,7 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY mdash "—">
- <!ENTITY appversion "0.7">
- <!ENTITY manrevision "0.2">
- <!ENTITY date "12 August 2008">
- <!ENTITY app_no_markup "Telepathy">
- <!ENTITY app "<application>&app_no_markup;</application>">
- <!ENTITY url_examples_base "./examples/">
- <!ENTITY url_spec "http://telepathy.freedesktop.org/spec.html">
- <!ENTITY url_spec_base "&url_spec;#org.freedesktop.Telepathy.">
- <!ENTITY url_telepathy_glib_base "http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-">
<!ENTITY url_dbus_spec_base "http://dbus.freedesktop.org/doc/dbus-specification.html#">
- <!ENTITY url_dbus_glib_base "http://dbus.freedesktop.org/doc/dbus-glib/">
<!ENTITY url_dbus_python_base "http://dbus.freedesktop.org/doc/dbus-python/api/">
]>
@@ -534,7 +524,7 @@
</para>
<para>
In <literal>dbus-glib</literal>, method calls are made with the function
- <ulink url="&url_dbus_glib_base;dbus-glib-DBusGProxy.html#dbus-g-proxy-begin-call"><function>dbus_g_proxy_begin_call</function></ulink>,
+ <function>dbus_g_proxy_begin_call</function>,
which takes as its arguments the name of a D-Bus method to call,
a callback function to handle the reply, optional user data and the
parameters (and types) for the D-Bus method.
@@ -552,7 +542,7 @@
<para>
In your reply callback, use the function
- <ulink url="&url_dbus_glib_base;dbus-glib-DBusGProxy.html#dbus-g-proxy-end-call"><function>dbus_g_proxy_end_call</function></ulink>
+ <function>dbus_g_proxy_end_call</function>
to collect the return values from the method call. This function can
be called outside of the reply callback, but if it is called before
the reply has been received, it will block; causing the same problems
@@ -616,10 +606,10 @@
<title>Handling Signals</title>
<para>
Handlers for D-Bus signals may be connected with the function
- <ulink url="&url_dbus_glib_base;dbus-glib-DBusGProxy.html#dbus-g-proxy-connect-signal"><function>dbus_g_proxy_connect_signal</function></ulink>.
+ <function>dbus_g_proxy_connect_signal</function>.
As when calling D-Bus methods, you must specify the expected
types, but for signals you must do this in a previous call to
- <ulink url="&url_dbus_glib_base;dbus-glib-DBusGProxy.html#dbus-g-proxy-add-signal"><function>dbus_g_proxy_add_signal</function></ulink>.
+ <function>dbus_g_proxy_add_signal</function>.
The specified callback function will then be called when the signal is
emitted.
</para>
@@ -805,17 +795,17 @@
<para>
Some proxy objects, such as
- <ulink url="&url_telepathy_glib_base;connection.html"><classname>TpConnection</classname></ulink> and
- <ulink url="&url_telepathy_glib_base;connection.html"><classname>TpChannel</classname></ulink>,
+ <classname>TpConnection</classname> and
+ <classname>TpChannel</classname>,
make additional D-Bus method calls to acquire additional information
(e.g. available interfaces) to populate the properties and structures
of the object. When they have received this information
they are considered "ready".
Each proxy object provides a method to register a callback for when
the object is ready, e.g.
- <ulink url="&url_telepathy_glib_base;connection.html#tp-connection-call-when-ready"><methodname>tp_connection_call_when_ready</methodname></ulink>
+ <function>tp_connection_call_when_ready</function>
for a <classname>TpConnection</classname>, or
- <ulink url="&url_telepathy_glib_base;channel.html#tp-channel-call-when-ready"><methodname>tp_channel_call_when_ready</methodname></ulink>
+ <function>tp_channel_call_when_ready</function>
for a <classname>TpChannel</classname>. See
<xref linkend="ex.basics.language-bindings.telepathy-glib.ready"/>.
</para>
@@ -853,7 +843,7 @@
<term>tp_cli_</term>
<listitem><para>
These functions are used for client applications. For instance,
- <ulink url="&url_telepathy_glib_base;connection.html#tp-cli-connection-run-connect"><methodname>tp_cli_connection_call_connect</methodname></ulink>.
+ <function>tp_cli_connection_call_connect</function>.
</para></listitem>
</varlistentry>
@@ -862,7 +852,7 @@
<listitem><para>
These functions are used for service implementations, such as
connection managers. For instance,
- <ulink url="&url_telepathy_glib_base;svc-connection.html#tp-svc-connection-implement-connect"><methodname>tp_svc_connection_implement_connect</methodname></ulink>.
+ <function>tp_svc_connection_implement_connect</function>.
</para></listitem>
</varlistentry>
@@ -873,8 +863,8 @@
<para>
For each Telepathy D-Bus method, telepathy-glib generally provides
both a "run" and a "call" function.
- For instance, <ulink url="&url_telepathy_glib_base;connection.html#tp-cli-connection-run-connect"><methodname>tp_cli_connection_run_connect</methodname></ulink>
- and <ulink url="&url_telepathy_glib_base;connection.html#tp-cli-connection-call-connect"><methodname>tp_cli_connection_call_connect</methodname></ulink>.
+ For instance, <function>tp_cli_connection_run_connect</function>
+ and <function>tp_cli_connection_call_connect</function>.
</para>
<para>
The "run" functions are synchronous, and blocks until the
@@ -1031,8 +1021,7 @@ get_channels_cb (TpProxy *proxy,
<para>
The handling of variant types in
<application>telepathy-glib</application> is done using GLib's built-in
- <ulink url="http://library.gnome.org/devel/gobject/stable/gobject-Generic-values.html"><classname>GValue</classname></ulink>
- type system.
+ <classname>GValue</classname> type system.
</para>
<para>
@@ -1316,7 +1305,7 @@ AC_SUBST(EXAMPLE_LIBS)</programlisting>
<para>
When using telepathy-glib, you can simply call the
- <ulink url="&url_telepathy_glib_base;proxy.html#tp-proxy-has-interface"><function>tp_proxy_has_interface</function></ulink> function for
+ <function>tp_proxy_has_interface</function> function for
<classname>TpConnectionManager</classname>,
<classname>TpConnection</classname>, or
<classname>TpChannel</classname> objects.
@@ -1466,8 +1455,8 @@ AC_SUBST(EXAMPLE_LIBS)</programlisting>
Additionally, telepathy-glib wraps the
<methodname>HoldHandles</methodname> and
<methodname>ReleaseHandles</methodname> D-Bus methods with the
- <ulink url="&url_telepathy_glib_base;connection.html#tp-connection-hold-handles"><function>tp_connection_hold_handles</function></ulink>
- and <ulink url="&url_telepathy_glib_base;connection.html#tp-connection-unref-handles"><function>tp_connection_unref_handles</function></ulink>
+ <function>tp_connection_hold_handles</function>
+ and <function>tp_connection_unref_handles</function>
functions which reference-count the client-side handle
"hold".
This requires you to match each call of
diff --git a/docs/book/C/channel.xml b/docs/book/C/channel.xml
index 5b8e9e5..3262beb 100644
--- a/docs/book/C/channel.xml
+++ b/docs/book/C/channel.xml
@@ -2,18 +2,6 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY mdash "—">
- <!ENTITY appversion "0.7">
- <!ENTITY manrevision "0.2">
- <!ENTITY date "12 August 2008">
- <!ENTITY app_no_markup "Telepathy">
- <!ENTITY app "<application>&app_no_markup;</application>">
- <!ENTITY url_examples_base "./examples/">
- <!ENTITY url_spec "http://telepathy.freedesktop.org/spec.html">
- <!ENTITY url_spec_base "&url_spec;#org.freedesktop.Telepathy.">
- <!ENTITY url_telepathy_glib_base "http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-">
- <!ENTITY url_dbus_spec_base "http://dbus.freedesktop.org/doc/dbus-specification.html#">
- <!ENTITY url_dbus_glib_base "http://dbus.freedesktop.org/doc/dbus-glib/">
- <!ENTITY url_dbus_python_base "http://dbus.freedesktop.org/doc/dbus-python/api/">
]>
<chapter id="chapter.channel">
@@ -302,8 +290,8 @@
<application>telepathy-glib</application> maps
<methodname>CreateChannel</methodname> and
<methodname>EnsureChannel</methodname> to the functions
- <ulink url="&url_telepathy_glib_base;connection-requests.html#tp-cli-connection-interface-requests-call-create-channel"><function>tp_cli_connection_interface_requests_call_create_channel()</function></ulink>
- and <ulink url="&url_telepathy_glib_base;connection-requests.html#tp-cli-connection-interface-requests-call-ensure-channel"><function>tp_cli_connection_interface_requests_call_ensure_channel()</function></ulink>
+ <function>tp_cli_connection_interface_requests_call_create_channel</function>
+ and <function>tp_cli_connection_interface_requests_call_ensure_channel</function>
respectively. <xref linkend="ex.channel.requesting.glib.ensure"/>
shows how this is done.
</para>
diff --git a/docs/book/C/connection.xml b/docs/book/C/connection.xml
index 20c1f10..ceb68f2 100644
--- a/docs/book/C/connection.xml
+++ b/docs/book/C/connection.xml
@@ -2,18 +2,6 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY mdash "—">
- <!ENTITY appversion "0.7">
- <!ENTITY manrevision "0.2">
- <!ENTITY date "12 August 2008">
- <!ENTITY app_no_markup "Telepathy">
- <!ENTITY app "<application>&app_no_markup;</application>">
- <!ENTITY url_examples_base "./examples/">
- <!ENTITY url_spec "http://telepathy.freedesktop.org/spec.html">
- <!ENTITY url_spec_base "&url_spec;#org.freedesktop.Telepathy.">
- <!ENTITY url_telepathy_glib_base "http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-">
- <!ENTITY url_dbus_spec_base "http://dbus.freedesktop.org/doc/dbus-specification.html#">
- <!ENTITY url_dbus_glib_base "http://dbus.freedesktop.org/doc/dbus-glib/">
- <!ENTITY url_dbus_python_base "http://dbus.freedesktop.org/doc/dbus-python/api/">
]>
<chapter id="chapter.connection">
@@ -179,14 +167,14 @@
<title>telepathy-glib</title>
<para>
telepathy-glib provides the
- <ulink url="&url_telepathy_glib_base;connection-manager.html#tp-list-connection-managers"><function>tp_list_connection_managers</function></ulink> function
+ <function>tp_list_connection_managers</function> function
to list the available connection managers. This is demonstrated in
<xref linkend="ex.connection.connection-manager.glib"/>.
</para>
<para>
telepathy-glib's
- <ulink url="&url_telepathy_glib_base;connection-manager.html"><classname>TpConnectionManager</classname></ulink>
+ <classname>TpConnectionManager</classname>
object automatically calls <methodname>ListProtocols</methodname> upon
creation and emits the <literal>got-info</literal>
signal when it has returned. You can examine the
diff --git a/docs/book/C/contactinfo.xml b/docs/book/C/contactinfo.xml
index 31c6c4c..666f40b 100644
--- a/docs/book/C/contactinfo.xml
+++ b/docs/book/C/contactinfo.xml
@@ -2,18 +2,6 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY mdash "—">
- <!ENTITY appversion "0.7">
- <!ENTITY manrevision "0.2">
- <!ENTITY date "12 August 2008">
- <!ENTITY app_no_markup "Telepathy">
- <!ENTITY app "<application>&app_no_markup;</application>">
- <!ENTITY url_examples_base "./examples/">
- <!ENTITY url_spec "http://telepathy.freedesktop.org/spec.html">
- <!ENTITY url_spec_base "&url_spec;#org.freedesktop.Telepathy.">
- <!ENTITY url_telepathy_glib_base "http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-">
- <!ENTITY url_dbus_spec_base "http://dbus.freedesktop.org/doc/dbus-specification.html#">
- <!ENTITY url_dbus_glib_base "http://dbus.freedesktop.org/doc/dbus-glib/">
- <!ENTITY url_dbus_python_base "http://dbus.freedesktop.org/doc/dbus-python/api/">
]>
<chapter id="chapter.contactinfo">
diff --git a/docs/book/C/introduction.xml b/docs/book/C/introduction.xml
index 62f5b1c..ed91614 100644
--- a/docs/book/C/introduction.xml
+++ b/docs/book/C/introduction.xml
@@ -12,18 +12,7 @@
Use the date entity to specify the release date of this manual.
Use the app entity to specify the name of the application. -->
<!ENTITY mdash "—">
- <!ENTITY appversion "0.7">
- <!ENTITY manrevision "0.2">
- <!ENTITY date "12 August 2008">
- <!ENTITY app_no_markup "Telepathy">
- <!ENTITY app "<application>&app_no_markup;</application>">
- <!ENTITY url_examples_base "./examples/">
- <!ENTITY url_spec "http://telepathy.freedesktop.org/spec.html">
- <!ENTITY url_spec_base "&url_spec;#org.freedesktop.Telepathy.">
- <!ENTITY url_telepathy_glib_base "http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-">
- <!ENTITY url_dbus_spec_base "http://dbus.freedesktop.org/doc/dbus-specification.html#">
- <!ENTITY url_dbus_glib_base "http://dbus.freedesktop.org/doc/dbus-glib/">
- <!ENTITY url_dbus_python_base "http://dbus.freedesktop.org/doc/dbus-python/api/">
+ <!ENTITY url_spec "http://telepathy.freedesktop.org/spec/">
]>
<chapter id="chapter.introduction">
@@ -94,7 +83,7 @@
</para>
<para>
There is one
- <ulink url="http://telepathy.freedesktop.org/spec.html">specification</ulink>
+ <ulink url="&url_spec;">specification</ulink>
which defines the D-Bus API for how one Telepathy component talks to
another. Additionally there are many implementations of this
specification in the form of libraries that wrap the D-Bus API in a
diff --git a/docs/book/C/legal.xml b/docs/book/C/legal.xml
index a9f7b31..1c5f220 100644
--- a/docs/book/C/legal.xml
+++ b/docs/book/C/legal.xml
@@ -6,7 +6,7 @@ terms of the GNU Free DocumentationLicense (GFDL), Version 1.1 or any later
version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and
no Back-Cover Texts. You can find a copy of the GFDL at this
- <ulink url="ghelp:fdl" type="help">link</ulink>
+<ulink url="http://www.gnu.org/copyleft/fdl.html" type="help">link</ulink>
or in the file COPYING-DOCS distributed with this manual.</para>
<para>
diff --git a/docs/book/C/messaging.xml b/docs/book/C/messaging.xml
index 0eab762..a9cbcdd 100644
--- a/docs/book/C/messaging.xml
+++ b/docs/book/C/messaging.xml
@@ -2,18 +2,6 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY mdash "—">
- <!ENTITY appversion "0.7">
- <!ENTITY manrevision "0.2">
- <!ENTITY date "12 August 2008">
- <!ENTITY app_no_markup "Telepathy">
- <!ENTITY app "<application>&app_no_markup;</application>">
- <!ENTITY url_examples_base "./examples/">
- <!ENTITY url_spec "http://telepathy.freedesktop.org/spec.html">
- <!ENTITY url_spec_base "&url_spec;#org.freedesktop.Telepathy.">
- <!ENTITY url_telepathy_glib_base "http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-">
- <!ENTITY url_dbus_spec_base "http://dbus.freedesktop.org/doc/dbus-specification.html#">
- <!ENTITY url_dbus_glib_base "http://dbus.freedesktop.org/doc/dbus-glib/">
- <!ENTITY url_dbus_python_base "http://dbus.freedesktop.org/doc/dbus-python/api/">
]>
<chapter id="chapter.messaging">
diff --git a/docs/book/C/telepathy.xml b/docs/book/C/telepathy.xml
index 4cdefa2..b00399e 100644
--- a/docs/book/C/telepathy.xml
+++ b/docs/book/C/telepathy.xml
@@ -13,49 +13,25 @@
Use the app entity to specify the name of the application. -->
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY mdash "—">
- <!ENTITY appversion "0.7">
- <!ENTITY manrevision "0.2">
- <!ENTITY date "12 August 2008">
- <!ENTITY app_no_markup "Telepathy">
- <!ENTITY app "<application>&app_no_markup;</application>">
- <!ENTITY url_examples_base "./examples/">
- <!ENTITY url_spec "http://telepathy.freedesktop.org/spec.html">
- <!ENTITY url_spec_base "&url_spec;#org.freedesktop.Telepathy.">
- <!ENTITY url_telepathy_glib_base "http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-">
- <!ENTITY url_dbus_spec_base "http://dbus.freedesktop.org/doc/dbus-specification.html#">
- <!ENTITY url_dbus_glib_base "http://dbus.freedesktop.org/doc/dbus-glib/">
- <!ENTITY url_dbus_python_base "http://dbus.freedesktop.org/doc/dbus-python/api/">
]>
<book id="index">
<bookinfo>
- <title>&app; manual</title>
+ <title>Telepathy Developer's Manual</title>
- <!-- If we were using the FDL license then we would need full revision
- tags instead of just this one date.
- Actually, it seems that DocBook allows just a single date tag without
- these revhistory tags, but maybe gnome-doc-utils cannot cope with
- that. -->
<revhistory>
<revision>
- <revnumber>&app_no_markup; &appversion;</revnumber>
- <date>&date;</date>
+ <revnumber>0.1</revnumber>
+ <date>UNRELEASED</date>
<revdescription>
+ <para role="author">Davyd Madeley</para>
<para role="author">Murray Cumming</para>
- <para role="publisher">&app;</para>
+ <para role="publisher">Collabora, Ltd.</para>
</revdescription>
</revision>
</revhistory>
<authorgroup>
- <author>
- <firstname>Murray</firstname>
- <surname>Cumming</surname>
- <affiliation>
- <orgname>&app_no_markup; Documentation Team</orgname>
- <address> <email>murrayc at openismus.com</email> </address>
- </affiliation>
- </author>
<author role="maintainer">
<firstname>Davyd</firstname>
<surname>Madeley</surname>
@@ -64,19 +40,25 @@
<address> <email>davyd.madeley at collabora.co.uk</email> </address>
</affiliation>
</author>
+ <author>
+ <firstname>Murray</firstname>
+ <surname>Cumming</surname>
+ <affiliation>
+ <orgname>Openismus GmbH</orgname>
+ <address> <email>murrayc at 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 &app;.</para>
+ <para>Software development manual for Telepathy.</para>
</abstract>
-
<xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</bookinfo>
diff --git a/docs/book/C/tubes.xml b/docs/book/C/tubes.xml
index 413070e..4bb5c74 100644
--- a/docs/book/C/tubes.xml
+++ b/docs/book/C/tubes.xml
@@ -1,29 +1,7 @@
<?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" [
-
- <!-- 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 mdash "—">
- <!ENTITY appversion "0.7">
- <!ENTITY manrevision "0.2">
- <!ENTITY date "12 August 2008">
- <!ENTITY app_no_markup "Telepathy">
- <!ENTITY app "<application>&app_no_markup;</application>">
- <!ENTITY url_examples_base "./examples/">
- <!ENTITY url_spec "http://telepathy.freedesktop.org/spec.html">
- <!ENTITY url_spec_base "&url_spec;#org.freedesktop.Telepathy.">
- <!ENTITY url_telepathy_glib_base "http://telepathy.freedesktop.org/doc/telepathy-glib/telepathy-glib-">
- <!ENTITY url_dbus_spec_base "http://dbus.freedesktop.org/doc/dbus-specification.html#">
- <!ENTITY url_dbus_glib_base "http://dbus.freedesktop.org/doc/dbus-glib/">
- <!ENTITY url_dbus_python_base "http://dbus.freedesktop.org/doc/dbus-python/api/">
]>
<chapter id="chapter.tubes">
--
1.5.6.5
More information about the telepathy-commits
mailing list