Merge lp:~kfogel/launchpadlib/426323-apidoc-html-title-attrs into lp:launchpadlib

[Karl Fogel]

[Karl Fogel (kfogel)]

This resolves bug #426323.

I tested it by using Markus Korn's script from http://paste.ubuntu.com/267586/ (note that the last few lines of that paste are not the script, but rather instructions for using it). Basically, just do this:

0. cd 426323-apidoc-html-attrs ## Be at the top of the branch
1. ## Get the script, save it as get-wadl.py. ##
2. python get-wadl.py
3. Do the authn dance with Launchpad in your browser. Read-only access is all you need to grant the script.
4. xsltproc -o apidoc.html src/launchpadlib/wadl-to-refhtml.xsl lpapi.wadl
5. ## Point your browser at apidoc.html, hover over stuff to see the titletips appear. ##

That's it!

I also performed this optional step 6:

6. Hope for the recently-committed fix for https://bugzilla.mozilla.org/show_bug.cgi?id=395668 to appear in my browser soon, so titletips don't drop away after five seconds.

[Barry Warsaw (barry)]

This looks good as it is, but I wondered on irc whether it's possible to test this in the launchpadlib tree. Does launchpadlib already test its wadl? If so, then adding a test for this shouldn't be difficult. If it's not, then we won't worry about it for this branch.

Please try to find Leonard or Francis to find out.

review: Needs Fixing (code)

[Leonard Richardson (leonardr)]

> This looks good as it is, but I wondered on irc whether it's possible to test
> this in the launchpadlib tree. Does launchpadlib already test its wadl? If
> so, then adding a test for this shouldn't be difficult. If it's not, then we
> won't worry about it for this branch.

There are no tests of the stylesheet in launchpadlib, or anywhere for that matter. I don't recommend making any changes in this branch.

You could write a test that runs the stylesheet on the example WADL in wadllib and then parses the result to prove various things about the translation. This could run within launchpadlib, which already depends on wadllib.

Or you could test the real generated HTML in Launchpad. We already test that the HTML is generated, but we don't look in the file.

=== modified file 'src/launchpadlib/wadl-to-refhtml.xsl'
--- src/launchpadlib/wadl-to-refhtml.xsl	2009-09-09 10:17:14 +0000
+++ src/launchpadlib/wadl-to-refhtml.xsl	2009-09-25 21:55:16 +0000
@@ -426,7 +426,7 @@
 
     <!-- Table of contents -->
     <xsl:template name="table-of-contents">
-        <div id="toc">
+        <div id="toc" title="toc">
             <h2>Table of Contents</h2>
             <h3>Top-level collections</h3>
             <ul>
@@ -470,7 +470,7 @@
 
     <!-- Top level collections container -->
     <xsl:template name="top-level-collections">
-        <div id="top-level-collections">
+        <div id="top-level-collections" title="top-level-collections">
             <h2>Top-level collections</h2>
 
             <!--
@@ -505,7 +505,7 @@
 
     <!-- Documentation for one top-level-collection -->
     <xsl:template match="wadl:resource_type" mode="top-level-collections">
-        <div id="{@id}" class="top-level-collection">
+        <div id="{@id}" title="{@id}" class="top-level-collection">
             <h3><xsl:call-template name="get-title-or-id"/></h3>
             <xsl:apply-templates select="wadl:doc"/>
 
@@ -569,7 +569,7 @@
 
     <!-- Documentation for the standard methods on an entry -->
     <xsl:template name="standard-methods">
-        <div id="{@id}-standard-methods" class="methods standard">
+        <div id="{@id}-standard-methods" title="{@id}-standard-methods" class="methods standard">
             <h4>Standard methods</h4>
             <dl>
                 <!-- Standard methods are the ones without a ws.op param. -->
@@ -618,7 +618,7 @@
                 @name = 'GET'][.//wadl:param[@name = 'ws.op']]" />
 
         <xsl:if test="$operations">
-            <div id="{@id}-custom-GETs" class="methods GETs">
+            <div id="{@id}-custom-GETs" title="{@id}-custom-GETs" class="methods GETs">
                 <h4>Custom GET methods</h4>
 
                 <xsl:apply-templates select="$operations">
@@ -634,7 +634,7 @@
             @name = 'POST'][.//wadl:param[@name = 'ws.op']]" />
 
         <xsl:if test="$operations">
-            <div id="{@id}-custom-POSTs" class="methods POSTs">
+            <div id="{@id}-custom-POSTs" title="{@id}-custom-POSTs" class="methods POSTs">
                 <h4>Custom POST methods</h4>
 
                 <xsl:apply-templates select="$operations">
@@ -646,7 +646,7 @@
 
     <!-- Container for all the entry types documentation -->
     <xsl:template name="entry-types">
-        <h2 id="entry-types">Entry types</h2>
+        <h2 id="entry-types" title="entry-types">Entry types</h2>
 
         <!-- Process all the resource_types, except the service-root ones,
           the type describing collections of that type,
@@ -670,7 +670,7 @@
 
     <!-- Documentation for one entry-type -->
     <xsl:template match="wadl:resource_type" mode="entry-types">
-        <h3 id="{@id}"><xsl:call-template name="get-title-or-id"/></h3>
+        <h3 id="{@id}" title="{@id}"><xsl:call-template name="get-title-or-id"/></h3>
         <xsl:apply-templates select="wadl:doc"/>
 
         <xsl:call-template name="entry-uri-doc"/>
@@ -814,7 +814,7 @@
     <!-- Documentation for a custom method -->
     <xsl:template match="wadl:method[.//wadl:param[@name = 'ws.op']]">
         <div class="method">
-            <h5 id="{@id}"><xsl:value-of
+            <h5 id="{@id}" title="{@id}"><xsl:value-of
                     select=".//wadl:param[@name = 'ws.op']/@fixed"/></h5>
             <xsl:choose>
                 <xsl:when test="wadl:doc|wadl:request|wadl:response">