summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Leupold <lemma@leunet.de>2009-08-01 15:56:23 +0200
committerStef Walter <stefw@collabora.co.uk>2010-12-04 16:11:41 +0000
commitc250c5aefcc8e14ffa54463a694c26370c1bcf6a (patch)
tree872c65669a8ac3c2db1d7610c43c1b2d08576460
parent28ed9f02cd60403d2b1a92c13f1c06058fa58136 (diff)
downloadxdg-specs-c250c5aefcc8e14ffa54463a694c26370c1bcf6a.tar.xz
-> Docbook 5.0
-rw-r--r--secret-service/params-html.xsl1
-rw-r--r--secret-service/specification.xml22
-rw-r--r--secret-service/tools/spec-to-docbook.xsl335
3 files changed, 226 insertions, 132 deletions
diff --git a/secret-service/params-html.xsl b/secret-service/params-html.xsl
index 5f3fb27..cc73eee 100644
--- a/secret-service/params-html.xsl
+++ b/secret-service/params-html.xsl
@@ -30,5 +30,6 @@
</xsl:param>
<xsl:param name="html.stylesheet">style.css</xsl:param>
<xsl:param name="funcsynopsis.style">ansi</xsl:param>
+ <xsl:param name="funcsynopsis.decoration">1</xsl:param>
</xsl:stylesheet>
diff --git a/secret-service/specification.xml b/secret-service/specification.xml
index b631b6f..7c1eafd 100644
--- a/secret-service/specification.xml
+++ b/secret-service/specification.xml
@@ -1,7 +1,5 @@
<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
- "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
-<book id="index">
+<book xml:id="index" xmlns="http://docbook.org/ns/docbook" version="5.0">
<bookinfo>
<title>Secrets API Specification</title>
<releaseinfo>
@@ -40,7 +38,7 @@
</bookinfo>
- <part id="description">
+ <part xml:id="description">
<title>API Documentation</title>
<chapter>
<title>Introduction</title>
@@ -140,7 +138,7 @@
be deleted by any application.</para>
</chapter>
- <chapter id="lookup-attributes">
+ <chapter xml:id="lookup-attributes">
<title>Lookup Attributes</title>
<para>Attributes can and should be stored with a secret to facilitate lookup
@@ -161,7 +159,7 @@
manner in order to support simple and effecient lookups.</para>
</chapter>
- <chapter id="sessions">
+ <chapter xml:id="sessions">
<title>Sessions</title>
<para>A session is established between a client application and a service. A session
@@ -186,7 +184,7 @@
negotiations and authentication should be dropped by the service.</para>
</chapter>
- <chapter id='transfer-secrets'>
+ <chapter xml:id='transfer-secrets'>
<title>Transfer of Secrets</title>
<para>Since this is a D-Bus API, the data in all method calls and other accesses
@@ -293,7 +291,7 @@
</chapter>
- <chapter id='authentication-unlocking'>
+ <chapter xml:id='authentication-unlocking'>
<title>Authentication or Unlocking</title>
<para>Some items and/or collections may be marked as locked by the service.
@@ -368,10 +366,10 @@
</part>
- <part id="ref-dbus-api">
+ <part xml:id="ref-dbus-api">
<title>D-Bus API Reference</title>
- <chapter id='object-paths'>
+ <chapter xml:id='object-paths'>
<title>Object Paths</title>
<para>The various DBus object paths used with the Secrets API are designed to be human
@@ -411,11 +409,11 @@
</part>
<!--
- <chapter id="object-tree">
+ <chapter xml:id="object-tree">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
- <index id="api-index-full">
+ <index xml:id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
diff --git a/secret-service/tools/spec-to-docbook.xsl b/secret-service/tools/spec-to-docbook.xsl
index 1de1f89..b2cadd6 100644
--- a/secret-service/tools/spec-to-docbook.xsl
+++ b/secret-service/tools/spec-to-docbook.xsl
@@ -28,9 +28,7 @@
-->
<xsl:output method="xml" indent="yes" encoding="ascii"
- omit-xml-declaration="no"
- doctype-system="docbookV4.5/docbookx.dtd"
- doctype-public="-//OASIS//DTD DocBook XML V4.5//EN"/>
+ omit-xml-declaration="no"/>
<xsl:include href="resolve-type.xsl"/>
@@ -192,7 +190,8 @@
</xsl:template>
<xsl:template name="generic-types">
- <chapter id="types">
+ <chapter>
+ <xsl:attribute name="xml:id">types</xsl:attribute>
<title>Types</title>
<xsl:call-template name="do-types"/>
</chapter>
@@ -246,7 +245,10 @@
<xsl:template match="tp:error">
<simplesect>
- <title id="{concat(../@namespace, '.', translate(@name, ' ', ''))}">
+ <title>
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="concat(../@namespace, '.', translate(@name, ' ', ''))"/>
+ </xsl:attribute>
<literal><xsl:value-of select="concat(../@namespace, '.', translate(@name, ' ', ''))"/></literal>
</title>
<xsl:apply-templates select="tp:docstring"/>
@@ -274,85 +276,130 @@
<xsl:template match="tp:copyright"/>
<xsl:template match="tp:license"/>
- <xsl:template match="interface"><section>
- <title id="{@name}"><literal><xsl:value-of select="@name"/></literal></title>
+ <xsl:template match="interface">
- <xsl:if test="@tp:causes-havoc">
- <warning>
- <para>
- This interface is <xsl:value-of select="@tp:causes-havoc"/>
- and is likely to cause havoc to your API/ABI if bindings are generated.
- Don't include it in libraries that care about compatibility.
- </para>
- </warning>
- </xsl:if>
+ <refentry>
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="@name"/>
+ </xsl:attribute>
+ <refmeta>
+ <refentrytitle><literal><xsl:value-of select="@name"/></literal></refentrytitle>
+ </refmeta>
+
+ <refnamediv>
+ <refdescriptor>D-Bus Interface</refdescriptor>
+ <refname><xsl:value-of select="@name"/></refname>
+ <refpurpose><xsl:apply-templates select="tp:docstring" mode="nopara"/></refpurpose>
+ </refnamediv>
+
+ <xsl:if test="tp:added">
+ <refsection>
+ <xsl:apply-templates select="tp:added"/>
+ </refsection>
+ </xsl:if>
+ <xsl:if test="tp:changed">
+ <refsection>
+ <xsl:apply-templates select="tp:changed"/>
+ </refsection>
+ </xsl:if>
+ <xsl:if test="tp:deprecated">
+ <refsection>
+ <xsl:apply-templates select="tp:deprecated"/>
+ </refsection>
+ </xsl:if>
- <xsl:if test="tp:requires">
- <tip>
- <para>Implementations of this interface must also implement:</para>
- <itemizedlist>
- <xsl:for-each select="tp:requires">
- <listitem>
- <para>
- <link linkend="{@interface}">
- <literal><xsl:value-of select="@interface"/></literal>
- </link>
- </para>
- </listitem>
- </xsl:for-each>
- </itemizedlist>
- </tip>
- </xsl:if>
+ <xsl:if test="@tp:causes-havoc">
+ <refsection>
+ <warning>
+ <para>
+ This interface is <xsl:value-of select="@tp:causes-havoc"/>
+ and is likely to cause havoc to your API/ABI if bindings are generated.
+ Don't include it in libraries that care about compatibility.
+ </para>
+ </warning>
+ </refsection>
+ </xsl:if>
- <xsl:apply-templates select="tp:docstring" />
- <xsl:apply-templates select="tp:added"/>
- <xsl:apply-templates select="tp:changed"/>
- <xsl:apply-templates select="tp:deprecated"/>
+ <xsl:if test="tp:requires">
+ <refsection>
+ <tip>
+ <para>Implementations of this interface must also implement:</para>
+ <itemizedlist>
+ <xsl:for-each select="tp:requires">
+ <listitem>
+ <para>
+ <link linkend="{@interface}">
+ <literal><xsl:value-of select="@interface"/></literal>
+ </link>
+ </para>
+ </listitem>
+ </xsl:for-each>
+ </itemizedlist>
+ </tip>
+ </refsection>
+ </xsl:if>
- <xsl:if test="method">
- <section>
- <title>Methods</title>
- <xsl:apply-templates select="method"/>
- </section>
- </xsl:if>
+ <refsynopsisdiv>
+ <xsl:if test="method">
+ <refsect2>
+ <title>Methods</title>
+ <xsl:apply-templates select="method" mode="funcsynopsislinked"/>
+ </refsect2>
+ </xsl:if>
+ <xsl:if test="signal">
+ <refsect2>
+ <title>Signals</title>
+ <xsl:apply-templates select="signal" mode="funcsynopsislinked"/>
+ </refsect2>
+ </xsl:if>
+ </refsynopsisdiv>
- <xsl:if test="signal">
- <section>
- <title>Signals</title>
- <xsl:apply-templates select="signal"/>
- </section>
- </xsl:if>
+ <xsl:if test="method">
+ <refsection>
+ <title>Methods</title>
+ <xsl:apply-templates select="method" mode="detail"/>
+ </refsection>
+ </xsl:if>
- <xsl:if test="tp:property">
- <section>
- <title>Telepathy Properties</title>
- <para>
- Accessed using the
- <link linkend="org.freedesktop.Telepathy.Properties">
- <literal>org.freedesktop.Telepathy.Properties</literal>
- </link>
- </para>
- <glosslist>
- <xsl:apply-templates select="tp:property"/>
- </glosslist>
- </section>
- </xsl:if>
+ <xsl:if test="signal">
+ <refsection>
+ <title>Signals</title>
+ <xsl:apply-templates select="signal" mode="detail"/>
+ </refsection>
+ </xsl:if>
- <xsl:if test="property">
- <section>
- <title>D-Bus Properties</title>
- <para>
- Accessed using the org.freedesktop.DBus.Properties interface.
- </para>
- <glosslist>
- <xsl:apply-templates select="property"/>
- </glosslist>
- </section>
- </xsl:if>
+ <xsl:if test="tp:property">
+ <refsection>
+ <title>Telepathy Properties</title>
+ <para>
+ Accessed using the
+ <link linkend="org.freedesktop.Telepathy.Properties">
+ <literal>org.freedesktop.Telepathy.Properties</literal>
+ </link>
+ </para>
+ <glosslist>
+ <xsl:apply-templates select="tp:property" mode="detail"/>
+ </glosslist>
+ </refsection>
+ </xsl:if>
+
+ <xsl:if test="property">
+ <refsection>
+ <title>D-Bus Properties</title>
+ <para>
+ Accessed using the org.freedesktop.DBus.Properties interface.
+ </para>
+ <glosslist>
+ <xsl:apply-templates select="property" mode="detail"/>
+ </glosslist>
+ </refsection>
+ </xsl:if>
+
+ <xsl:call-template name="do-types"/>
- <xsl:call-template name="do-types"/>
+ </refentry>
- </section></xsl:template>
+ </xsl:template>
<xsl:template match="tp:flags">
@@ -371,7 +418,10 @@
</xsl:if>
<section>
- <title id="type-{@name}"><literal><xsl:value-of select="@name"/></literal></title>
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="@name"/>
+ </xsl:attribute>
+ <title><literal><xsl:value-of select="@name"/></literal></title>
<xsl:apply-templates select="tp:docstring" />
<xsl:apply-templates select="tp:added"/>
<xsl:apply-templates select="tp:changed"/>
@@ -428,7 +478,10 @@
</xsl:if>
<section>
- <title id="type-{@name}"><literal><xsl:value-of select="@name"/></literal></title>
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="concat('type-', @name)"/>
+ </xsl:attribute>
+ <title><literal><xsl:value-of select="@name"/></literal></title>
<xsl:apply-templates select="tp:docstring" />
<xsl:apply-templates select="tp:added"/>
<xsl:apply-templates select="tp:changed"/>
@@ -468,7 +521,7 @@
</section>
</xsl:template>
- <xsl:template match="property">
+ <xsl:template match="property" mode="detail">
<xsl:if test="not(parent::interface)">
<xsl:message terminate="yes">
@@ -497,7 +550,10 @@
</xsl:if>
<glossentry>
- <glossterm id="{concat(../@name, '.', @name)}">
+ <glossterm>
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="concat(../@name, '.', @name)"/>
+ </xsl:attribute>
<property><xsl:value-of select="@name"/></property> -
<type>
<xsl:call-template name="ResolveType">
@@ -536,7 +592,7 @@
</glossentry>
</xsl:template>
- <xsl:template match="tp:property">
+ <xsl:template match="tp:property" mode="detail">
<glossentry>
<glossterm>
<xsl:if test="@name">
@@ -555,7 +611,10 @@
<xsl:template match="tp:mapping">
<section>
- <title id="type-{@name}">
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="concat('type-', @name)"/>
+ </xsl:attribute>
+ <title>
<literal><xsl:value-of select="@name"/></literal>
</title>
<xsl:apply-templates select="tp:docstring"/>
@@ -599,7 +658,10 @@
</xsl:if>
<section>
- <title id="type-{@name}">
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="concat('type-', @name)"/>
+ </xsl:attribute>
+ <title>
<literal><xsl:value-of select="@name"/> − <xsl:value-of select="@type"/></literal>
</title>
<para>
@@ -628,8 +690,11 @@
</xsl:if>
<glossentry>
- <glossterm id="type-{@name}">
- <xsl:value-of select="@name"/> − <xsl:value-of select="@type"/>
+ <glossterm>
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="concat('type-', @name)"/>
+ </xsl:attribute>
+ <xsl:value-of select="@name"/> − <xsl:value-of select="@type"/>
</glossterm>
<glossdef>Defined by: <xsl:value-of select="@from"/></glossdef>
</glossentry>
@@ -651,7 +716,10 @@
<xsl:template match="tp:struct">
<section>
- <title id="type-{@name}">
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="concat('type-', @name)"/>
+ </xsl:attribute>
+ <title>
<literal>
<xsl:value-of select="@name"/>
</literal>
@@ -709,7 +777,47 @@
</glossentry>
</xsl:template>
- <xsl:template match="method">
+ <xsl:template match="method|signal" mode="funcsynopsis">
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>
+ <xsl:value-of select="@name"/>
+ </function>
+ </funcdef>
+ <xsl:choose>
+ <xsl:when test="arg">
+ <xsl:apply-templates select="arg" mode="paramdef"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <void/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </funcprototype>
+ </funcsynopsis>
+ </xsl:template>
+
+ <xsl:template match="method|signal" mode="funcsynopsislinked">
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function linkend="{concat(parent::interface//@name, '.', @name)}">
+ <xsl:value-of select="@name"/>
+ </function>
+ </funcdef>
+ <xsl:choose>
+ <xsl:when test="arg">
+ <xsl:apply-templates select="arg" mode="paramdef"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <void/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </funcprototype>
+ </funcsynopsis>
+ </xsl:template>
+
+ <xsl:template match="method" mode="detail">
<xsl:if test="not(parent::interface)">
<xsl:message terminate="yes">
@@ -764,26 +872,15 @@
</xsl:choose>
</xsl:for-each>
- <section>
- <title id="{concat(../@name, concat('.', @name))}">
+ <refsection>
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="concat(../@name, concat('.', @name))"/>
+ </xsl:attribute>
+ <title>
<literal><xsl:value-of select="concat(../@name, concat('.', @name))"/></literal>
</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>
- <function><xsl:value-of select="@name"/></function>
- </funcdef>
- <xsl:choose>
- <xsl:when test="arg">
- <xsl:apply-templates select="arg" mode="paramdef"/>
- </xsl:when>
- <xsl:otherwise>
- <void/>
- </xsl:otherwise>
- </xsl:choose>
- </funcprototype>
- </funcsynopsis>
- <xsl:apply-templates select="tp:docstring" />
+ <xsl:apply-templates select="." mode="funcsynopsis"/>
+ <xsl:apply-templates select="tp:docstring"/>
<xsl:apply-templates select="tp:added"/>
<xsl:apply-templates select="tp:changed"/>
<xsl:apply-templates select="tp:deprecated"/>
@@ -804,7 +901,7 @@
</para>
</formalpara>
</xsl:if>
- </section>
+ </refsection>
</xsl:template>
<xsl:template name="tp-type">
@@ -949,7 +1046,7 @@
</glossentry>
</xsl:template>
- <xsl:template match="signal">
+ <xsl:template match="signal" mode="detail">
<xsl:if test="not(parent::interface)">
<xsl:message terminate="yes">
@@ -1001,18 +1098,14 @@
</xsl:choose>
</xsl:for-each>
- <section>
- <title id="{concat(../@name, concat('.', @name))}">
+ <refsection>
+ <xsl:attribute name="xml:id">
+ <xsl:value-of select="concat(../@name, concat('.', @name))"/>
+ </xsl:attribute>
+ <title>
<literal><xsl:value-of select="concat(../@name, concat('.', @name))"/></literal>
</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>
- <function><xsl:value-of select="@name"/></function>
- </funcdef>
- <xsl:apply-templates select="arg" mode="paramdef"/>
- </funcprototype>
- </funcsynopsis>
+ <xsl:apply-templates select="." mode="funcsynopsis"/>
<xsl:apply-templates select="tp:docstring"/>
<xsl:apply-templates select="tp:added"/>
<xsl:apply-templates select="tp:changed"/>
@@ -1023,11 +1116,11 @@
<xsl:apply-templates select="arg" mode="paramtable"/>
</glosslist>
</xsl:if>
- </section>
+ </refsection>
</xsl:template>
<xsl:template match="/tp:spec">
- <book>
+ <book xmlns="http://docbook.org/ns/docbook" version="5.0">
<bookinfo>
<title><xsl:value-of select="tp:title"/></title>
<xsl:apply-templates select="tp:copyright"/>
@@ -1043,13 +1136,15 @@
<xsl:value-of select="tp:version"/>
</xsl:if> -->
</bookinfo>
- <chapter id="interfaces">
+ <chapter>
+ <xsl:attribute name="xml:id">interfaces</xsl:attribute>
<title>Interfaces</title>
<xsl:apply-templates select="//node"/>
</chapter>
<xsl:call-template name="generic-types"/>
<xsl:if test="tp:errors">
- <chapter id="errors">
+ <chapter>
+ <xsl:attribute name="xml:id">errors</xsl:attribute>
<xsl:apply-templates select="tp:errors"/>
</chapter>
</xsl:if>