gnome-session r4856 - in branches/dbus_based: . doc/dbus gnome-session

[mccann svn gnome org]

Author: mccann
Date: Sun Jul 27 17:15:23 2008
New Revision: 4856
URL: http://svn.gnome.org/viewvc/gnome-session?rev=4856&view=rev

Log:
2008-07-27  William Jon McCann  <jmccann redhat com>

	* doc/dbus/Makefile.am:
	* doc/dbus/spec-to-docbook.xsl:
	* gnome-session/gsm-manager.xml:
	Require fully qualified interface
	names in links.



Modified:
   branches/dbus_based/ChangeLog
   branches/dbus_based/doc/dbus/Makefile.am
   branches/dbus_based/doc/dbus/spec-to-docbook.xsl
   branches/dbus_based/gnome-session/gsm-manager.xml

Modified: branches/dbus_based/doc/dbus/Makefile.am
==============================================================================
--- branches/dbus_based/doc/dbus/Makefile.am	(original)
+++ branches/dbus_based/doc/dbus/Makefile.am	Sun Jul 27 17:15:23 2008
@@ -44,3 +44,4 @@
 clean-local:
 	rm -f *~
 	rm -f gnome-session.html
+	rm -f *.ref.xml

Modified: branches/dbus_based/doc/dbus/spec-to-docbook.xsl
==============================================================================
--- branches/dbus_based/doc/dbus/spec-to-docbook.xsl	(original)
+++ branches/dbus_based/doc/dbus/spec-to-docbook.xsl	Sun Jul 27 17:15:23 2008
@@ -4,7 +4,7 @@
   exclude-result-prefixes="doc">
 <!--
      Convert D-Bus Glib xml into DocBook refentries
-     Copyright (C) 2007 William Jon McCann
+     Copyright (C) 2007-2008 William Jon McCann
      License: GPL
 -->
 <xsl:output method="xml" indent="yes" encoding="UTF-8"/>
@@ -18,13 +18,13 @@
   </xsl:call-template>
 </xsl:variable>
 
-<refentry><xsl:attribute name="id"><xsl:value-of select="$basename"/></xsl:attribute>
+<refentry><xsl:attribute name="id"><xsl:value-of select="$interface"/></xsl:attribute>
   <refmeta>
     <refentrytitle role="top_of_page"><xsl:value-of select="//interface/@name"/></refentrytitle>
   </refmeta>
 
   <refnamediv>
-    <refname><xsl:value-of select="//interface/@name"/></refname>
+    <refname><xsl:value-of select="$interface"/></refname>
     <refpurpose><xsl:value-of select="$basename"/> interface</refpurpose>
   </refnamediv>
 
@@ -32,7 +32,7 @@
     <title role="synopsis.title">Methods</title>
     <synopsis>
   <xsl:call-template name="methods-synopsis">
-    <xsl:with-param name="basename" select="$basename"/>
+    <xsl:with-param name="interface" select="$interface"/>
   </xsl:call-template>
     </synopsis>
   </refsynopsisdiv>
@@ -43,7 +43,7 @@
         <title role="signal_proto.title">Signals</title>
         <synopsis>
           <xsl:call-template name="signals-synopsis">
-            <xsl:with-param name="basename" select="$basename"/>
+            <xsl:with-param name="interface" select="$interface"/>
           </xsl:call-template>
         </synopsis>
       </refsect1>
@@ -65,7 +65,7 @@
         <title role="properties.title">Properties</title>
         <synopsis>
           <xsl:call-template name="properties-synopsis">
-            <xsl:with-param name="basename" select="$basename"/>
+            <xsl:with-param name="interface" select="$interface"/>
           </xsl:call-template>
         </synopsis>
       </refsect1>
@@ -82,7 +82,7 @@
   <refsect1 role="details">
     <title role="details.title">Details</title>
     <xsl:call-template name="method-details">
-      <xsl:with-param name="basename" select="$basename"/>
+      <xsl:with-param name="interface" select="$interface"/>
     </xsl:call-template>
   </refsect1>
 
@@ -91,7 +91,7 @@
       <refsect1 role="signals">
         <title role="signals.title">Signal Details</title>
         <xsl:call-template name="signal-details">
-          <xsl:with-param name="basename" select="$basename"/>
+          <xsl:with-param name="interface" select="$interface"/>
         </xsl:call-template>
       </refsect1>
     </xsl:when>
