Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 316062

Summary: [doc] "New and Noteworthy" document in JSF User Guide fails to open (throws SAXParseException)
Product: [WebTools] Java Server Faces Reporter: Debajit Adhikary <debajit.adhikary>
Component: DocumentationAssignee: Raghunathan Srinivasan <raghunathan.srinivasan>
Status: CLOSED FIXED QA Contact:
Severity: blocker    
Priority: P1 CC: david_williams, neil.hauge, raghunathan.srinivasan
Version: unspecifiedFlags: david_williams: pmc_approved+
raghunathan.srinivasan: pmc_approved? (naci.dai)
deboer: pmc_approved+
neil.hauge: pmc_approved+
raghunathan.srinivasan: pmc_approved? (kaloyan)
raghunathan.srinivasan: review+
Target Milestone: 3.2 RC4   
Hardware: All   
OS: All   
See Also: https://git.eclipse.org/r/114238
https://git.eclipse.org/c/jsf/webtools.jsf.git/commit/?id=4a126398b08bc614e867bb432e71cfa52d387ab4
Whiteboard: PMC_approved
Attachments:
Description Flags
Patch to fix the bug. none

Description Debajit Adhikary CLA 2010-06-07 18:12:10 EDT 
Build Identifier:  I20100602-1502

The following error is seen when opening Help > Help Contents > JavaServer Faces Tooling User Guide > New and Noteworthy:

"An error occured while processing the requested document: 

org.xml.sax.SAXParseException: The element type "img" must be terminated by the matching end-tag "</img>".
	at com.sun.org.apache.xerces.internal.parsers.DOMParser.parse(Unknown Source)
	at com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderImpl.parse(Unknown Source)
	at org.eclipse.help.internal.dynamic.DocumentReader.read(DocumentReader.java:56)
	at org.eclipse.help.internal.dynamic.XMLProcessor.process(XMLProcessor.java:49)
	at org.eclipse.help.internal.xhtml.DynamicXHTMLProcessor.process(DynamicXHTMLProcessor.java:66)
	at org.eclipse.help.internal.webapp.servlet.DynamicXHTMLFilter$1.close(DynamicXHTMLFilter.java:81)
	at java.io.FilterOutputStream.close(Unknown Source)
	at org.eclipse.help.internal.webapp.servlet.FilterHTMLHeadAndBodyOutputStream.close(FilterHTMLHeadAndBodyOutputStream.java:311)
	at org.eclipse.help.internal.webapp.servlet.PluginsRootResolvingStream.close(PluginsRootResolvingStream.java:220)
	at java.io.FilterOutputStream.close(Unknown Source)
	at org.eclipse.help.internal.webapp.servlet.FilterHTMLHeadOutputStream.close(FilterHTMLHeadOutputStream.java:159)
	at org.eclipse.help.internal.webapp.servlet.EclipseConnector.transfer(EclipseConnector.java:191)
	at org.eclipse.help.internal.webapp.servlet.ContentServlet.doGet(ContentServlet.java:45)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:707)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:820)
	at org.eclipse.equinox.http.registry.internal.ServletManager$ServletWrapper.service(ServletManager.java:180)
	at org.eclipse.equinox.http.servlet.internal.ServletRegistration.service(ServletRegistration.java:61)
	at org.eclipse.equinox.http.servlet.internal.ProxyServlet.processAlias(ProxyServlet.java:126)
	at org.eclipse.equinox.http.servlet.internal.ProxyServlet.service(ProxyServlet.java:68)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:820)
	at org.eclipse.equinox.http.jetty.internal.HttpServerManager$InternalHttpServiceServlet.service(HttpServerManager.java:318)
	at org.mortbay.jetty.servlet.ServletHolder.handle(ServletHolder.java:511)
	at org.mortbay.jetty.servlet.ServletHandler.handle(ServletHandler.java:390)
	at org.mortbay.jetty.servlet.SessionHandler.handle(SessionHandler.java:182)
	at org.mortbay.jetty.handler.ContextHandler.handle(ContextHandler.java:765)
	at org.mortbay.jetty.handler.HandlerWrapper.handle(HandlerWrapper.java:152)
	at org.mortbay.jetty.Server.handle(Server.java:326)
	at org.mortbay.jetty.HttpConnection.handleRequest(HttpConnection.java:542)
	at org.mortbay.jetty.HttpConnection$RequestHandler.headerComplete(HttpConnection.java:924)
	at org.mortbay.jetty.HttpParser.parseNext(HttpParser.java:549)
	at org.mortbay.jetty.HttpParser.parseAvailable(HttpParser.java:212)
	at org.mortbay.jetty.HttpConnection.handle(HttpConnection.java:404)
	at org.mortbay.io.nio.SelectChannelEndPoint.run(SelectChannelEndPoint.java:409)
	at org.mortbay.thread.QueuedThreadPool$PoolThread.run(QueuedThreadPool.java:582)"

