doc: Split libwayland-client and -server into different pages

This was suggested before to make it clearer that things like wl_display
are different objects in each of them. I made these into two appendixes
because the protocol spec was already an appendix.

Reviewed-by: Bryce Harrington <b.harrington@samsung.com>
[Bryce requested minor changes, not yet here.]

Acked-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>

diff --git a/doc/publican/Makefile.am b/doc/publican/Makefile.am
index 8ed3815..c109795 100644 (file)
--- a/doc/publican/Makefile.am
+++ b/doc/publican/Makefile.am
@@ -25,7 +25,6 @@ publican_sources = \
        $(srcdir)/sources/Introduction.xml \
        $(srcdir)/sources/Architecture.xml \
        $(srcdir)/sources/Protocol.xml \
-       $(srcdir)/sources/Library.xml \
        $(srcdir)/sources/Compositors.xml \
        $(srcdir)/sources/images/icon.svg  \
        $(srcdir)/sources/images/wayland-architecture.png \

diff --git a/doc/publican/doxygen-to-publican.xsl b/doc/publican/doxygen-to-publican.xsl
index d8f3289..53fc60f 100644 (file)
--- a/doc/publican/doxygen-to-publican.xsl
+++ b/doc/publican/doxygen-to-publican.xsl
@@ -12,13 +12,29 @@
 ]>
 ]]></xsl:text>
 
-  <section id="sect-Library-$which">
+  <appendix id="sect-Library-$which">
     <xsl:attribute name="id">sect-Library-<xsl:value-of select="$which"/></xsl:attribute>
     <title><xsl:value-of select="$which"/> API</title>
-    <para>Following is the Wayland library classes for the <xsl:value-of select="$which"/>
-      (<emphasis>libwayland-<xsl:value-of select="translate($which, 'SC', 'sc')"/></emphasis>).
-      Note that most of the procedures are related with IPC, which is the main responsibility of
-      the library.
+
+    <para>
+      The open-source reference implementation of Wayland protocol is
+      split in two C libraries, <link
+      linkend="sect-Library-Client">libwayland-client</link> and <link
+      linkend="sect-Library-Server">libwayland-server</link>. Their
+      main responsibility is to handle the Inter-process communication
+      (<emphasis>IPC</emphasis>) with each other, therefore
+      guaranteeing the protocol objects marshaling and messages
+      synchronization.
+    </para>
+
+    <para>
+      Following is the Wayland library classes for the
+      <xsl:value-of select="$which"/>
+      (<emphasis>libwayland-<xsl:value-of select="translate($which,
+      'SC', 'sc')"/></emphasis>).  This appendix describes in detail
+      the library's methods and their helpers, aiming implementors who
+      are building a Wayland <xsl:value-of select="translate($which,
+      'SC', 'sc')"/>.
     </para>
 
     <xsl:if test="/doxygen/compounddef[@kind='class']">
@@ -36,7 +52,7 @@
     <xsl:apply-templates select="/doxygen/compounddef/sectiondef/memberdef" />
     </variablelist>
     </para>
-  </section>
+  </appendix>
 </xsl:template>
 
 <xsl:template match="parameteritem">

diff --git a/doc/publican/sources/Library.xml b/doc/publican/sources/Library.xml
deleted file mode 100644 (file)
index bc8c89e..0000000
--- a/doc/publican/sources/Library.xml
+++ /dev/null
@@ -1,27 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "Wayland.ent">
-%BOOK_ENTITIES;
-]>
-<chapter id="chap-Library">
-  <title>Wayland Library</title>
-
-  <para>
-  The open-source reference implementation of Wayland protocol is split in two
-  C libraries, <link linkend="sect-Library-Server">libwayland-server</link> and
-  <link linkend="sect-Library-Client">libwayland-client</link>. Their main
-  responsibility is to handle the Inter-process communication
-  (<emphasis>IPC</emphasis>) with each other, therefore guaranteeing the
-  protocol objects marshaling and messages synchronization.
-  </para>
-
-  <para>
-  This Chapter describes in detail each library's methods and their helpers,
-  aiming implementors who can use for building Wayland clients and servers;
-  respectively at <xref linkend="sect-Library-Client"/> and
-  <xref linkend="sect-Library-Server"/>.
-  </para>
-
-  <xi:include href="WaylandClientAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="WaylandServerAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</chapter>

diff --git a/doc/publican/sources/Wayland.xml b/doc/publican/sources/Wayland.xml
index 24a9876..bdf8930 100644 (file)
--- a/doc/publican/sources/Wayland.xml
+++ b/doc/publican/sources/Wayland.xml
@@ -12,6 +12,7 @@
   <xi:include href="Architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
   <xi:include href="Protocol.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
   <xi:include href="ProtocolSpec.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-  <xi:include href="Library.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+  <xi:include href="WaylandClientAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="WaylandServerAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 </book>