diff --git a/doc/Wayland/Makefile.am b/doc/Wayland/Makefile.am index c9ee5099..ae68d73b 100644 --- a/doc/Wayland/Makefile.am +++ b/doc/Wayland/Makefile.am @@ -8,7 +8,7 @@ publican_sources = \ $(srcdir)/en_US/Author_Group.xml \ $(srcdir)/en_US/Book_Info.xml \ $(srcdir)/en_US/Wayland.xml \ - $(srcdir)/en_US/WaylandProtocol.xml \ + $(srcdir)/en_US/Protocol.xml \ $(srcdir)/en_US/Compositors.xml \ $(srcdir)/en_US/Overview.xml \ $(srcdir)/en_US/images/icon.svg \ @@ -17,18 +17,18 @@ publican_sources = \ $(srcdir)/en_US/images/x-architecture.png publican_targets = $(publican_sources:$(srcdir)/en_US%=$(builddir)/en-US%) \ - en-US/Protocol.xml + en-US/ProtocolSpec.xml # The Protocol.xml is purely generated and required before running publican -en-US/Protocol.xml: $(top_srcdir)/protocol/wayland.xml $(srcdir)/protocol-to-docbook.xsl +en-US/ProtocolSpec.xml: $(top_srcdir)/protocol/wayland.xml $(srcdir)/protocol-to-docbook.xsl $(AM_V_GEN)$(MKDIR_P) en-US/images $(AM_V_GEN)$(XSLTPROC) $(srcdir)/protocol-to-docbook.xsl \ - $(top_srcdir)/protocol/wayland.xml > en-US/Protocol.xml + $(top_srcdir)/protocol/wayland.xml > en-US/ProtocolSpec.xml # Copy the en_US source files into en-US destination # This is required for out-of-source-tree build as publican does not allow us # to specify the location of the source code. -$(builddir)/en-US/%: $(srcdir)/en_US/% en-US/Protocol.xml $(publican_sources) +$(builddir)/en-US/%: $(srcdir)/en_US/% en-US/ProtocolSpec.xml $(publican_sources) $(AM_V_GEN)cp -f $< $@ # Run publican for the builddir on the generated (or copied) source @@ -37,7 +37,7 @@ Wayland: $(publican_targets) $(AM_V_GEN)$(PUBLICAN) build --lang en-US --format html,pdf \ --config $(srcdir)/publican.cfg -CLEANFILES = en-US/Protocol.xml $(publican_targets) +CLEANFILES = en-US/ProtocolSpec.xml $(publican_targets) clean-local: $(AM_V_at)rm -fr en-US diff --git a/doc/Wayland/en_US/WaylandProtocol.xml b/doc/Wayland/en_US/Protocol.xml similarity index 94% rename from doc/Wayland/en_US/WaylandProtocol.xml rename to doc/Wayland/en_US/Protocol.xml index f31bdfee..3a4172be 100644 --- a/doc/Wayland/en_US/WaylandProtocol.xml +++ b/doc/Wayland/en_US/Protocol.xml @@ -3,9 +3,9 @@ %BOOK_ENTITIES; ]> - + The Wayland Protocol -
+
Basic Principles The wayland protocol is an asynchronous object oriented protocol. All @@ -41,7 +41,7 @@
-
+
Code Generation The interfaces, requests and events are defined in @@ -56,7 +56,7 @@ own stubs for the protocol entry points from the xml.
-
+
Wire Format The protocol is sent over a UNIX domain stream socket. Currently, the @@ -151,7 +151,7 @@
-
+
Interfaces The protocol includes several interfaces which are used for @@ -276,7 +276,7 @@
-
+
Connect Time @@ -295,7 +295,7 @@
-
+
Security and Authentication @@ -316,7 +316,7 @@
-
+
Creating Objects @@ -334,7 +334,7 @@
-
+
Compositor The compositor is a global object, advertised at connect time. @@ -344,20 +344,20 @@ protocol description.
-
+
Surface Created by the client. - See for the protocol + See for the protocol description. Needs a way to set input region, opaque region.
-
+
Input Represents a group of input devices, including mice, keyboards. Has a @@ -365,7 +365,7 @@ delivered in both screen coordinates and surface local coordinates. - See for the + See for the protocol description. @@ -417,14 +417,14 @@ image, the image will flicker. Broken app, I suppose.
-
+
Output A output is a global object, advertised at connect time or as they come and go. - See for the protocol + See for the protocol description. @@ -453,7 +453,7 @@
-
+
Shared Object Cache Cache for sharing glyphs, icons, cursors across clients. Lets clients @@ -508,7 +508,7 @@
-
+
Drag and Drop Multi-device aware. Orthogonal to rest of wayland, as it is its own @@ -517,9 +517,9 @@ expose mode, for example). - See , - and - for + See , + and + for protocol descriptions. diff --git a/doc/Wayland/en_US/Wayland.xml b/doc/Wayland/en_US/Wayland.xml index 12766ffb..c610bcc4 100644 --- a/doc/Wayland/en_US/Wayland.xml +++ b/doc/Wayland/en_US/Wayland.xml @@ -7,9 +7,9 @@ - - + + diff --git a/doc/Wayland/protocol-to-docbook.xsl b/doc/Wayland/protocol-to-docbook.xsl index e50d80d9..be7cba3d 100644 --- a/doc/Wayland/protocol-to-docbook.xsl +++ b/doc/Wayland/protocol-to-docbook.xsl @@ -32,7 +32,7 @@
- protocol-- + protocol-spec-- <xsl:value-of select="@name" /> @@ -86,7 +86,7 @@ <!-- Request/event list --> <xsl:template match="request|event|enum"> <section> - <xsl:attribute name="id">protocol-interface-<xsl:value-of select="../@name"/>-<xsl:value-of select="name()"/>-<xsl:value-of select="@name"/></xsl:attribute> + <xsl:attribute name="id">protocol-spec-interface-<xsl:value-of select="../@name"/>-<xsl:value-of select="name()"/>-<xsl:value-of select="@name"/></xsl:attribute> <title> <xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> <xsl:if test="description/@summary">