Merge lp:~benji/launchpadlib/fix-nested-p-tags into lp:launchpadlib

[Benji York]

The HTML generated by the XSLT did not validate because it contained
nested <p> tags (bug 426858). That was because the contents of
<wadl:doc> nodes were unconditionally wrapped in a <p>.

This branch adds a conditional to the <wadl:doc> template so that
<wadl:doc> nodes with <p> child nodes are instead wrapped in a <div>.

Why a <div> instead of no containing tag at all? For some reason the
output stage of the XSLT processor generates overly-compact HTML (no
inter-tag whitespace) if there isn't a block-level tag containing the
children of the <wadl:doc> node. I wish I knew exactly why that was.

The generated HTML validates and when rendered is virtually identical to
the original (there are a few subtle white-space differences).

[lp:~benji/launchpadlib/fix-nested-p-tags]

102. By Benji York on 2010-12-02

add NEWS.txt entry

103. By Benji York on 2010-12-02

bump bug fix version

104. By Benji York on 2010-12-02

tweak comment

[j.c.sackett (jcsackett)]

Looks good. I wish there were some sort of test set for all of this, but perhaps that will come when we move some of this to LP, as you mentioned.

review: Approve (code*)

[Curtis Hovey (sinzui)]

This looks good to land.

review: Approve (code)

=== modified file 'src/launchpadlib/NEWS.txt'
--- src/launchpadlib/NEWS.txt	2010-11-15 18:34:06 +0000
+++ src/launchpadlib/NEWS.txt	2010-12-02 15:03:43 +0000
@@ -2,6 +2,11 @@
 NEWS for launchpadlib
 =====================
 
+1.8.1 (unreleased)
+==================
+
+- The HTML generated by wadl-to-refhtml.xsl now validates.
+
 1.8.0 (2010-11-15)
 ==================
 

=== modified file 'src/launchpadlib/__init__.py'
--- src/launchpadlib/__init__.py	2010-11-15 18:34:06 +0000
+++ src/launchpadlib/__init__.py	2010-12-02 15:03:43 +0000
@@ -14,4 +14,4 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with launchpadlib. If not, see <http://www.gnu.org/licenses/>.
 
-__version__ = '1.8.0'
+__version__ = '1.8.1'

=== modified file 'src/launchpadlib/wadl-to-refhtml.xsl'
--- src/launchpadlib/wadl-to-refhtml.xsl	2010-07-12 15:06:17 +0000
+++ src/launchpadlib/wadl-to-refhtml.xsl	2010-12-02 15:03:43 +0000
@@ -978,9 +978,20 @@
         <!-- skip WADL elements -->
         <xsl:choose>
             <xsl:when test="node()[1]=text() and $inline=0">
-                <p>
-                    <xsl:apply-templates select="node()" mode="copy"/>
-                </p>
+              <!-- If the wadl:doc contains <p> tags wrap it in a <div>,
+                   otherwise wrap it in a <p> tag. -->
+              <xsl:choose>
+                  <xsl:when test="./html:p">
+                      <div>
+                          <xsl:apply-templates select="node()" mode="copy"/>
+                      </div>
+                  </xsl:when>
+                  <xsl:otherwise>
+                      <p>
+                          <xsl:apply-templates select="node()" mode="copy"/>
+                      </p>
+                  </xsl:otherwise>
+              </xsl:choose>
             </xsl:when>
             <xsl:otherwise>
                 <xsl:apply-templates select="node()" mode="copy"/>