JDK-8180338 : Additional HTML5 cleanup
  • Type: Bug
  • Component: javafx
  • Sub-Component: other
  • Affected Version: 9
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2017-05-13
  • Updated: 2017-08-26
  • Resolved: 2017-06-15
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 9
9Fixed
Related Reports
Duplicate :  
JDK-8184221 - Update remaining JavaFX docs to HTML 5
Duplicate :  
JDK-8181288 - Invalid HTML 5 in JavaFX docs
Relates :  
JDK-8181288 - Invalid HTML 5 in JavaFX docs
Relates :  
JDK-8184220 - Fix tidy issues in JavaFX docs
Relates :  
JDK-8182300 - HTML5 cleanup in cssref.html
Description
As of JDK-8176538 the javadoc-generated API docs are HTML5 clean. We discovered a minor issue in the embedded .html docs:

1. the initial tag should be just:

<!doctype html>

2. The <html> tag needs to include the language, like this:

<html lang="en">

The following files are affected:

modules/javafx.fxml/src/main/docs/javafx/fxml/doc-files/faq.html
modules/javafx.fxml/src/main/docs/javafx/fxml/doc-files/introduction_to_fxml.html
modules/javafx.graphics/src/main/docs/javafx/scene/doc-files/cssref.html
Comments
I filed JDK-8182300 to track the remaining warnings in cssref.html.
15-06-2017
Changeset: 7b44520c8003 Author: kcr Date: 2017-06-15 10:32 -0700 URL: http://hg.openjdk.java.net/openjfx/9-dev/rt/rev/7b44520c8003 8180338: Additional HTML5 cleanup Reviewed-by: jgiles
15-06-2017
+1
13-06-2017
Good suggestion. I fixed all of the empty <span> and <p> tags, which reduced the number of warnings in cssref.html to 6. These are all missing <li> tags in a <ul> which are not so easy to fix given the tight deadline, so I prefer to file a follow-on bug for any remaining issue. Here is the updated webrev. Only cssref.html changed from .02 to .03: http://cr.openjdk.java.net/~kcr/8180338/webrev.03/
13-06-2017
Consider putting &nbsp; in your empty <span>s.
13-06-2017
Here is an updated webrev: http://cr.openjdk.java.net/~kcr/8180338/webrev.02/ It fixes all warnings and errors reported by tidy in "introduction_to_fxml.html" and 3 of the warnings in "cssref.html" (I chose those three because they are incorrect in a way that could cause a broken link). The other warnings in "cssref.html" will need to be handled with caution. In particular, if one were to believe tidy about all of the "Warning: trimming empty <span>" and actually remove the indicated <span> tags, the section of HTML colors would not render correctly (the squares of each color are drawn by those <span> tags that tidy considers empty). As such, we should not fix any more warnings in cssref.html for JDK 9.
13-06-2017
I think it makes more sense to fix the errors reported by tidy as part of this bug, so I'll close JDK-8181288 as a duplicate of this one. After fixing the errors, we can file a follow-on bug for the warnings and target that to 10. I'll post a new webrev next week.
31-05-2017
We can use the just-filed JDK-8181288 as the follow-on bug. We can try to address it in JDK 9 if there is time.
30-05-2017
Note that tidy -e reports several warnings on each of the two remaining files and errors on one of them (introduction_to_fxml.html). I suggest to address these in a subsequent bug (likely for JDK 10).
26-05-2017
Here is an updated webrev that removes modules/javafx.fxml/src/main/docs/javafx/fxml/doc-files/faq.html entirely -- it is an unfinished FAQ that is not referenced at all. http://cr.openjdk.java.net/~kcr/8180338/webrev.01/
25-05-2017
Webrev for review: http://cr.openjdk.java.net/~kcr/8180338/webrev.00/
24-05-2017
We should run 'tidy -e' on the three .html files to be sure that the docs are HTML5 clean.
13-05-2017