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

Avoid misleadingly displaying RFC 2119 words in lower case #1183

Closed
dbooth-boston opened this issue Apr 13, 2017 · 6 comments
Closed

Avoid misleadingly displaying RFC 2119 words in lower case #1183

dbooth-boston opened this issue Apr 13, 2017 · 6 comments

Comments

@dbooth-boston
Copy link

respec is displaying RFC 2119 words such as "MUST" and "SHOULD" in lower case ("must" and "should"). Although this may look prettier to some authors, it is misleading and should not be done in standards documents. For example, in
https://www.w3.org/TR/2017/CR-websub-20170411/
the word "MUST" displays as "must" even though it written as "MUST" in the HTML source, and it copy-and-pastes as "MUST". All caps are important for these words, because it helps them stand out. The spelling and rendering of these words should not be gratuitously changed.

Please fix this bug so that these words are consistently rendered and copy-and-pasted as they are actually written.

On the other hand, it is also important that respec not auto-render "must" as "MUST", because if it does, the upper case distinction will be lost on copy-and-paste. A better solution would be to issue a warning if one of these RFC 2119 words is not spelled with ALL CAPS.

@dbooth-boston
Copy link
Author

dbooth-boston commented Apr 13, 2017

See also previous discussion at #1109 , which I discovered later. I do feel strongly that respec should not be displaying "MUST" as "must" (nor should it displaying "must" as "MUST"). Clarity, consistency and transparency are much more important in an international standard than following a typographical fad.

I'm not sure whether this issue should be discussed here, or on the tr-design issues list:
https://github.com/w3c/tr-design/issues

@kevinmarks
Copy link

kevinmarks commented Apr 14, 2017

The combination of

text-transform: lowercase;
font-variant: small-caps; 

is the right typographic answer for this - it emphasises the words without making them too strong, while preserving the plaintext capitalisation.

@marcoscaceres
Copy link
Member

It's our policy that when things are controversial we add a preference to ReSpec. Happy to accept a PR to enable this.

@marcoscaceres
Copy link
Member

(Otherwise I'll add it after I'm back from vacation)

@halindrome
Copy link
Contributor

halindrome commented Apr 14, 2017 via email

@marcoscaceres
Copy link
Member

Duplicate of #1380

All, please head over to w3c/tr-design#126 to make your preferences heard there! We need to move quickly on it, as the w3c is going to ship an update to base.css in a week!!!!!

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

No branches or pull requests

4 participants