search

w3c / WebID

https://www.w3.org/groups/cg/webid
MIT License
14 stars 7 forks source link

fix some punctuation in index.html #14

Closed TallTed closed 2 years ago

TallTed commented 2 years ago
TallTed commented 2 years ago

@csarven — I can't find anything on w3.org that suggests it's better to use the — character than the — entity. I've followed the W3C Manual of Style, which just says "Use correct punctuation." If you can find a citation that instructs to use the character instead of the entity, I'll accept your changes.

csarven commented 2 years ago

e.g.:

Using character escapes in markup and CSS describing "when not to use escapes" https://www.w3.org/International/questions/qa-escapes#not :

It is almost always preferable to use an encoding that allows you to represent characters in their normal form, rather than using named character references or numeric character references.

Character Model for the World Wide Web: Fundamentals provides a common reference for text-manipulation, in particular a guideline for when to use escapes https://www.w3.org/TR/charmod/#C047 :

Escapes SHOULD only be used when the characters to be expressed are not directly representable in the format or the character encoding of the document, or when the visual representation of the character is unclear.

More generally, the Internationalization Best Practices for Spec Developers https://www.w3.org/TR/international-specs/ informatively references Character Model for the World Wide Web: Fundamentals's "character escaping" for basic guidelines related to the use of characters and encodings https://www.w3.org/TR/charmod/#sec-Escaping - among which is guideline C047 (linked above) although it is not explicitly called out in international-specs.

TallTed commented 2 years ago

@csarven — I've merged your — in place of my —, but I will also note that WHEN ESCAPES CAN BE USEFUL (which follows WHEN NOT TO USE ESCAPES) says that a "particularly useful role for escapes is to represent characters that are invisible or ambiguous in presentation." I believe this applies to hyphen vs en-dash vs em-dash, particularly when working in spaces where monospaced fonts are common (e.g., source editors). Reasonable minds may differ.

bblfish commented 2 years ago

If everyone's ok, I'll commit this PR soon.