search

w3c / bp-i18n-specdev

Internationalization Best Practices for Spec Developers
https://w3c.github.io/bp-i18n-specdev/
Other
22 stars 24 forks source link

Fix link, css, and validator errors (prep for publication) #92

Closed aphillips closed 1 year ago

aphillips commented 1 year ago

Preview | Diff

netlify[bot] commented 1 year ago

Deploy Preview for bp-i18n-specdev ready!

Name Link
Latest commit b6b3fc577040cc933bacd887eddae3bea90f1b46
Latest deploy log https://app.netlify.com/sites/bp-i18n-specdev/deploys/64425a883cc5f200088f5930
Deploy Preview https://deploy-preview-92--bp-i18n-specdev.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

r12a commented 1 year ago

lines 2194, 2212: add class="kw" to the code element line 2216: we should probably add that this is a special case, and it is normally more useful to include the character name(s). In fact, we may want to advise people not to use just code point values, but to use characters and names as well as a general good practise.

Btw, this PR is getting so big that i'm beginning to forget what i have reviewed and what i haven't. I think multiple PRs would be better in future, if possible.

r12a commented 1 year ago

Also, there are places where the codepoint markup children appear to have a space between them, and others where they don't. Since you have added a margin to the style sheet, we should probably consistently remove the intervening space (in code examples and in descriptive examples).

There's also the question of what to do for combining marks. These can often look a mess if you try to use them as characters, and may need one or sometimes several &nbsp's to make them look right. I have found that a safer option is to use an svg or png image, instead.

aphillips commented 1 year ago

@r12a I made changes on lines 2194 and 2212 that you suggest. I reworded and clarified on 2216 along the lines of what you're suggesting (have a look).

I agree about the problem with spaces and I'm open to suggestions. I added the half-em of space in the margin-inline to guard against problems when the space is accidentally omitted. When the space is present one gets something more like 1.5 em of space. I didn't want to fool with trying to collapse the space. Overall this is a side-effect of removing the square brackets. Should we just say "put a space before the span" and remove the margin-inline space?

Regarding combining marks, I agree that's a problem. Should I add text suggesting the need to include a no-break space or other base character (such as how you included a base as an example with SARA AM in the glossary recently)?

aphillips commented 1 year ago

Merging per call of 2023-04-30. Errors/changes should be filed as new issues.