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

Mirror tr-design changes and update specdev markup #113

Merged
merged 8 commits into from
Aug 24, 2023

Conversation

aphillips
Copy link
Contributor

@aphillips aphillips commented Jul 27, 2023

  • Mirror the changes in tr-design
  • Change span class="uname" to code class="uname" globally

Preview | Diff

- Mirror the changes in tr-design
- Change `span class="uname"` to `code class="uname"` globally
@aphillips aphillips requested review from xfq and r12a July 27, 2023 16:15
@netlify
Copy link

netlify bot commented Jul 27, 2023

Deploy Preview for bp-i18n-specdev ready!

Name Link
🔨 Latest commit 4bdcdb5
🔍 Latest deploy log https://app.netlify.com/sites/bp-i18n-specdev/deploys/64d503e4b1243000093e678c
😎 Deploy Preview https://deploy-preview-113--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 configuration.

@aphillips
Copy link
Contributor Author

aphillips commented Jul 27, 2023

@r12a

One observation: should we recommend what to put into the alt for an img? In our example we put "NBSP" for the no-break space, but that's kind of a special case.

Also... do we want to image-ize invisibles mentioned in specdev? ("this dog food is yummy")


This PR changes span to code, but very little (nothing?) in the actual text about styling templates is modified here.


@r12a
Copy link
Contributor

r12a commented Jul 27, 2023

I think they can probably figure out what they want to put in the alt text. Usually, if it's not an invisible character i put the character itself, but i'm not sure we need to recommend that.

I agree that we should imagize the invisibles in specdev.

@r12a
Copy link
Contributor

r12a commented Jul 27, 2023

I made a comment somewhere about recommending that authors style the bdi character(s) for font-family & font-size, which i imagine applies to these changes too.

@aphillips
Copy link
Contributor Author

I agree that we should imagize the invisibles in specdev.

The list is not as short as one might like 😉 but I will pull one together. If you (@r12a) could generate the images, I'd appreciate it. I think I'll make a separate task out of that...

@@ -2359,7 +2359,7 @@ <h5>Character naming template</h5>

<p>The <code translate="no" class="kw">bdi</code> element is used to ensure that example characters that are right-to-left do not interfere with the layout of the page. Do not include line breaks or a space between the closing <code translate="no" class="kw">bdi</code> and the following <code translate="no" class="kw">span</code> element; spacing and presentation is controlled by styling.</p>

<p>The <code translate="no" class="kw">lang</code> attribute should be filled in appropriately to get the correct font selection for a given context. Examples in East Asian languages (such as Chinese, Japanese, or Korean) or in the Arabic script can sometimes require greater care in choosing a language tag. In some cases, it might also be necessary for you to adjust the <kbd translate="no">font-family</kbd> and/or <kbd translate="no">font-size</kbd> in your own style sheet for characters or character sequences in a given language.</p>
<p>The <code translate="no" class="kw">lang</code> attribute should be filled in appropriately to get the correct font selection for a given context. Examples in East Asian languages (such as Chinese, Japanese, or Korean) or in the Arabic script can sometimes require greater care in choosing a language tag. Rarely, for certain languages, it might be necessary to adjust the style of the <code>bdi</code> element with a <kbd translate="no">font-family</kbd> and/or <kbd translate="no">font-size</kbd> in your own stylesheet.</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm inclined to think that it's not nessecelery rare, most non-latin usages will probably need some styling.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most users will be dealing with ASCII and perhaps some specific characters, so this "rarely" is targeted at them (rather than at us).

@aphillips aphillips requested a review from r12a August 9, 2023 15:50
@r12a
Copy link
Contributor

r12a commented Aug 10, 2023

I took one last look at the generated version. The proposed changes look ok. However, i noticed 2 things:

  1. there is no mustard
  2. the "see also" box is normally reserved for links to other sections within the document. External links appear either in the blocks entitled "Useful background and overviews for this section" or in the pulldowns below the mustard.

- merge subsection into section
- move text as appropriate
- make link to editing guidelines use the purple box instead of "see
  also"
- additional edits for flow and usability resulting from the above
The mustard said "...code points in the specification", but it makes
more sense to say "a specification" or perhaps "your specification".

Span-to-code was because we changed the markup but not the text.
@aphillips aphillips merged commit ff1e02c into w3c:gh-pages Aug 24, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants