gtk-doc r645 - in trunk: . tests/annotations/docs tests/gobject/docs

[stefkost svn gnome org]

Author: stefkost
Date: Tue Jan 20 08:42:44 2009
New Revision: 645
URL: http://svn.gnome.org/viewvc/gtk-doc?rev=645&view=rev

Log:
	* TODO:
	  More ideas.
	* gtk-doc.xsl:
	  Make sure indexdiv and glossarydiv elements have anchors.
	* style-classic.css:
	* style.css:
	  Fix spacing for navbar in index/glossary pages.
	* tests/annotations/docs/tester-docs.xml:
	* tests/gobject/docs/tester-docs.xml:
	  Cleanup samples.



Modified:
   trunk/ChangeLog
   trunk/TODO
   trunk/gtk-doc.xsl
   trunk/style-classic.css
   trunk/style.css
   trunk/tests/annotations/docs/tester-docs.xml
   trunk/tests/gobject/docs/tester-docs.xml

Modified: trunk/TODO
==============================================================================
--- trunk/TODO	(original)
+++ trunk/TODO	Tue Jan 20 08:42:44 2009
@@ -182,6 +182,8 @@
 http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus
 === GConf schemas ===
 
+=== Wiki imports ===
+
 = styling =
 == warnings ==
 xsl produces inline style tag for warnings (e.g. deprecation). We could add a

Modified: trunk/gtk-doc.xsl
==============================================================================
--- trunk/gtk-doc.xsl	(original)
+++ trunk/gtk-doc.xsl	Tue Jan 20 08:42:44 2009
@@ -9,6 +9,7 @@
   <xsl:include href="version-greater-or-equal.xsl"/>
 
   <!-- change some parameters -->
+  <!-- http://docbook.sourceforge.net/release/xsl/current/doc/html/index.html -->
   <xsl:param name="toc.section.depth">2</xsl:param>
   <xsl:param name="generate.toc">
     book	toc
@@ -34,6 +35,10 @@
 
   <!-- display variablelists as tables -->
   <xsl:param name="variablelist.as.table" select="1"/>
+  
+  <!-- new things to consider
+  <xsl:param name="glossterm.auto.link" select="0"></xsl:param>
+  -->
 
   <!-- this gets set on the command line ... -->
   <xsl:param name="gtkdoc.version" select="''"/>
@@ -434,7 +439,7 @@
                      &#160;|&#160;
                    </xsl:if>
                    <a class="shortcut">
-                     <xsl:attribute name="href">#<xsl:value-of select="./anchor/@id"/></xsl:attribute>
+                     <xsl:attribute name="href">#gls<xsl:value-of select="./title"/></xsl:attribute>
                      <xsl:value-of select="./title"/>
                    </a>
                  </xsl:for-each>
@@ -449,7 +454,7 @@
                      &#160;|&#160;
                    </xsl:if>
                    <a class="shortcut">
-                     <xsl:attribute name="href">#<xsl:value-of select="./anchor/@id"/></xsl:attribute>
+                     <xsl:attribute name="href">#idx<xsl:value-of select="./title"/></xsl:attribute>
                      <xsl:value-of select="./title"/>
                    </a>
                  </xsl:for-each>
@@ -556,6 +561,16 @@
      </div>
   </xsl:template>
 
+  <xsl:template match="indexdiv">
+    <a><xsl:attribute name="name">idx<xsl:value-of select="./title"/></xsl:attribute></a>
+    <xsl:apply-templates/>
+  </xsl:template>
+
+  <xsl:template match="glossdiv">
+    <a><xsl:attribute name="name">gls<xsl:value-of select="./title"/></xsl:attribute></a>
+    <xsl:apply-templates/>
+  </xsl:template>
+
   <!-- Exterminate any trace of indexterms in the main flow -->
   <xsl:template match="indexterm">
   </xsl:template>

Modified: trunk/style-classic.css
==============================================================================
--- trunk/style-classic.css	(original)
+++ trunk/style-classic.css	Tue Jan 20 08:42:44 2009
@@ -20,18 +20,40 @@
   vertical-align: top;
 }
 
