doc: remove redundant subtitles
authorBill Spitzak <spitzak@gmail.com>
Sat, 3 Jan 2015 02:29:22 +0000 (18:29 -0800)
committerBryce Harrington <bryce@osg.samsung.com>
Sat, 24 Jan 2015 02:45:03 +0000 (18:45 -0800)
Put the argument lists next to the event/message title, which I
think makes it a lot easier to understand, and remove redundant
"values" title from enumerations.

Reviewed-by: Derek Foreman <derekf@osg.samsung.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
doc/publican/protocol-to-docbook.xsl

index ca1308f..a886b7f 100644 (file)
 </xsl:template>
 
 <!-- Request/event list -->
-<xsl:template match="request|event|enum">
+<xsl:template match="request|event">
   <section id="protocol-spec-{../@name}-{name()}-{@name}">
     <title>
       <xsl:value-of select="../@name"/>::<xsl:value-of select="@name" />
         - <xsl:value-of select="description/@summary" />
       </xsl:if>
     </title>
-    <xsl:call-template name="break">
-      <xsl:with-param name="text" select="description" />
-    </xsl:call-template>
-    <xsl:if test="arg">
+    <para>
       <variablelist>
-        <title><xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> arguments</title>
         <xsl:apply-templates select="arg"/>
       </variablelist>
-    </xsl:if>
-    <xsl:if test="entry">
-      <variablelist>
-        <title><xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> values</title>
-          <xsl:apply-templates select="entry"/>
-      </variablelist>
-    </xsl:if>
+    </para>
+    <xsl:call-template name="break">
+      <xsl:with-param name="text" select="description" />
+    </xsl:call-template>
+  </section>
+</xsl:template>
+
+<!-- Enumeration -->
+<xsl:template match="enum">
+  <section id="protocol-spec-{../@name}-{name()}-{@name}">
+    <title>
+      <xsl:value-of select="../@name"/>::<xsl:value-of select="@name" />
+      <xsl:if test="description/@summary">
+        - <xsl:value-of select="description/@summary" />
+      </xsl:if>
+    </title>
+    <xsl:call-template name="break">
+      <xsl:with-param name="text" select="description" />
+    </xsl:call-template>
+    <variablelist>
+      <xsl:apply-templates select="entry"/>
+    </variablelist>
   </section>
 </xsl:template>
+
 </xsl:stylesheet>
 
 <!-- vim: set expandtab shiftwidth=2: -->