Show regexp in HTML output for replacable text

[goneall]

Submitted by @wking and moved from spdx/tools#120

formatReplaceabledHTML currently sets class="replacable-license-text". I think we should also set title="match-regexp" or something so users can mouse over (if they have a mouse) to see the replacement regexp. Raw regexps aren't the greatest UX, but that's what we've been using so far, and I can't think of anything better.

Spun off from here.

[goneall]

@wking any thoughts on how to handle the empty "original text" case?

This may be a separate issue, but currently there is no hint at all that there is variable text if the original is left out or blank.

@jlovejoy Any thoughts on including a mouse over for the var text to describe the var using a regular expression?

[goneall]

Please refer to the original closed issue for the entire conversation: spdx/tools#120

From @wking

I've mocked something up at 1, which is primarily using CSS with a
placeholder wherever you want the icon. That ensures the icon
is not going to be copy/pasted from a rendering of the HTML. I've
used ☿ for the icon, but I didn't hunt around too hard. Anything that
gets “this might change” across and won't be mistaken for the license
text itself would work.

[wking]

On Mon, Apr 09, 2018 at 09:23:44PM +0000, goneall wrote: @wking any thoughts on how to handle the empty "original text" case?

I think my demo addresses that case under the “Without content” header. It shows a touchable/hoverable ☿ icon after an empty var, and works as I expect it to. It doesn't have a ::before marker, and I don't think it needs one with the var styling showing the extent of the canonical content (none in that case; “world” in the “With content” case). But you could certainly add a ::before marker if you wanted one.

[goneall]

I'm going to wait one more release of the license list (version 3.2) to give @jlovejoy a chance to review and comment on the UI

[goneall]

I haven't heard from @jlovejoy on this, so I'm closing the issue.

[jlovejoy]

sorry @goneall - this is old and re-reading it now, I'm not even sure what it was proposing!

[goneall]

sorry @goneall - this is old and re-reading it now, I'm not even sure what it was proposing!

No worries - it was proposing we add a feather where you click or hover over the replaceable text and it will show you the regular expression. I think there was only one person requesting the feature, so we should be fine just closing it.