[PATCH 7/7] doc: Intro text for doxygen output in it's own file
Bill Spitzak
spitzak at gmail.com
Thu Dec 18 20:15:11 PST 2014
Removed this text from the doxygen->publican converter. This makes it possible
to customize the text. This versions produce the same text as before
except I changed "server" to "compositor". Somebody with more understanding
of Wayland may want to improve the text.
---
doc/publican/Makefile.am | 4 ++-
doc/publican/doxygen-to-publican.xsl | 51 ++++++----------------------------
doc/publican/sources/Client.xml | 25 +++++++++++++++++
doc/publican/sources/Server.xml | 25 +++++++++++++++++
doc/publican/sources/Wayland.xml | 4 +--
5 files changed, 64 insertions(+), 45 deletions(-)
create mode 100644 doc/publican/sources/Client.xml
create mode 100644 doc/publican/sources/Server.xml
diff --git a/doc/publican/Makefile.am b/doc/publican/Makefile.am
index 278da12..42bfb73 100644
--- a/doc/publican/Makefile.am
+++ b/doc/publican/Makefile.am
@@ -27,7 +27,9 @@ publican_sources = \
$(srcdir)/sources/images/icon.svg \
$(srcdir)/sources/images/wayland-architecture.png \
$(srcdir)/sources/images/wayland.png \
- $(srcdir)/sources/images/x-architecture.png
+ $(srcdir)/sources/images/x-architecture.png \
+ $(srcdir)/sources/Client.xml \
+ $(srcdir)/sources/Server.xml
css_sources = \
$(srcdir)/sources/css/brand.css \
diff --git a/doc/publican/doxygen-to-publican.xsl b/doc/publican/doxygen-to-publican.xsl
index a151628..ee57374 100644
--- a/doc/publican/doxygen-to-publican.xsl
+++ b/doc/publican/doxygen-to-publican.xsl
@@ -4,49 +4,16 @@
<xsl:param name="which" />
<xsl:template match="/">
- <!-- insert docbook's DOCTYPE blurb -->
- <xsl:text disable-output-escaping = "yes"><![CDATA[
-<!DOCTYPE appendix 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;
-]>
-]]></xsl:text>
-
- <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>
- 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
- <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:apply-templates select="/doxygen/compounddef[@kind!='file' and @kind!='dir']" />
-
- <section id="{$which}-Functions">
- <title>Functions</title>
- <para />
- <variablelist>
- <xsl:apply-templates select="/doxygen/compounddef[@kind='file']/sectiondef/memberdef" />
- </variablelist>
- </section>
+ <xsl:apply-templates select="/doxygen/compounddef[@kind!='file' and @kind!='dir']" />
+
+ <section id="{$which}-Functions">
+ <title>Functions</title>
+ <para />
+ <variablelist>
+ <xsl:apply-templates select="/doxygen/compounddef[@kind='file']/sectiondef/memberdef" />
+ </variablelist>
+ </section>
- </appendix>
</xsl:template>
<xsl:template match="parameteritem">
diff --git a/doc/publican/sources/Client.xml b/doc/publican/sources/Client.xml
new file mode 100644
index 0000000..07cfe06
--- /dev/null
+++ b/doc/publican/sources/Client.xml
@@ -0,0 +1,25 @@
+<?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">
+ <!ENTITY doxygen SYSTEM "ClientAPI.xml">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect-Library-Client">
+ <title>Client API</title>
+ <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>
+ This appendix describes in detail the client library's methods and
+ their helpers, aiming implementors who are building a Wayland
+ client.
+ </para>
+ &doxygen;
+</appendix>
+
diff --git a/doc/publican/sources/Server.xml b/doc/publican/sources/Server.xml
new file mode 100644
index 0000000..d9117e6
--- /dev/null
+++ b/doc/publican/sources/Server.xml
@@ -0,0 +1,25 @@
+<?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">
+ <!ENTITY doxygen SYSTEM "ServerAPI.xml">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect-Library-Server">
+ <title>Server API</title>
+ <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>
+ This appendix describes in detail the server library's methods and
+ their helpers, aiming implementors who are building a Wayland
+ compositor.
+ </para>
+ &doxygen;
+</appendix>
+
diff --git a/doc/publican/sources/Wayland.xml b/doc/publican/sources/Wayland.xml
index 5ae90bb..d789b43 100644
--- a/doc/publican/sources/Wayland.xml
+++ b/doc/publican/sources/Wayland.xml
@@ -12,7 +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="ClientAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="ServerAPI.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="Client.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="Server.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</book>
--
1.7.9.5
More information about the wayland-devel
mailing list