@@ -102,7 +102,7 @@
       <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:with-param name="interface" select="$interface"/>
         </xsl:call-template>
       </refsect1>
     </xsl:when>
@@ -131,7 +131,7 @@
 
 
 <xsl:template name="property-details">
-  <xsl:param name="basename"/>
+  <xsl:param name="interface"/>
   <xsl:variable name="longest">
     <xsl:call-template name="find-longest">
       <xsl:with-param name="set" select="@name"/>
@@ -139,8 +139,8 @@
   </xsl:variable>
   <xsl:for-each select="///property">
   <refsect2>
-    <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>:<xsl:value-of select="@name"/></xsl:attribute></anchor>The "<xsl:value-of select="@name"/>" property</title>
-<indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$basename"/></secondary></indexterm>
+    <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$interface"/>:<xsl:value-of select="@name"/></xsl:attribute></anchor>The "<xsl:value-of select="@name"/>" property</title>
+<indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$interface"/></secondary></indexterm>
 <programlisting>'<xsl:value-of select="@name"/>'<xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="2"/></xsl:call-template>
 <xsl:call-template name="property-args"><xsl:with-param name="indent" select="string-length(@name) + 2"/></xsl:call-template></programlisting>
   </refsect2>
@@ -168,7 +168,7 @@
 </xsl:template>
 
 <xsl:template name="signal-details">
-  <xsl:param name="basename"/>
+  <xsl:param name="interface"/>
   <xsl:variable name="longest">
     <xsl:call-template name="find-longest">
       <xsl:with-param name="set" select="@name"/>
@@ -176,8 +176,8 @@
   </xsl:variable>
   <xsl:for-each select="///signal">
   <refsect2>
-    <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>::<xsl:value-of select="@name"/></xsl:attribute></anchor>The <xsl:value-of select="@name"/> signal</title>
-<indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$basename"/></secondary></indexterm>
+    <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$interface"/>::<xsl:value-of select="@name"/></xsl:attribute></anchor>The <xsl:value-of select="@name"/> signal</title>
+<indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$interface"/></secondary></indexterm>
 <programlisting><xsl:value-of select="@name"/> (<xsl:call-template name="signal-args"><xsl:with-param name="indent" select="string-length(@name) + 2"/><xsl:with-param name="prefix" select="."/></xsl:call-template>)</programlisting>
   </refsect2>
 
@@ -411,7 +411,7 @@
 </xsl:template>
 
 <xsl:template name="method-details">
-  <xsl:param name="basename"/>
+  <xsl:param name="interface"/>
   <xsl:variable name="longest">
     <xsl:call-template name="find-longest">
       <xsl:with-param name="set" select="@name"/>
@@ -419,8 +419,8 @@
   </xsl:variable>
   <xsl:for-each select="///method">
     <refsect2>
-    <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>.<xsl:value-of select="@name"/></xsl:attribute></anchor><xsl:value-of select="@name"/> ()</title>
-<indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$basename"/></secondary></indexterm>
+    <title><anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$interface"/>.<xsl:value-of select="@name"/></xsl:attribute></anchor><xsl:value-of select="@name"/> ()</title>
+<indexterm><primary><xsl:value-of select="@name"/></primary><secondary><xsl:value-of select="$interface"/></secondary></indexterm>
 <programlisting><xsl:value-of select="@name"/> (<xsl:call-template name="method-args"><xsl:with-param name="indent" select="string-length(@name) + 2"/><xsl:with-param name="prefix" select="."/></xsl:call-template>)</programlisting>
     </refsect2>
 
@@ -431,40 +431,40 @@
 
 
 <xsl:template name="properties-synopsis">
-  <xsl:param name="basename"/>
+  <xsl:param name="interface"/>
   <xsl:variable name="longest">
     <xsl:call-template name="find-longest">
       <xsl:with-param name="set" select="///property/@name"/>
     </xsl:call-template>
   </xsl:variable>
   <xsl:for-each select="///property">
