ok, will ignore :)

the thing that bothered me, by way of thorough explanation, was that previously 
the “margins” on some of the licenses were quite narrow, which displays rather 
poorly on an HTML page and also is frustrating if you want to say, use the 
license text to copy elsewhere (for attribution files, etc) - where it’s nicer 
to allow paragraph text to wrap, instead of breaking due to some forced line 
break that existed elsewhere. For this and other reasons, the early iterations 
of the HTML pages for the license text (generated from the .txt files) looked 
like a motley mess of formatting (or really, lack thereof).  If that makes 
sense… 

in the end, I wanted (and still have a few to fix to this end) for the license 
text to appear in a visually, easy-to-read, and consistent way in both the .txt 
files and the generated HTML pages. Gary and I came up with a few “tricks” 
using CSS inline styles to make it render in the HTML pages a bit nicer (e.g., 
with indentations) than a .txt file allows one to do, but without using 
hard-coded HTML, since that is problematic for other reasons.  I don’t know if 
I explained that very well, but in the end, I want things to look good enough 
to be able to read them easily!  Text that smushes together is fine for a 
machine, but not so good for human eyes!!

Jilayne

SPDX Legal Team co-lead
[email protected]


> On Sep 15, 2015, at 5:47 PM, Yev Bronshteyn 
> <[email protected]> wrote:
> 
> Apologies, please ignore previous email. Looking at the code, I see that we 
> have special handling for writing licenses - so I was wrong. My change should 
> not impact that functionality. But it’s a good test case to keep in mind.
> 
> 
> 
> 
> On 9/15/15, 7:42 PM, "[email protected] on behalf of Yev 
> Bronshteyn" <[email protected] on behalf of 
> [email protected]> wrote:
> 
>> Hi, Jilayne,
>> 
>> If you’ve done the work to remove line breaks from license text files, then 
>> those line breaks won’t reappear in the HTML. And if a line break does 
>> appear in the text of an extracted license, then it is currently preserved 
>> in conversion to both tagged and spreadsheet formats. I would argue in favor 
>> of keeping all conversions consistent.
>> 
>> Since in RDF text and plaint-text tagged formats, there is no distinction 
>> between line breaks and paragraphs, I’m not sure how we can make one in 
>> converting to HTML.
>> 
>> Yev
>> 
>> 
>> 
>> On 9/15/15, 2:00 PM, "[email protected] on behalf of J 
>> Lovejoy" <[email protected] on behalf of 
>> [email protected]> wrote:
>> 
>>> HI Gary, Yev,
>>> 
>>> Just saw this and maybe I’m not clear on what is being discussed, but we do 
>>> NOT want to have line breaks in the .txt files for the license text to be 
>>> converted to <br> tags in the HTML pages.  I did a lot of work to remove 
>>> line breaks from the .txt files just so that the text would wrap when in 
>>> whatever width page it is being displayed on.  
>>> 
>>> While there may be some places where a line break, instead of a new 
>>> paragraph would be a nice distinction to have, for the most part, I think 
>>> the license text is rendering quite well. 
>>> 
>>> Perhaps, I’ve misinterpreted the concern here, but just wanted to make sure…
>>> 
>>> Jilayne
>>> 
>>> 
>>> 
>>> 
>>>> On Sep 15, 2015, at 8:13 AM, [email protected] wrote:
>>>> 
>>>> Send Spdx-tech mailing list submissions to
>>>>    [email protected]
>>>> 
>>>> To subscribe or unsubscribe via the World Wide Web, visit
>>>>    https://lists.spdx.org/mailman/listinfo/spdx-tech
>>>> or, via email, send a message with subject or body 'help' to
>>>>    [email protected]
>>>> 
>>>> You can reach the person managing the list at
>>>>    [email protected]
>>>> 
>>>> When replying, please edit your Subject line so it is more specific
>>>> than "Re: Contents of Spdx-tech digest..."
>>>> 
>>>> 
>>>> Today's Topics:
>>>> 
>>>>  1. RE: HTML generation - escaping line breaks (Gary O'Neall)
>>>>  2. [Bug 1319] New: Escape linebreaks and markup characterers
>>>>     when   generating HTML ([email protected])
>>>>  3. [Bug 1319] Escape linebreaks and markup characterers when
>>>>     generating     HTML ([email protected])
>>>>  4. Feedback on External Identifiers - Debian Example (Kate Stewart)
>>>> 
>>>> 
>>>> ----------------------------------------------------------------------
>>>> 
>>>> Message: 1
>>>> Date: Mon, 14 Sep 2015 14:14:57 -0700
>>>> From: "Gary O'Neall" <[email protected]>
>>>> To: "'Yev Bronshteyn'" <[email protected]>
>>>> Cc: [email protected]
>>>> Subject: RE: HTML generation - escaping line breaks
>>>> Message-ID: <018b01d0ef32$6ab64dc0$4022e940$@com>
>>>> Content-Type: text/plain; charset="utf-8"
>>>> 
>>>> Hi Yev,
>>>> 
>>>> 
>>>> 
>>>> No reason other than not thinking of it during implementation ;)  It would 
>>>> be great if you could file a bug and start incremental improvements.
>>>> 
>>>> 
>>>> 
>>>> Thanks,
>>>> gary
>>>> 
>>>> 
>>>> 
>>>> From: Yev Bronshteyn [mailto:[email protected]] 
>>>> Sent: Monday, September 14, 2015 1:27 PM
>>>> To: Gary O'Neall
>>>> Cc: [email protected]
>>>> Subject: HTML generation - escaping line breaks
>>>> 
>>>> 
>>>> 
>>>> Hi, Gary et al,
>>>> 
>>>> 
>>>> 
>>>> When generating HTML, we don?t go through any text and convert line breaks 
>>>> to <br/>. Any reason why we shouldn?t do that? If not, I?ll file a bug and 
>>>> start gradually making the changes. Otherwise, all comment properties 
>>>> appear can different than the creator intended.
>>>> 
>>>> 
>>>> 
>>>> Thanks
>>>> 
>>>> cid:7EA68D51-363B-4FAD-A939-D9CD926D70AB
>>>> 
>>>> Yev Bronshteyn
>>>> Senior Software Engineer
>>>> <http://www.blackducksoftware.com/> Black Duck Software 
>>>> 
>>>> -------------- next part --------------
>>>> An HTML attachment was scrubbed...
>>>> URL: 
>>>> <http://lists.spdx.org/pipermail/spdx-tech/attachments/20150914/0abd8f4e/attachment-0001.html>
>>>> -------------- next part --------------
>>>> A non-text attachment was scrubbed...
>>>> Name: image001.png
>>>> Type: image/png
>>>> Size: 3790 bytes
>>>> Desc: not available
>>>> URL: 
>>>> <http://lists.spdx.org/pipermail/spdx-tech/attachments/20150914/0abd8f4e/attachment-0001.png>
>>>> 
>>>> ------------------------------
>>>> 
>>>> Message: 2
>>>> Date: Mon, 14 Sep 2015 21:44:30 +0000
>>>> From: [email protected]
>>>> To: [email protected]
>>>> Subject: [Bug 1319] New: Escape linebreaks and markup characterers
>>>>    when    generating HTML
>>>> Message-ID: <[email protected]/>
>>>> 
>>>> https://bugs.linuxfoundation.org/show_bug.cgi?id=1319
>>>> 
>>>>            Bug #: 1319
>>>>          Summary: Escape linebreaks and markup characterers when
>>>>                   generating HTML
>>>>          Product: SPDX
>>>>          Version: 2.0
>>>>         Platform: All
>>>>       OS/Version: All
>>>>           Status: NEW
>>>>         Severity: normal
>>>>         Priority: P2
>>>>        Component: Pretty Printer
>>>>       AssignedTo: [email protected]
>>>>       ReportedBy: [email protected]
>>>>   Classification: Unclassified
>>>> 
>>>> 
>>>> In all open-ended strings, there could be line breaks that will disappear 
>>>> if
>>>> that string is inserted into HTML. Mustache does not automatically convert 
>>>> line
>>>> breaks to <br/> tags, so we'll need to do that ourselves when populating 
>>>> the
>>>> mustache map.
>>>> 
>>>> -- 
>>>> Configure bugmail: https://bugs.linuxfoundation.org/userprefs.cgi?tab=email
>>>> ------- You are receiving this mail because: -------
>>>> You are the assignee for the bug.
>>>> 
>>>> 
>>>> ------------------------------
>>>> 
>>>> Message: 3
>>>> Date: Mon, 14 Sep 2015 21:45:01 +0000
>>>> From: [email protected]
>>>> To: [email protected]
>>>> Subject: [Bug 1319] Escape linebreaks and markup characterers when
>>>>    generating      HTML
>>>> Message-ID: <[email protected]/>
>>>> 
>>>> https://bugs.linuxfoundation.org/show_bug.cgi?id=1319
>>>> 
>>>> Yev Bronshteyn <[email protected]> changed:
>>>> 
>>>>          What    |Removed                     |Added
>>>> ----------------------------------------------------------------------------
>>>>        AssignedTo|[email protected]    |[email protected]
>>>> 
>>>> -- 
>>>> Configure bugmail: https://bugs.linuxfoundation.org/userprefs.cgi?tab=email
>>>> ------- You are receiving this mail because: -------
>>>> You are the assignee for the bug.
>>>> 
>>>> 
>>>> ------------------------------
>>>> 
>>> 
>>> _______________________________________________
>>> Spdx-tech mailing list
>>> [email protected]
>>> https://lists.spdx.org/mailman/listinfo/spdx-tech
>> _______________________________________________
>> Spdx-tech mailing list
>> [email protected]
>> https://lists.spdx.org/mailman/listinfo/spdx-tech

_______________________________________________
Spdx-tech mailing list
[email protected]
https://lists.spdx.org/mailman/listinfo/spdx-tech

Reply via email to