Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Styling for notes ought to be less subdued #1825

Closed
rkirsling opened this issue Jan 3, 2020 · 2 comments · Fixed by #1842
Closed

Styling for notes ought to be less subdued #1825

rkirsling opened this issue Jan 3, 2020 · 2 comments · Fixed by #1842

Comments

@rkirsling
Copy link
Member

rkirsling commented Jan 3, 2020

Problem

Other specs tend to style notes in a way that calls attention with color while retaining adequate subtlety, yet we style them as if they were being consumed by encroaching fog blockquotes in GitHub Markdown.

WASM

image

HTML

image

CSS

image

ECMAScript

image

But notes are meant to be read—they may be "inessential" from the view of the spec as an implementation in itself, but they are often of key importance to the human reader, and I question whether we really mean to visually "background" them as such.

Solution(s)

I think we can do better, with a bit of Ecma orange! Here are a few possibilities.

1. Higher-impact approach

image

Specifically:

  • Make border full Ecma orange (like the metadata box), remove grey text color
  • Add background color which is Ecma orange with lightness bumped to 95%
    (also make <code> background transparent and <td> background white)
  • Add 10px padding on the other three sides

Notes:

  • I say high-er impact because we could go further still and restyle the "NOTE" indicator if we wanted.
  • Since the border is full-colored, the background lightness here could even be bumped up further.

2. Medium-impact approach

image

Like the first approach, but without a border:

  • Remove grey border and its padding, remove grey text color
  • Add background color which is Ecma orange with lightness bumped to 95%
    (also make <code> background transparent and <td> background white)
  • Add 10px padding on all sides

Notes:

  • This might be slightly less good for the printed version, where I believe background color would be omitted but border and padding would be preserved.

3. Lowest-impact approach

image

Basically the complement of the second approach:

  • Make border full Ecma orange (like the metadata box)...and that's it.

Notes:

  • I don't care for this since I really want to do something about the grey text color too, but if the note text is black-on-white just like the body text, I fear the border color alone isn't enough of a visual distinction.

Please note that I'm raising this discussion here, but the PR would need to take place in the ecmarkup repo, assuming we don't want it to be restricted to ECMA-262.

@rkirsling
Copy link
Member Author

rkirsling commented Jan 4, 2020

Oh wow, I just realized that 402 is already using basically the exact style I've proposed here for a new element <emu-normative-optional> (which is not currently part of ecmarkup itself):

image

If Ecma orange is effectively doubling as a "warning" color there, then perhaps we should use green or blue as the color for notes instead?

@rkirsling
Copy link
Member Author

rkirsling commented Jan 6, 2020

So as a concrete proposal then, how about we do approach 1 above but with Bikeshed green?

I guess that still leaves a choice as to whether to color the "NOTE" indicator or not though.

With:

image

Without:

image

I was originally thinking the latter, but perhaps the former is more consistent?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant