Skip to content

Adjustments to A11y Lang Attribute section #1467

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

Merged
merged 5 commits into from
Jul 1, 2020

Conversation

hergaiety
Copy link
Contributor

@hergaiety hergaiety commented Jun 29, 2020

Adjusts some copy based on what we've learned during the ember new lang RFC, clarifies some points, adds some reference links, adds a zoey says section and a visual illustration to better explain where the attribute goes.

Styled blockquotes, seems it hasn't been done before? So I just went for it trying to give it a generic but reusable style that seems to match the guides.

Rendered:
image

@hergaiety hergaiety changed the title Text content rewrite of a11y lang attr Adjustments to A11y Lang Attribute section Jun 29, 2020

Note: a page cannot have multiple language attribute _values_. For example, this means that `lang="en"` could be set on the page's HTML element and then `lang="es"` could be set on a different element in the page content (as appropriate).
The `html` element may not have multiple `lang` _values_. Instead, an element containing content in a different language than the `html`'s `lang` may be wrapped in an element with its own `lang` attribute.
Copy link
Member

Choose a reason for hiding this comment

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

The 2nd sentence felt a little awkward. Does the following convey your meaning well?

Suggested change
The `html` element may not have multiple `lang` _values_. Instead, an element containing content in a different language than the `html`'s `lang` may be wrapped in an element with its own `lang` attribute.
The `html` element may not have multiple `lang` _values_. If an element contains content in a language different from the primary, then you can provide the element its own `lang` attribute.

Copy link
Member

@ijlee2 ijlee2 left a comment

Choose a reason for hiding this comment

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

The updated passages looked good overall. I left a few suggestions in the release version, but each suggestion would apply to all version starting with v3.12.0 (which, I think, is missing in this PR?).

I'd like to request 4 changes:

  • Make changes to v3.12.0 as well (unless there was a reason not to).
  • Include the words ember-intl and lang as lint exceptions in the file .local.dic. Doing so should help Travis CI pass.
  • I think we should avoid the reference to ember new --lang until the feature is implemented.
  • I think we should avoid style changes in this PR. If you run git grep -n "^> " in the guides/release folder, you will see that the <blockquote> element is used in several places. I do think the current style for <blockquote> isn't great. Updating the style would be better done in a separate PR (I'd open an issue first to invite feedback from general public) and invite @MelSumner and @mansona to provide feedback on what's the best way to update style for Ember Guides.

Can you rebase from the upstream master once more? Percy's "before" snapshots are using an old reference.

@hergaiety hergaiety force-pushed the ember-lang-attribute branch from f9dfc11 to 27b0fa2 Compare July 1, 2020 15:18
Copy link
Member

@ijlee2 ijlee2 left a comment

Choose a reason for hiding this comment

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

Thanks for working on this PR. It looks great!

@ijlee2 ijlee2 merged commit 1903be3 into ember-learn:master Jul 1, 2020
@hergaiety hergaiety deleted the ember-lang-attribute branch July 1, 2020 17:08
@hergaiety
Copy link
Contributor Author

Thanks for all the superb feedback @ijlee2, I've written up an issue for blockquote usage in the guides here: #1468

locks pushed a commit to locks/guides-source that referenced this pull request Jul 6, 2020
* Text content rewrite of a11y lang attr

* Illustration for sub elements with dif lang

* Ported to v3.13-v3.17

* Ported to v3.18

* Applied PR feedback

Co-authored-by: Ava Wroten <[email protected]>
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.

2 participants