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
Comments
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: |
The combination of
is the right typographic answer for this - it emphasises the words without making them too strong, while preserving the plaintext capitalisation. |
It's our policy that when things are controversial we add a preference to ReSpec. Happy to accept a PR to enable this. |
(Otherwise I'll add it after I'm back from vacation) |
I will see if I can't jig something up - I have a little spare time.
…On Fri, Apr 14, 2017 at 6:52 AM, Marcos Cáceres ***@***.***> wrote:
(Otherwise I'll add it after I'm back from vacation)
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#1183 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAfx8FQNt32wfsUOcnYaLPsbVfzb4kA8ks5rv14PgaJpZM4M9O6p>
.
--
Shane McCarron
halindrome@gmail.com
|
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!!!!! |
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.
The text was updated successfully, but these errors were encountered: