[PATCH 2/7] doc: removed the word "interface" from the link names
Bill Spitzak
spitzak at gmail.com
Thu Dec 18 20:15:06 PST 2014
Just to make it slightly shorter.
Also add a dash to the doxygen links to make them look a bit more alike.
---
doc/publican/doxygen-to-publican.xsl | 6 +++---
doc/publican/protocol-interfaces-to-docbook.xsl | 10 +++++-----
doc/publican/protocol-to-docbook.xsl | 7 ++-----
doc/publican/sources/Protocol.xml | 16 ++++++++--------
4 files changed, 18 insertions(+), 21 deletions(-)
diff --git a/doc/publican/doxygen-to-publican.xsl b/doc/publican/doxygen-to-publican.xsl
index 5adbfa6..0ed7030 100644
--- a/doc/publican/doxygen-to-publican.xsl
+++ b/doc/publican/doxygen-to-publican.xsl
@@ -70,7 +70,7 @@
</xsl:template>
<xsl:template match="ref">
- <link linkend="{$which}{@refid}"><xsl:value-of select="." /></link>
+ <link linkend="{$which}-{@refid}"><xsl:value-of select="." /></link>
</xsl:template>
<xsl:template match="simplesect[@kind='return']">
@@ -123,7 +123,7 @@
<!-- methods -->
<xsl:template match="memberdef" >
<xsl:if test="@kind = 'function' and @static = 'no'">
- <varlistentry id="{$which}{@id}">
+ <varlistentry id="{$which}-{@id}">
<term>
<xsl:value-of select="name"/>
<xsl:if test="normalize-space(briefdescription) != ''">
@@ -143,7 +143,7 @@
<!-- classes -->
<xsl:template match="compounddef" >
<xsl:if test="@kind = 'class'">
- <varlistentry id="{$which}{@id}">
+ <varlistentry id="{$which}-{@id}">
<term>
<xsl:value-of select="compoundname" />
<xsl:if test="normalize-space(briefdescription) != ''">
diff --git a/doc/publican/protocol-interfaces-to-docbook.xsl b/doc/publican/protocol-interfaces-to-docbook.xsl
index 57b3139..f68216d 100644
--- a/doc/publican/protocol-interfaces-to-docbook.xsl
+++ b/doc/publican/protocol-interfaces-to-docbook.xsl
@@ -23,10 +23,10 @@
</para>
<para>
- Core interfaces:
- <variablelist>
- <xsl:apply-templates select="protocol/interface" />
- </variablelist>
+ Core interfaces:
+ <variablelist>
+ <xsl:apply-templates select="protocol/interface" />
+ </variablelist>
</para>
</section>
</xsl:template>
@@ -35,7 +35,7 @@
<xsl:template match="interface" >
<varlistentry>
<term>
- <link linkend="protocol-spec-interface-{@name}">
+ <link linkend="protocol-spec-{@name}">
<xsl:value-of select="@name" />
</link>
</term>
diff --git a/doc/publican/protocol-to-docbook.xsl b/doc/publican/protocol-to-docbook.xsl
index a43c9fa..354ff3a 100644
--- a/doc/publican/protocol-to-docbook.xsl
+++ b/doc/publican/protocol-to-docbook.xsl
@@ -49,9 +49,7 @@
<!-- Interface descriptions -->
<xsl:template match="interface" >
- <section>
- <xsl:attribute name="id">protocol-spec-<xsl:value-of select="name()"/>-<xsl:value-of select="@name" />
- </xsl:attribute>
+ <section id="protocol-spec-{@name}">
<title>
<xsl:value-of select="@name" />
<!-- only show summary if it exists -->
@@ -103,8 +101,7 @@
<!-- Request/event list -->
<xsl:template match="request|event|enum">
- <section>
- <xsl:attribute name="id">protocol-spec-interface-<xsl:value-of select="../@name"/>-<xsl:value-of select="name()"/>-<xsl:value-of select="@name"/></xsl:attribute>
+ <section id="protocol-spec-{../@name}-{name()}-{@name}">
<title>
<xsl:value-of select="../@name"/>::<xsl:value-of select="@name" />
<xsl:if test="description/@summary">
diff --git a/doc/publican/sources/Protocol.xml b/doc/publican/sources/Protocol.xml
index b79b6be..5f3e852 100644
--- a/doc/publican/sources/Protocol.xml
+++ b/doc/publican/sources/Protocol.xml
@@ -275,7 +275,7 @@
The compositor is a global object, advertised at connect time.
</para>
<para>
- See <xref linkend="protocol-spec-interface-wl_compositor"/> for the
+ See <xref linkend="protocol-spec-wl_compositor"/> for the
protocol description.
</para>
</section>
@@ -287,7 +287,7 @@
cannot access other clients surfaces.
</para>
<para>
- See <xref linkend="protocol-spec-interface-wl_surface"/> for the protocol
+ See <xref linkend="protocol-spec-wl_surface"/> for the protocol
description.
</para>
</section>
@@ -324,7 +324,7 @@
or triple clicks.
</para>
<para>
- See <xref linkend="protocol-spec-interface-wl_seat"/> for the
+ See <xref linkend="protocol-spec-wl_seat"/> for the
protocol description.
</para>
<para>
@@ -383,7 +383,7 @@
comes and goes.
</para>
<para>
- See <xref linkend="protocol-spec-interface-wl_output"/> for the protocol
+ See <xref linkend="protocol-spec-wl_output"/> for the protocol
description.
</para>
<para>
@@ -432,10 +432,10 @@
that implements copy-paste and drag-and-drop support.
</para>
<para>
- See <xref linkend="protocol-spec-interface-wl_data_offer"/>,
- <xref linkend="protocol-spec-interface-wl_data_source"/>,
- <xref linkend="protocol-spec-interface-wl_data_device"/> and
- <xref linkend="protocol-spec-interface-wl_data_device_manager"/> for
+ See <xref linkend="protocol-spec-wl_data_offer"/>,
+ <xref linkend="protocol-spec-wl_data_source"/>,
+ <xref linkend="protocol-spec-wl_data_device"/> and
+ <xref linkend="protocol-spec-wl_data_device_manager"/> for
protocol descriptions.
</para>
<para>
--
1.7.9.5
More information about the wayland-devel
mailing list