Reproducible: Always

Steps to Reproduce:
1. From the Help menu, select Help Contents
2. Open JavaServer Faces Tooling User Guide > New and Noteworthy
Comment 1 Debajit Adhikary CLA 2010-06-07 18:15:35 EDT 
(Also, in the "Getting Started" topics needs to be reordered so that the JSF 2.0 tutorial is listed first, before the JSF 1.2 tutorial)
Comment 2 Debajit Adhikary CLA 2010-06-07 18:17:31 EDT 
Also, the "Getting Started" topics in the JSF user guide need reordering so that the JSF 2.0 tutorial is listed first, before the JSF 1.2 tutorial.

(corrected typos in earlier comment)
Comment 3 Debajit Adhikary CLA 2010-06-07 18:51:02 EDT 
Created attachment 171350 [details]
Patch to fix the bug.

This patch 

* Replaces the doctype on whats_new.htm from XHTML 1.0 
  Transitional to HTML 4.01 Transitional. This fixes
  the closing tag issues.

* Reorders the "Getting Started" list of topics: 
  the JSF 2.0 tutorial comes first now, before the 
  JSF 1.2 tutorial.
Comment 4 Raghunathan Srinivasan CLA 2010-06-07 18:58:39 EDT 
* Explain why you believe this is a stop-ship defect. Or, if it is a "hotbug"
(requested by an adopter) please document it as such. 
This is a stop-ship issue. The user doc throws an exception when accessing one of the topics. We would also like to address the ordering of topics in the getting started guide to focus on the JSF 2.0 support.
* Is there a work-around? If so, why do you believe the work-around is
insufficient? 
No workaround
* How has the fix been tested? Is there a test case attached to the bugzilla
record? Has a JUnit Test been added? 
Code review.
* Give a brief technical overview. Who has reviewed this fix? 
See comment 3
* What is the risk associated with this fix?
none
Comment 5 David Williams CLA 2010-06-07 23:30:00 EDT 
looks simple, small, doc bundle only. and yes, bad to get an exception. 

(would be interesting to know how this could happen ... xml/html editor isn't used? ... but, that's a side issue).
Comment 6 Raghunathan Srinivasan CLA 2010-06-08 00:53:43 EDT 
I am releasing the change so that it can make it to a build tonight.
Comment 7 Debajit Adhikary CLA 2010-06-08 16:33:55 EDT 
I have verified from the latest build (http://build.eclipse.org/webtools/committers/wtp-R3.2.0-S/20100608034029/S-3.2.0RC4-20100608054300/ ) that the fix has been successfully applied.
Comment 8 David Williams CLA 2010-06-09 04:17:42 EDT 
according to last comment then, this should be 'fixed', and even verified. please correct if I've misunderstood.
Comment 9 Debajit Adhikary CLA 2010-06-09 13:16:52 EDT 
I've marked it as Verified/Fixed now.
Comment 10 Raghunathan Srinivasan CLA 2010-06-09 13:49:06 EDT 
We have verified the fix. Closing
Comment 11 Eclipse Genie CLA 2017-12-18 20:16:14 EST 
New Gerrit change created: https://git.eclipse.org/r/114238