Change from spans to divs #122

goneall · 2017-11-28T23:52:08Z

Change from spans to divs for the HTML representation of optional and variable license text.

Address issue #121

Signed-off-by: Gary O'Neall gary@sourceauditor.com

… variable license text Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

wking · 2017-11-29T19:08:45Z

src/org/spdx/licenseTemplate/HtmlTemplateOutputHandler.java

@@ -98,17 +98,17 @@ private void removeEndParagraphTag() {
 	 */
 	public static String formatReplaceabledHTML(String text, String id) {
 		StringBuilder sb = new StringBuilder();
-		sb.append("\n<span ");
+		sb.append("\n<div ");


I think this is going too far in the other direction :p. In #121, I'm advocating <var> (or <span>) when we're wrapping phrasing content, and <div> when we're wrapping flow content. I don't think there's a single element that will cover both cases.

This code is used for the old license spreadsheet and license text. I'll change this back to spans since the old format will not include any phrasing content.

goneall · 2017-11-29T20:59:23Z

I don't think there's a single element that will cover both cases.

It would be design change with some effort to detect if there is phrasing content. The div's seem to render correctly if I use the inline style.

@wking what is the effect of wrapping non-phrasing content with an inline <div>?

wking · 2017-11-29T21:49:06Z

On Wed, Nov 29, 2017 at 08:59:23PM +0000, goneall wrote: what is the effect of wrapping non-phrasing content with an inline <div>?

Upon closer inspection, it appears that the phrasing-content elements [1] are a strict subset of the flow-content elements [2]. So including phrasing content in a div is valid HTML. However, because a div is not phrasing content itself, you cannot use it inside an element that requires phrasing content. For example, [3] now has broken newlines around these divs. And the W3C's validator has complaints like [4]: No p element in scope but a p end tag seen. where it hits the </p> in a <p>…<div>…</div>…</p> situation. That error message isn't great because HTML has lots of rules about implicit paragraph tags; you can get a clearer error message for <b><div></div></b>, where the validator reports: Element div not allowed as child of element b in this context. (Suppressing further errors from this subtree.) From line 8, column 6; to line 8, column 34 ody>↩ <b><div style="display: inline">Hello< Contexts in which element div may be used: Where flow content is expected. As a child of a dl element. Content model for element b: Phrasing content. You can include a var in phrasing content (e.g. <b><var>…</var></b>). You cannot include flow content inside var (e.g. <var><p>…</p></var>), with W3C's validator reporting: Element p not allowed as child of element var in this context. (Suppressing further errors from this subtree.) From line 7, column 10; to line 7, column 12 ↩ <var><p>hi</p> Contexts in which element p may be used: Where flow content is expected. Content model for element var: Phrasing content. So I think we want to be using var whenever possible, and only falling back to div when the element contains flow content. That way we aren't changing the content type with our wrapping. [1]: https://www.w3.org/TR/2014/REC-html5-20141028/dom.html#phrasing-content-1 [2]: https://www.w3.org/TR/2014/REC-html5-20141028/dom.html#flow-content-1 [3]: https://spdx.org/licenses/preview/ISC.html [4]: https://validator.w3.org/nu/?doc=https%3A%2F%2Fspdx.org%2Flicenses%2Fpreview%2FISC.html

goneall · 2017-11-29T23:46:03Z

So I think we want to be using var whenever possible, and only falling
back to div when the element contains flow content. That way we
aren't changing the content type with our wrapping.

Hmmm - looks like something I need to fix. May take a couple days since this will require some additional parsing.

wking · 2017-11-30T00:20:15Z

On Wed, Nov 29, 2017 at 11:46:04PM +0000, goneall wrote: May take a couple days since this will require some additional parsing.

I think you probably just need logic like “if our alt/optional contains a p or list element, use a div, otherwise use a var”. And I don't think there's a hurry. spdx/license-list-XML#327 will take a while to chew through, and we don't need pretty HTML until that is done.

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

goneall · 2017-11-30T04:26:43Z

Added a commit to conditionally use a var tag if there is no phrasing-content in the element.

Attached is the generated ISC license.

The var and optional text passes the w3c validator and it seems to render OK on Chrome.
ISC.html.txt

wking · 2017-11-30T04:48:25Z

src/org/spdx/licenseTemplate/HtmlTemplateOutputHandler.java

 		if (id != null && !id.trim().isEmpty()) {
 			sb.append("id=\"");
 			sb.append(escapeIdString(id));
 			sb.append("\" ");
 		}
 		sb.append("class=\"");
 		sb.append(REPLACEABLE_LICENSE_TEXT_CLASS);
-		sb.append("\">");
+		sb.append("\"  style=\"display: inline\">");


With <var> for phrasing content, I don't think you need this style anymore.

Would this be needed for the div's?

Would this be needed for the div's?

I don't think so, because all the inline cases will now be var. This styling was a workaround for a case (inline divs) that should no longer happen.

…ng element Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

goneall · 2017-11-30T17:31:44Z

Check the latest commit - see if that fixes it. The LICENSEXML_ELEMENT... constants are defined in SpdxRdfConstants.java

These constants refer to the input license XML elements (not the output HTML elements).

goneall · 2017-11-30T18:12:51Z

How about alt's or optionals embedded in other optionals? Should those be wrapped in a div? Otherwise we would have <var ...> top level optional <var ...>nested optional</var> ... </var>

goneall · 2017-11-30T18:27:27Z

In looking at the W3C validator link above, I noticed the following error:

From line 170, column 1; to line 170, column 5
     <br>↩</br>Copyri

<p>Copyright (c) ↩
<var class="replacable-license-text">2004-2010 by Internet Systems Consortium, Inc. (&quot;ISC&quot;)↩
        <br>↩
</br>Copyright (c) 1995-2003 by Internet Software Consortium</var>↩

Is this anything to worry about?

…nges to the HtmlTemplateOutputHandler - back to spans Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

wking · 2017-11-30T20:20:36Z

Otherwise we would have <var ...> top level optional <var ...>nested optional</var> ... </var>

When none of the content contains a p or list element (at any depth, not just as immediate children), then I think we should be using <var>. I have no problem with the nested-<var> in your example (although see my comments about styling them).

From line 170, column 1; to line 170, column 5
    <br>↩</br>Copyri

If you mean the “Error: End tag br.”, yes, that is something to worry about. From the HTML 5 spec for br:

Tag omission in text/html:
No end tag

And we're serving that content as HTML, not XHTML:

$ curl -sI https://spdx.org/licenses/preview/ISC.html | grep Content-Type
Content-Type: text/html; charset=UTF-8

But that's orthogonal to this issue.

wking · 2017-11-30T20:22:46Z

src/org/spdx/licensexml/LicenseXmlHelper.java

@@ -117,6 +117,12 @@
 		EXAMPLE_UNPROCESSED_TAGS.add(LICENSEXML_ELEMENT_BULLET);
 	}

+	static HashSet<String> PHRASING_ELEMENTS = new HashSet<String>();
+	static {
+		PHRASING_ELEMENTS.add(LICENSEXML_ELEMENT_LIST);


PHRASING_ELEMENTS still needs to be renamed to FLOW_CONTENT_ELEMENTS (or similar).

wking · 2017-11-30T20:25:14Z

src/org/spdx/licensexml/LicenseXmlHelper.java

 			sb.append(HtmlTemplateOutputHandler.OPTIONAL_LICENSE_TEXT_CLASS);
 			sb.append("\">");
 			sb.append(childSb.toString());
-			sb.append("</span>");
+			if (includesPhrasing(element)) {
+				sb.append("</div>");


This could be a bit DRYer and slightly more performant if you had a single:

if (includesFlowContent(element)) { tag = "div"; } else { tag = "var"; }

and then used that tag variable for both the start and end tag.

Agree - I was just being lazy ;) I'll update the PR

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

wking · 2017-11-30T20:33:07Z

src/org/spdx/licensexml/LicenseXmlHelper.java

+	 * @param element parent element
+	 * @return true if the element includes any phrasing content per https://www.w3.org/TR/2014/REC-html5-20141028/dom.html#phrasing-content-1
+	 */
+	private static boolean includesPhrasing(Element element) {


This function should be includesFlowControl, and you'll want to update its comment, callers, etc. This is bubbling up the FLOW_CONTROL_ELEMENTS rename to use the correct name throughout the new code.

wking · 2017-11-30T20:39:05Z

src/org/spdx/licensexml/LicenseXmlHelper.java

+	 * @return true if the element includes any phrasing content per https://www.w3.org/TR/2014/REC-html5-20141028/dom.html#phrasing-content-1
+	 */
+	private static boolean includesPhrasing(Element element) {
+		NodeList children = element.getChildNodes();


getChildNodes seems to only return immediate children. We want something that iterates over all descendants to catch <optional>…<optional><p>…</p></optional></optional>. A quick grep through the docs didn't turn up anything that sounded right, so we may need to implement this locally (or call includesFlowControl recursively?).

It already does a recursive search (line 355)

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

goneall · 2017-12-01T02:28:05Z

if you mean the “Error: End tag br.”, yes, that is something to worry about.

Just pushed a fix for the end tag br.

goneall · 2017-12-01T02:32:38Z

And we're serving that content as HTML, not XHTML

Is this an issue with the templates in the resources folder (e.g.

tools/resources/htmlTemplate/LicenseHTMLTemplate.html

Line 12 in d8ef31b

)? If so, feel free to submit a PR to fix.

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

goneall · 2017-12-04T17:30:45Z

I believe all the comments have been resolved and a new issue was spun off to track the XHTML issue #123

goneall added 2 commits November 28, 2017 15:50

Change from spans to divs for the HTML representation of optional and…

cb70f3e

… variable license text Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

Update unit tests for div update

37b229d

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

wking reviewed Nov 29, 2017

View reviewed changes

Add logic to use <var> when there is no phrasing-content

595bb9c

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

wking reviewed Nov 30, 2017

View reviewed changes

Per review comment from Trevor, replace the item with list for phrasi…

af1612e

…ng element Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

Remove inline style from optional and replaceable text and revert cha…

46daca9

…nges to the HtmlTemplateOutputHandler - back to spans Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

wking reviewed Nov 30, 2017

View reviewed changes

Renaming flow control elements per review comment

29405fd

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

wking reviewed Nov 30, 2017

View reviewed changes

goneall added 2 commits November 30, 2017 17:43

Update method names per review comments

21e9ebd

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

Fix the bad breaks: <br> </br> -> <br />

92b4142

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

One more time on the br tag

c72f068

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

wking mentioned this pull request Dec 1, 2017

XHTML declaring itself text/html #123

Closed

goneall merged commit 9842022 into master Dec 4, 2017

goneall deleted the spantodiv branch December 4, 2017 17:31

wking mentioned this pull request Dec 4, 2017

Conditional <var> or <div> in formatReplaceabledHTML #121

Closed

goneall mentioned this pull request Apr 9, 2018

XHTML declaring itself text/html spdx/LicenseListPublisher#16

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change from spans to divs #122

Change from spans to divs #122

goneall commented Nov 28, 2017

wking Nov 29, 2017

goneall Nov 30, 2017

goneall commented Nov 29, 2017 •

edited

Loading

wking commented Nov 29, 2017 via email

goneall commented Nov 29, 2017

wking commented Nov 30, 2017 via email

goneall commented Nov 30, 2017

wking Nov 30, 2017

goneall Nov 30, 2017

wking Nov 30, 2017

goneall commented Nov 30, 2017

goneall commented Nov 30, 2017

goneall commented Nov 30, 2017 •

edited

Loading

wking commented Nov 30, 2017

wking Nov 30, 2017 •

edited

Loading

wking Nov 30, 2017

goneall Dec 1, 2017

wking Nov 30, 2017

wking Nov 30, 2017

goneall Dec 1, 2017

goneall commented Dec 1, 2017

goneall commented Dec 1, 2017

goneall commented Dec 4, 2017

Change from spans to divs #122

Change from spans to divs #122

Conversation

goneall commented Nov 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goneall commented Nov 29, 2017 • edited Loading

wking commented Nov 29, 2017 via email

goneall commented Nov 29, 2017

wking commented Nov 30, 2017 via email

goneall commented Nov 30, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goneall commented Nov 30, 2017

goneall commented Nov 30, 2017

goneall commented Nov 30, 2017 • edited Loading

wking commented Nov 30, 2017

wking Nov 30, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goneall commented Dec 1, 2017

goneall commented Dec 1, 2017

goneall commented Dec 4, 2017

goneall commented Nov 29, 2017 •

edited

Loading

goneall commented Nov 30, 2017 •

edited

Loading

wking Nov 30, 2017 •

edited

Loading