-<link><xsl:attribute name="linkend"><xsl:value-of select="$basename"/>:<xsl:value-of select="@name"/></xsl:attribute>'<xsl:value-of select="@name"/>'</link><xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@name) + 1"/></xsl:call-template> <xsl:call-template name="property-args"><xsl:with-param name="indent" select="$longest + 2"/></xsl:call-template>
+<link><xsl:attribute name="linkend"><xsl:value-of select="$interface"/>:<xsl:value-of select="@name"/></xsl:attribute>'<xsl:value-of select="@name"/>'</link><xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@name) + 1"/></xsl:call-template> <xsl:call-template name="property-args"><xsl:with-param name="indent" select="$longest + 2"/></xsl:call-template>
 </xsl:for-each>
 </xsl:template>
 
 
 <xsl:template name="signals-synopsis">
-  <xsl:param name="basename"/>
+  <xsl:param name="interface"/>
   <xsl:variable name="longest">
     <xsl:call-template name="find-longest">
       <xsl:with-param name="set" select="///signal/@name"/>
     </xsl:call-template>
   </xsl:variable>
   <xsl:for-each select="///signal">
-<link><xsl:attribute name="linkend"><xsl:value-of select="$basename"/>::<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></link><xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@name) + 1"/></xsl:call-template>(<xsl:call-template name="signal-args"><xsl:with-param name="indent" select="$longest + 2"/><xsl:with-param name="prefix" select="///signal"/></xsl:call-template>)
+<link><xsl:attribute name="linkend"><xsl:value-of select="$interface"/>::<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></link><xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@name) + 1"/></xsl:call-template>(<xsl:call-template name="signal-args"><xsl:with-param name="indent" select="$longest + 2"/><xsl:with-param name="prefix" select="///signal"/></xsl:call-template>)
 </xsl:for-each>
 </xsl:template>
 
 
 <xsl:template name="methods-synopsis">
-  <xsl:param name="basename"/>
+  <xsl:param name="interface"/>
   <xsl:variable name="longest">
     <xsl:call-template name="find-longest">
       <xsl:with-param name="set" select="///method/@name"/>
     </xsl:call-template>
   </xsl:variable>
   <xsl:for-each select="///method">
-<link><xsl:attribute name="linkend"><xsl:value-of select="$basename"/>.<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></link><xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@name) + 1"/></xsl:call-template>(<xsl:call-template name="method-args"><xsl:with-param name="indent" select="$longest + 2"/><xsl:with-param name="prefix" select="///method"/></xsl:call-template>)
+<link><xsl:attribute name="linkend"><xsl:value-of select="$interface"/>.<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></link><xsl:call-template name="pad-spaces"><xsl:with-param name="width" select="$longest - string-length(@name) + 1"/></xsl:call-template>(<xsl:call-template name="method-args"><xsl:with-param name="indent" select="$longest + 2"/><xsl:with-param name="prefix" select="///method"/></xsl:call-template>)
 </xsl:for-each>
 </xsl:template>
 
@@ -531,7 +531,7 @@
   <xsl:choose>
     <xsl:when test="contains($str,'.')">
       <xsl:call-template name="interface-basename">
-	<xsl:with-param name="str" select="substring-after($str,'.')"/>
+        <xsl:with-param name="str" select="substring-after($str,'.')"/>
       </xsl:call-template>
     </xsl:when>
     <xsl:otherwise>

Modified: branches/dbus_based/gnome-session/gsm-manager.xml
==============================================================================
--- branches/dbus_based/gnome-session/gsm-manager.xml	(original)
+++ branches/dbus_based/gnome-session/gsm-manager.xml	Sun Jul 27 17:15:23 2008
@@ -121,7 +121,7 @@
           <doc:para>Applications should invoke this method when they begin an operation that
             should not be interrupted, such as creating a CD or DVD.  The types of actions
             that may be blocked are specified by the flags parameter.  When the application
-            completes the operation it should call <doc:ref type="method" to="Uninhibit">Uninhibit()</doc:ref>
+            completes the operation it should call <doc:ref type="method" to="org.gnome.SessionManager.Uninhibit">Uninhibit()</doc:ref>
             or disconnect from the system bus.
           </doc:para>
           <doc:para>
@@ -152,7 +152,7 @@
           </doc:para>
           <doc:para>
             The returned cookie is used to uniquely identify this request.  It should be used
-            as an argument to <doc:ref type="method" to="Uninhibit">Uninhibit()</doc:ref> in
+            as an argument to <doc:ref type="method" to="org.gnome.SessionManager.Uninhibit">Uninhibit()</doc:ref> in
             order to remove the request.
           </doc:para>
         </doc:description>