diff options
author | William Jon McCann <jmccann@redhat.com> | 2008-07-24 00:32:21 -0400 |
---|---|---|
committer | William Jon McCann <jmccann@redhat.com> | 2008-07-24 00:32:21 -0400 |
commit | 77fe8e2e89af7cd21357116e9668b23d958fb2a5 (patch) | |
tree | 21e35d57d51ee76d5b8d36887e2b648be9621494 /doc | |
parent | 3133a9ad1a1eb05ad6717d8ee8ede782b833ee67 (diff) |
pull updated DTD and xsl from DeviceKit-disks
Diffstat (limited to 'doc')
-rw-r--r-- | doc/dbus-introspect-docs.dtd | 4 | ||||
-rw-r--r-- | doc/xml/spec-to-docbook.xsl | 171 |
2 files changed, 141 insertions, 34 deletions
diff --git a/doc/dbus-introspect-docs.dtd b/doc/dbus-introspect-docs.dtd index 5fe508e..ca918fb 100644 --- a/doc/dbus-introspect-docs.dtd +++ b/doc/dbus-introspect-docs.dtd @@ -19,8 +19,8 @@ <!ELEMENT example (#PCDATA|para|code|ref)*> <!ATTLIST language (c|glib|python|shell) #REQUIRED> <!ATTLIST title CDATA #IMPLIED> -<!ELEMENT list (listheader?, item*)> -<!ATTLIST list type (bullet|number|table) #REQUIRED> +<!ELEMENT list (item*)> +<!ATTLIST list type (bullet|number) #REQUIRED> <!ELEMENT item (term|definition)*> <!ELEMENT term (#PCDATA|ref)*> <!ELEMENT definition (#PCDATA|para)*> diff --git a/doc/xml/spec-to-docbook.xsl b/doc/xml/spec-to-docbook.xsl index fccf887..1864414 100644 --- a/doc/xml/spec-to-docbook.xsl +++ b/doc/xml/spec-to-docbook.xsl @@ -37,32 +37,40 @@ </synopsis> </refsynopsisdiv> - <refsect1 role="signal_proto"> - <title role="signal_proto.title">Signals</title> - <synopsis> - <xsl:call-template name="signals-synopsis"> - <xsl:with-param name="basename" select="$basename"/> - </xsl:call-template> - </synopsis> - </refsect1> + <xsl:choose> + <xsl:when test="count(///signal) > 0"> + <refsect1 role="signal_proto"> + <title role="signal_proto.title">Signals</title> + <synopsis> + <xsl:call-template name="signals-synopsis"> + <xsl:with-param name="basename" select="$basename"/> + </xsl:call-template> + </synopsis> + </refsect1> + </xsl:when> + </xsl:choose> <refsect1 role="impl_interfaces"> <title role="impl_interfaces.title">Implemented Interfaces</title> <para> - <xsl:value-of select="$interface"/> implements + Objects implementing <xsl:value-of select="$interface"/> also implements org.freedesktop.DBus.Introspectable, org.freedesktop.DBus.Properties </para> </refsect1> - <refsect1 role="properties"> - <title role="properties.title">Properties</title> - <synopsis> - <xsl:call-template name="properties-synopsis"> - <xsl:with-param name="basename" select="$basename"/> - </xsl:call-template> - </synopsis> - </refsect1> + <xsl:choose> + <xsl:when test="count(///property) > 0"> + <refsect1 role="properties"> + <title role="properties.title">Properties</title> + <synopsis> + <xsl:call-template name="properties-synopsis"> + <xsl:with-param name="basename" select="$basename"/> + </xsl:call-template> + </synopsis> + </refsect1> + </xsl:when> + </xsl:choose> <refsect1 role="desc"> <title role="desc.title">Description</title> @@ -78,19 +86,27 @@ </xsl:call-template> </refsect1> - <refsect1 role="signals"> - <title role="signals.title">Signal Details</title> - <xsl:call-template name="signal-details"> - <xsl:with-param name="basename" select="$basename"/> - </xsl:call-template> - </refsect1> + <xsl:choose> + <xsl:when test="count(///signal) > 0"> + <refsect1 role="signals"> + <title role="signals.title">Signal Details</title> + <xsl:call-template name="signal-details"> + <xsl:with-param name="basename" select="$basename"/> + </xsl:call-template> + </refsect1> + </xsl:when> + </xsl:choose> - <refsect1 role="property_details"> - <title role="property_details.title">Property Details</title> - <xsl:call-template name="property-details"> - <xsl:with-param name="basename" select="$basename"/> - </xsl:call-template> - </refsect1> + <xsl:choose> + <xsl:when test="count(///property) > 0"> + <refsect1 role="property_details"> + <title role="property_details.title">Property Details</title> + <xsl:call-template name="property-details"> + <xsl:with-param name="basename" select="$basename"/> + </xsl:call-template> + </refsect1> + </xsl:when> + </xsl:choose> </refentry> </xsl:template> @@ -176,8 +192,33 @@ </programlisting> </xsl:template> +<xsl:template match="doc:tt"> + <literal> + <xsl:apply-templates /> + </literal> +</xsl:template> + +<xsl:template match="doc:i"> + <emphasis> + <xsl:apply-templates /> + </emphasis> +</xsl:template> + +<xsl:template match="doc:b"> + <emphasis role="bold"> + <xsl:apply-templates /> + </emphasis> +</xsl:template> + +<xsl:template match="doc:ulink"> + <ulink> + <xsl:attribute name="url"><xsl:value-of select="@url"/></xsl:attribute> + <xsl:value-of select="."/> + </ulink> +</xsl:template> + <xsl:template match="doc:summary"> -<!-- by default don't display --> + <xsl:apply-templates /> </xsl:template> <xsl:template match="doc:example"> @@ -186,6 +227,41 @@ </informalexample> </xsl:template> +<xsl:template name="listitems-do-term"> + <xsl:param name="str"/> + <xsl:choose> + <xsl:when test="string-length($str) > 0"> + <emphasis role="bold"><xsl:value-of select="$str"/>: </emphasis> + </xsl:when> + </xsl:choose> +</xsl:template> + +<xsl:template name="do-listitems"> + <xsl:for-each select="doc:item"> + <listitem> + <xsl:call-template name="listitems-do-term"><xsl:with-param name="str" select="doc:term"/></xsl:call-template> + <xsl:apply-templates select="doc:definition"/> + </listitem> + </xsl:for-each> +</xsl:template> + +<xsl:template match="doc:list"> + <para> + <xsl:choose> + <xsl:when test="contains(@type,'number')"> + <orderedlist> + <xsl:call-template name="do-listitems"/> + </orderedlist> + </xsl:when> + <xsl:otherwise> + <itemizedlist> + <xsl:call-template name="do-listitems"/> + </itemizedlist> + </xsl:otherwise> + </xsl:choose> + </para> +</xsl:template> + <xsl:template match="doc:para"> <para> <xsl:apply-templates /> @@ -249,6 +325,12 @@ instead.</para></warning> </para> </xsl:template> +<xsl:template match="doc:errors"> +<para role="errors"> +<xsl:apply-templates /> +</para> +</xsl:template> + <xsl:template match="doc:seealso"> <para> See also: @@ -292,14 +374,39 @@ See also: <variablelist role="params"> <xsl:for-each select="arg"> <varlistentry><term><parameter><xsl:value-of select="@name"/></parameter>:</term> -<listitem><simpara><xsl:value-of select="doc:doc/doc:summary"/></simpara></listitem> +<listitem><simpara><xsl:apply-templates select="doc:doc/doc:summary"/></simpara></listitem> </varlistentry> </xsl:for-each> </variablelist> <xsl:apply-templates select="doc:doc/doc:since"/> <xsl:apply-templates select="doc:doc/doc:deprecated"/> - <xsl:apply-templates select="doc:doc/doc:permission"/> + + <xsl:choose> + <xsl:when test="count(doc:doc/doc:errors) > 0"> + <refsect3> + <title>Errors</title> + <variablelist role="errors"> + <xsl:for-each select="doc:doc/doc:errors/doc:error"> + <varlistentry> + <term><parameter><xsl:value-of select="@name"/></parameter>:</term> + <listitem><simpara><xsl:apply-templates select="."/></simpara></listitem> + </varlistentry> + </xsl:for-each> + </variablelist> + </refsect3> + </xsl:when> + </xsl:choose> + + <xsl:choose> + <xsl:when test="count(doc:doc/doc:permission) > 0"> + <refsect3> + <title>Permissions</title> + <xsl:apply-templates select="doc:doc/doc:permission"/> + </refsect3> + </xsl:when> + </xsl:choose> + <xsl:apply-templates select="doc:doc/doc:seealso"/> </xsl:template> |