Add additional definitions of 'string' (w3c/i18n-actions#41) #117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There are multiple sources for the term 'string', including WEBIDL, INFRA, Unicode, and XML Schema. In our discussions with RDF-star, we have found that there is a need for generic string definitions for use by JSON, Schema.org, RDF, and XML-based specs which are not consistent with DOMString/USVString. This PR needs to be accompanied by changes to the I18N-GLOSSARY in order to be complete. This PR is for initial discussion purposes before we embark on those changes.
✅ Deploy Preview for bp-i18n-specdev ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
xfq
reviewed
Sep 26, 2023
index.html
Outdated
|
|
||
| <p>The best practices found in this section are mutually consistent with those in [[DESIGN-PRINCIPLES]]. The definitions in this section use terms found in the <cite>Internationalization Glossary</cite> [[I18N-GLOSSARY]]. Some of these definitions are taken directly from [[WEBIDL]], [[INFRA]], or the Unicode glossary; in which case the definitions are quoted verbatim and include links to their source. Please refer to instructions in the Internationalization Glossary for how to import and link definitions in your own specification.</p> | ||
|
|
||
| <p>[[UNICODE]] forms the basis for text on the Web, so the basic definition of a string is: <em>a well-formed sequence of zero or more <a>Unicode Scalar Values</a></em>. Because the term 'string' is ambiguous, this definition can be more specifically referred to using one of these definitions: |
There was a problem hiding this comment.
And CSS specifications can refer to the definition in https://www.w3.org/TR/css-values-4/#strings ?
There was a problem hiding this comment.
And some specs refer to RFC 3629 directly, not sure if that's something we want to recommend, though: https://w3c.github.io/IFT/Overview.html#primitives
There was a problem hiding this comment.
3629 is the (IETF) definition of UTF-8, not string.
CSS's definition is weird, since it appears to be a USVString but points to Infra's (DOMString) definition of string.
I don't think our set of references needs to be exhaustive and fewer references is actually better for our customers.
xfq
reviewed
Sep 26, 2023
This change significantly reorganizes the section on strings in hopes of making the definitions clearer and to reduce the overall repetitive nature of the text. It also moves the text about design-principles to a note at the top, rather than burying it in the text. The relationship of DOMString and USVString to surrogates is clarified and pulled into one place.
- Move inline style to local.css - fix lint-ignore on string definition - link to webidl definitions as needed - add a note about why you want DOMString when specifying bytes on the wire
himorin
reviewed
Oct 3, 2023
himorin
reviewed
Oct 3, 2023
- Fix links to DOMString and USVString to use WebIDL markup - Rephrase the sentence about UTF-8's relationship to surrogate code points.
We have a general practice of putting the best practice text before the explanation of the BP so that users linking into specdev can read below the best practice rather than having to scroll up and start the section over. This change moves the string definition guidance ahead of all of the text about string types.
- Change the MUSTard to recommend USVString first. - Split the MUSTard into two BPs - Add a missing link around one instance of `USVString` - Add an issue that includes a link to w3ctag/design-principles#454 and appropriately scary sounding text.
r12a
reviewed
Oct 13, 2023
r12a
requested changes
Oct 13, 2023
r12a
approved these changes
Oct 13, 2023
xfq
approved these changes
Oct 17, 2023
himorin
approved these changes
Oct 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The working group discussed this in teleconference on 2023-09-21 and decided to rewrite this section to address our concerns.
There are multiple sources for the term 'string', including WEBIDL,
INFRA, Unicode, and XML Schema. In our discussions with RDF-star,
we have found that there is a need for generic string definitions
for use by JSON, Schema.org, RDF, and XML-based specs which are not
consistent with DOMString/USVString.
This PR needs to be accompanied by changes to the I18N-GLOSSARY in order
to be complete. This PR is for initial discussion purposes before we
embark on those changes.
Mentioning w3ctag/design-principles#454 because that issue tracks our coordination with TAG
Preview | Diff