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

I18N string best practices vs. design-principles #454

Open
aphillips opened this issue Oct 5, 2023 · 4 comments
Open

I18N string best practices vs. design-principles #454

aphillips opened this issue Oct 5, 2023 · 4 comments
Assignees
Labels
Agenda+ i18n-needs-resolution Issue the Internationalization Group has raised and looks for a response on. Status: Consensus to write We have TAG consensus about the principle but someone needs to write it (see "To Write" project) Status: In Progress We're working on it but ideas not fully formed yet.

Comments

@aphillips
Copy link

I18N maintains a set of best practices (see also Editor's Copy). One set of these pertain to the definition of strings.

Design-principles has a set of best practices related to strings that prefer DOMString except when one needs USVString. This guidance is a little unclear, since there are non-DOM/non-JS/non-HTML specs that would prefer to use e.g. xsd:string or a string definition that is close to USVString (based on code points). We (I18N) have recently had to go through this exercise with RDF-star and a couple of other specs and this is causing us to revise our best practices.

It would not be helpful if TAG and I18N recommended different things. Our tendency is to prefer a string definition based on scalar value string with an exception for the space where UTF-16/WTF-16 (see #323) are the best practice vs. Design-principles (which is backwards from that). We also want to develop text that explains to specs that touch on UTF-8 based file formats why they want to use DOMString in their interfaces.

Note well: we are not disagreeing with the design principles as currently articulated.

I was actioned with making this issue. Please add the i18n-needs-resolution label to this issue. (Shouldn't horizontal groups have permission enough to set horizontal review labels on your document repos?)

@LeaVerou LeaVerou added the i18n-needs-resolution Issue the Internationalization Group has raised and looks for a response on. label Oct 6, 2023
@LeaVerou
Copy link
Member

LeaVerou commented Oct 6, 2023

I was actioned with making this issue. Please add the i18n-needs-resolution label to this issue. (Shouldn't horizontal groups have permission enough to set horizontal review labels on your document repos?)

I wish this were possible. Unfortunately GitHub’s permission model around labels is all or nothing. Anyhow, I added the label.

@annevk
Copy link
Member

annevk commented Oct 6, 2023

(You could create a triage team and give them triage permissions. That's how WHATWG attempts to solve this. That gives people some power over issues, but no write access.)

aphillips added a commit to aphillips/bp-i18n-specdev that referenced this issue Oct 12, 2023
- 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.
@torgo torgo added this to the 2023-12-04-week milestone Dec 3, 2023
@torgo torgo added the Agenda+ label Dec 3, 2023
@torgo torgo added the Status: Consensus to write We have TAG consensus about the principle but someone needs to write it (see "To Write" project) label Dec 4, 2023
@torgo
Copy link
Member

torgo commented Dec 4, 2023

Thanks for this @aphillips - we agree we need to be more clear - @ylafon took an action on today's TAG call to come up with a PR that adds clarity.

@aphillips
Copy link
Author

@torgo @ylafon Thanks, although please note that this is not just a request for editing by TAG but for our groups to ensure that we say exactly the same thing. If there are differences, we should ensure that we coordinate or have an agreement about what the recommendations ought to be.

As a reference, here is what we currently recommend: link

@torgo torgo modified the milestones: 2023-12-04-week, 2024-03-04-week Mar 3, 2024
@torgo torgo modified the milestones: 2024-04-01-week, 2024-06-03-week Jun 2, 2024
@torgo torgo added the Status: In Progress We're working on it but ideas not fully formed yet. label Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Agenda+ i18n-needs-resolution Issue the Internationalization Group has raised and looks for a response on. Status: Consensus to write We have TAG consensus about the principle but someone needs to write it (see "To Write" project) Status: In Progress We're working on it but ideas not fully formed yet.
Projects
None yet
Development

No branches or pull requests

5 participants