Bug 329463 - Several about.html have invalid XHTML due to missing </p> tag
Summary: Several about.html have invalid XHTML due to missing </p> tag
Status: NEW
Alias: None
Product: Orbit
Classification: Tools
Component: bundles (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P4 minor (vote)
Target Milestone: ---   Edit
Assignee: Orbit Bundles CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-11-04 13:19 EDT by Martin Oberhuber CLA
Modified: 2012-09-14 02:00 EDT (History)
3 users (show)

See Also:


Attachments
patch v1 (37.50 KB, patch)
2010-12-07 12:44 EST, Martin Oberhuber CLA
no flags Details | Diff
bundles.map changes (10.31 KB, patch)
2011-01-21 11:29 EST, Martin Oberhuber CLA
no flags Details | Diff
Additional patch for newer versions (19.24 KB, patch)
2011-01-21 12:19 EST, Martin Oberhuber CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Oberhuber CLA 2010-11-04 13:19:13 EDT
For instance, consider org.apache.commons.el :

http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.orbit/org.apache.commons.el/about.html?view=markup&revision=1.1.2.3&root=Tools_Project&pathrev=v1_0

The paragraph "<p>Your use of the Commons EL code is subject to..." is not terminated with a </p> tag, although the document has an XHTML-strict doctype header.

This is problematic for tooling to work on about's (Wayne?), but also makes the Help webapp fail with a SAX error message:
   http://help.eclipse.org/helios/index.jsp?topic=/org.apache.commons.el/about.html

whereas this works fine for proper XHTML:
   http://help.eclipse.org/helios/index.jsp?topic=/org.eclipse.ui.ide/about.html

I'm not sure how to discover all instances of invalid XHTML, perhaps the gurus from WST could come up with some tooling, maybe integrated with the build, to fix this for Indigo? - A couple other broken XHTML about's that I detected include:

http://help.eclipse.org/helios/index.jsp?topic=/com.ibm.icu/about.html
http://help.eclipse.org/helios/index.jsp?topic=/org.sat4j.core/about.html
http://help.eclipse.org/helios/index.jsp?topic=/org.apache.commons.httpclient/about.html
http://help.eclipse.org/helios/index.jsp?topic=/org.apache.commons.codec/about.html
http://help.eclipse.org/helios/index.jsp?topic=/org.apache.commons.logging/about.html

to me it looks like the defect got introduced early and then replicated via copy & paste. BTW, I also suspect that some copyright notices / copyright years did not get updated properly when reving up a bundle version or cloning an existing bundle to get a new one in...
Comment 1 Martin Oberhuber CLA 2010-12-07 04:29:15 EST
I fixed the issue for 
   org.apache.commons.httpclient   
   org.apache.commons.net
   org.apache.log4j
Comment 2 Martin Oberhuber CLA 2010-12-07 12:44:30 EST
Created attachment 184737 [details]
patch v1

I have taken a first pass at fixing the XHTML in those bundle's about that we're shipping in our product:

  com.jcraft.jsch
  javax.servlet.jsp
  org.apache.commons.codec
  org.apache.commons.el
  org.apache.commons.logging
  org.apache.jasper
  org.apache.lucene
  org.apache.lucene.analysis
  org.apache.xerces
  org.sat4j.core
  org.sat4j.pb

Turned out that each bundle had slightly different problems, so it was a manual approach (using WTP's "validate"). When I release those changes, respective bundles will be updated in Indigo. Before I proceed though, I just wanted to check back with the group whether that's really what we want - since the defect itself isn't a major thing.
Comment 3 Martin Oberhuber CLA 2011-01-21 11:29:00 EST
Created attachment 187300 [details]
bundles.map changes

Since I did not hear any concerns, I finally committed these changes. Turned out that for some bundles, newer versions are around now:

javax.servlet.jsp -- I fixed 2.0.0 but did not check 2.1.0
org.apache.commons.logging -- I fixed 1.0.4 but did not check 1.1.1
org.apache.lucene/analysis -- I fixed 1.9.2 but did not check 2.9.2
com.jcraft.jsch -- I fixed 0.1.41 but did not check 0.1.44

I also noticed that for 
   plugin@org.apache.jasper,5.5.17
the branch tag (,5.5.17) had been missing in bundles.map. This is now fixed.

I would appreciate if bundle maintainers could check their about.html files for proper xhtml syntax from now on. Just apply a Webtools validate before checkin.
Comment 4 Martin Oberhuber CLA 2011-01-21 12:19:56 EST
Created attachment 187303 [details]
Additional patch for newer versions
Comment 5 Martin Oberhuber CLA 2011-01-21 12:31:49 EST
So I fixed the newer versions too:

> javax.servlet.jsp 2.1.0
> org.apache.commons.logging 1.1.1
> org.apache.lucene/analysis/core 2.9.1
> com.jcraft.jsch 0.1.44

This should fix all the about XHTML for Orbit bundlis shipped with the core Platform Runtime. I'm going to leave the bug open though since I cannot check all the bundles in the repo.

Again, ideally each bundle maintainer should derive new about.html files from kosher ones, and run WTP validate on them.
Comment 6 David Williams CLA 2012-09-14 02:00:19 EDT
(In reply to comment #5)
> So I fixed the newer versions too:
> 
> > javax.servlet.jsp 2.1.0
> > org.apache.commons.logging 1.1.1
> > org.apache.lucene/analysis/core 2.9.1
> > com.jcraft.jsch 0.1.44
> 
> This should fix all the about XHTML for Orbit bundlis shipped with the core
> Platform Runtime. I'm going to leave the bug open though since I cannot
> check all the bundles in the repo.
> 
> Again, ideally each bundle maintainer should derive new about.html files
> from kosher ones, and run WTP validate on them.

Perhaps you could udpate wiki at 
http://wiki.eclipse.org/Orbit/Adding_Bundles_to_Orbit
and then count this as "fixed"?