-/* this is needed so that the local anchors are displayed below the naviagtion */
 @media screen {
   sup a.footnote
   {
     position: relative;
     top: 0em ! important;
   }
-  div.refnamediv a[name], div.refsect1 a[name]
+  /* this is needed so that the local anchors are displayed below the naviagtion */
+  div.refnamediv a[name], div.refsect1 a[name], div.index a[name], div.glossary a[name]
   {
     position: relative;
     top: -4.5em;
   }
+  /* make space for the fixed navigation bar */
+  div.refentry, div.chapter, div.reference, div.part, div.book, div.glossary, div.index, div.sect1, div.appendix, div.preface
+  {
+    position: relative;
+    top: 3em;
+    z-index: 0;
+  }
+  div.glossary, div.index
+  {
+    position: relative;
+    top: 2em;
+    z-index: 0;
+  }
+  div.refnamediv
+  {
+    margin-top: 2em;
+  }
+  body
+  {
+    padding-bottom: 20em;
+  }
+  /* style and size the navigation bar */
   table.navigation#top
   {
     background: #ffeeee;
@@ -58,26 +80,6 @@
     font-size: 80%;
     white-space: nowrap;
   }
-  div.refentry, div.chapter, div.reference, div.part, div.book, div.glossary, div.sect1, div.appendix, div.preface
-  {
-    position: relative;
-    top: 3em;
-    z-index: 0;
-  }
-  div.glossary, div.index
-  {
-    position: relative;
-    top: 2em;
-    z-index: 0;
-  }
-  div.refnamediv
-  {
-    margin-top: 2em;
-  }
-  body
-  {
-    padding-bottom: 20em;
-  }
 }
 @media print {
   table.navigation {

Modified: trunk/style.css
==============================================================================
--- trunk/style.css	(original)
+++ trunk/style.css	Tue Jan 20 08:42:44 2009
@@ -22,18 +22,34 @@
   vertical-align: top;
 }
 
-/* this is needed so that the local anchors are displayed below the naviagtion */
 @media screen {
   sup a.footnote
   {
     position: relative;
     top: 0em ! important;
   }
-  div.refnamediv a[name], div.refsect1 a[name]
+  /* this is needed so that the local anchors are displayed below the naviagtion */
+  div.refnamediv a[name], div.refsect1 a[name], div.index a[name], div.glossary a[name]
   {
     position: relative;
     top: -4.5em;
   }
+  /* make space for the fixed navigation bar */
+  div.refentry, div.chapter, div.reference, div.part, div.book, div.glossary, div.index, div.sect1, div.appendix, div.preface
+  {
+    position: relative;
+    top: 3.1em;
+    z-index: 0;
+  }
+  div.refnamediv
+  {
+    margin-top: 2em;
+  }
+  body
+  {
+    padding-bottom: 20em;
+  }
+  /* style and size the navigation bar */
   table.navigation#top
   {
     /* tango:scarlet red 0/1 */
@@ -63,20 +79,6 @@
     font-size: 80%;
     white-space: nowrap;
   }
-  div.refentry, div.chapter, div.reference, div.part, div.book, div.glossary, div.sect1, div.appendix, div.preface, div.glossary, div.index
-  {
-    position: relative;
-    top: 3.1em;
-    z-index: 0;
-  }
-  div.refnamediv
-  {
-    margin-top: 2em;
-  }
-  body
-  {
-    padding-bottom: 20em;
-  }
 }
 @media print {
   table.navigation {

Modified: trunk/tests/annotations/docs/tester-docs.xml
==============================================================================
--- trunk/tests/annotations/docs/tester-docs.xml	(original)
+++ trunk/tests/annotations/docs/tester-docs.xml	Tue Jan 20 08:42:44 2009
@@ -14,38 +14,45 @@
     </releaseinfo>
   </bookinfo>
 
-  <chapter>
-    <title>Tests</title>
-    <xi:include href="xml/tester.xml"/>
-  </chapter>
+  <reference label="II">
+    <title>API Reference</title>
+    <chapter id="main-api">
+      <title>Tests</title>
+      <xi:include href="xml/tester.xml"/>
+    </chapter>
+  </reference>
 
-  <index id="api-index">
-    <title>API Index</title>
-  </index>
-  <index id="deprecated-api-index" role="deprecated">
-    <title>Index of deprecated API</title>
-  </index>
-  <!--index id="api-index-0-9" role="0.9">
-    <title>Index of new API in 0.9</title>
-  </index-->
+  <part label="III">
+    <title>Appendix</title>
 
-  <glossary>
-    <title>Glossary</title>
-    <glossdiv id="glossary-X"><title>X</title>
-      <glossentry>
-        <glossterm><anchor id="glossterm-XML"/>XML</glossterm>
-        <glossdef>
-          <para>Extensible Markup Language</para>
-        </glossdef>
-      </glossentry>
-      <glossentry>
-        <glossterm><anchor id="glossterm-XSL"/>XSL</glossterm>
-        <glossdef>
-          <para>XML Stylesheet Language</para>
-        </glossdef>
-      </glossentry>
-    </glossdiv>
-  </glossary>
+    <index id="api-index">
+      <title>API Index</title>
+    </index>
+    <index id="deprecated-api-index" role="deprecated">
+      <title>Index of deprecated API</title>
+    </index>
+    <!--index id="api-index-0-9" role="0.9">
+      <title>Index of new API in 0.9</title>
+    </index-->
   
-  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+    <glossary>
+      <title>Glossary</title>
+      <glossdiv><title>X</title>
+        <glossentry>
+          <glossterm><anchor id="glossterm-XML"/>XML</glossterm>
+          <glossdef>
+            <para>Extensible Markup Language</para>
+          </glossdef>
+        </glossentry>
+        <glossentry>
+          <glossterm><anchor id="glossterm-XSL"/>XSL</glossterm>
+          <glossdef>
+            <para>XML Stylesheet Language</para>
+          </glossdef>
+        </glossentry>
+      </glossdiv>
+    </glossary>
+    
+    <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+  </part>
 </book>

Modified: trunk/tests/gobject/docs/tester-docs.xml
==============================================================================
--- trunk/tests/gobject/docs/tester-docs.xml	(original)
+++ trunk/tests/gobject/docs/tester-docs.xml	Tue Jan 20 08:42:44 2009
@@ -71,7 +71,7 @@
   
     <glossary>
       <title>Glossary</title>
-      <glossdiv><anchor id="glossary-A"/><title>A</title>
+      <glossdiv><title>A</title>
         <glossentry>
           <glossterm><anchor id="glossterm-API"/>API</glossterm>
           <glossdef>
@@ -79,7 +79,7 @@
           </glossdef>
         </glossentry>
       </glossdiv>
-      <glossdiv><anchor id="glossary-X"/><title>X</title>
+      <glossdiv><title>X</title>
         <glossentry>
           <glossterm><anchor id="glossterm-XML"/>XML</glossterm>
           <glossdef>