The help menu for CKEditor doesn't tell authors that a language toolbar button is available if an administrator adds it to the menu bar. I would have preferred to have added it initially to the original Drupal 8 issue, but the very least that we can do is ensure that it is documented.

Currently from /admin/help/ckeditor we see this:

Accessibility features
The built in WYSIWYG editor (CKEditor) comes with a number of accessibility features. CKEditor comes with built in keyboard shortcuts, which can be beneficial for both power users and keyboard only users.

Generating accessible content
HTML tables can be created with both table headers as well as caption/summary elements. Alt text is required by default on images added through CKEditor (note that this can be overridden). Semantic HTML5 figure/figcaption are available to add captions to images.

I think we can change this paragraph:

<dt>Generating accessible content</dt>
<dd>HTML tables can be created with both table headers as well as caption/summary elements. Alt text is required by default on images added through CKEditor (note that this can be overridden). Semantic HTML5 figure/figcaption are available to add captions to images.</dd>

To include something like this:

<dt>Generating accessible content</dt>
<dd>HTML tables can be created with both table headers as well as caption/summary elements. Alt text is required by default on images added through CKEditor (note that this can be overridden). Semantic HTML5 figure/figcaption are available to add captions to images. If your authors are multi-lingual you may want to enable the Language of Parts button from the <a href="/admin/config/content/formats">Text formats and editors</a> configuration.</dd>

I'm a bit rusty, but just realized today that we hadn't included this.

After screenshot

CommentFileSizeAuthor
#38 interdiff-38.txt1.02 KBPooja Ganjage
#38 3150364-38.patch1.82 KBPooja Ganjage
#35 interdiff-35.txt1.03 KBPooja Ganjage
#35 3150364-35.patch1.8 KBPooja Ganjage
#31 3150364-31.patch1.83 KBPooja Ganjage
#28 3150364-after_patch-23.png44.61 KBAbhijith S
#28 3150364-before.png35.72 KBAbhijith S
#24 Screenshot from 2020-09-29 15-13-29.png16.34 KBquietone
#23 3150364-23.patch1.8 KBPooja Ganjage
#21 Screenshot_2020-09-25 CKEditr.png13.56 KBquietone
#21 3150364-21.patch1.81 KBquietone
#21 interdiff-15-21.txt1.33 KBquietone
#17 afterPatch.png67.43 KBpankaj.singh
#17 beforePatch.JPG225 KBpankaj.singh
#15 3150364-15.patch1.89 KBrajneeshb
#15 interdiff-14-15.txt1.1 KBrajneeshb
#14 interdiff-12-14.txt910 bytesrajneeshb
#14 3150364-14.patch1.96 KBrajneeshb
#12 3150364-12.patch1.89 KBrajneeshb
#10 3150364-10.patch1.87 KBrajneeshb
#9 3150364-9.patch1.87 KBrajneeshb
#3 3150364-3.patch1.68 KBrajneeshb
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

mgifford created an issue. See original summary.

rajneeshb’s picture

rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
Assigned: Unassigned » rajneeshb

I am looking on it

rajneeshb’s picture

rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
Assigned: rajneeshb » Unassigned
Status: Active » Needs review
FileSize
3150364-3.patch1.68 KB

Created a patch as per IS.

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer commented
Status: Needs review » Needs work
  • enable the Language of Parts button - the button isn't called that. It's called "language".
  • If your authors are multi-lingual - This could be phrased better I think. It's about multi-lingual content, not the authors themselves. After all, Drupal is a multi-user system, and not all users may be multi-lingual. Something like "to support multi-lingual content, a language button can be enabled".
  • "Language of Parts" is WCAG jargon, and is capitalized here. If we keep that phrase, it would be good to link to the WCAG success criterion 3.1.2.
  • This accessibility section is starting to get long - 4 tips in one list item. Can we split these up into separate items, as a nested list? I don't know what the doc standards say about nested lists, so maybe it the accessibility features can be moved to a separate heading.
andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer commented
Issue tags: +Bug Smash Initiative

This would be a nice quick-win for the bug smash initiative.

mgifford’s picture

mgifford
he/him
Primary language English
CreditAttribution: mgifford at OpenConcept Consulting Inc. commented

Thanks @rajneeshb & @andrewmacpherson!

I do think this is easier to read:
To support multi-lingual content, a language button can be <a href="/admin/config/content/formats">enabled</a>.

I wanted to avoid confusion though for those who might interpret this as having a multilingual site. Adding this button won't help with that, but it will help for those who want to have multiple languages on one page. Maybe:

To support multi-lingual page content, a language button can be <a href="/admin/config/content/formats">enabled</a>.

I like the idea of breaking up that list of tips, so maybe something like:

<dt>Generating accessible content</dt>
<dd><ul><li>HTML tables can be created with both table headers as well as caption/summary elements. </li>
<li>Alt text is required by default on images added through CKEditor (note that this can be overridden). </li>
<li>Semantic HTML5 figure/figcaption are available to add captions to images. </li>
<li>To support multi-lingual page content, a language button can be <a href="/admin/config/content/formats">enabled</a>.</li></ul></dd>

That looks a bit fishy

rajneeshb’s picture

rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
Assigned: Unassigned » rajneeshb

I will look on it and create a patch as per #6

rajneeshb’s picture

rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
Assigned: rajneeshb » Unassigned
Status: Needs work » Needs review

Create a patch as per the #6

rajneeshb’s picture

rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
FileSize
3150364-9.patch1.87 KB

uploading updated patch as per #6

rajneeshb’s picture

rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
FileSize
3150364-10.patch1.87 KB

In last patch there was some spacing issue so remove that patch and uploading again updated patch as per #6

Status: Needs review » Needs work

The last submitted patch, 10: 3150364-10.patch, failed testing. View results

rajneeshb’s picture

rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
FileSize
3150364-12.patch1.89 KB

I missed the closing tags so uploading the updated patch.

rajneeshb’s picture

rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
Status: Needs work » Needs review
rajneeshb’s picture

rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
FileSize
3150364-14.patch1.96 KB
interdiff-12-14.txt910 bytes

correction in tags required. So uploading the updated patch

rajneeshb’s picture

rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
FileSize
interdiff-14-15.txt1.1 KB
3150364-15.patch1.89 KB

Removed the duplicate text in the last patch

quietone’s picture

quietone CreditAttribution: quietone as a volunteer commented

The patch addresses the issues in #4.

And reading the issue the only unanswered question I see is from #4-4 and I don't know the answer either.

I don't know what the doc standards say about nested lists, so maybe it the accessibility features can be moved to a separate heading

.
Is the nested list OK or does it need to be done in a different way?

pankaj.singh’s picture

pankaj.singh CreditAttribution: pankaj.singh as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented
FileSize
beforePatch.JPG225 KB
afterPatch.png67.43 KB

Tested the patch given in #15. Patch worked fine on my end.

Changes are reflecting. Although it was expected to have a paragraph but helping text sentences are appearing with bullets is more convenient to go through.

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer commented

Thanks for working on this everybody. This issue is going well.

The "after" screenshot in #17 looks good overall.

  1. I'll mention this issue in the documentation channel in Drupal Slack, to get advice on whether nested lists or a separate heading are preferred. I don't know if it makes a huge difference either way.
  2. I think "enabled" isn't very good link text on it's own. It satisfies WCAG "link purpose (in context)" at level A, but with a little tweak it could satisfy WCAG "link purpose (link only)" at level AAA. Perhaps make the whole clause a link: to support multi-lingual page content, <a href="/admin/config/content/formats">a language button can be enabled.</a>.
  3. ... But I'm not sure it has to be linked at all. We don't provide a link for the other items in this list. (Sorry, bikeshedding. I'll defer to more experienced documentation writers.)
andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer commented
Title: Add a description for the language toolbar button to the Help Screen » Add a description for the language toolbar button to the CKEditor help page
Component: help.module » ckeditor.module
Issue tags: +Documentation
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

A few thoughts:

a) I don't think it's a problem to have a bullet list in the DD element. Semantically, it makes sense.

b) How do you enable the language button? Is it different from how you enable other buttons in CKEditor? It looks like the link is going to the Filters admin page, which in any case is not what I would expect from a link whose link text is "enabled"... I think the best thing is to remove the link. But it's not clear from this text what the button is or where it would go, really -- maybe say something like "a language button can be added to editor toolbars"?

c) It was in the original, but do you think we could also change the wording of the first bullet point slightly:

HTML tables can be created with both table headers as well as caption/summary elements

The "both ... as well as..." seems awkward to me. I think "as well as" should just be "and", or else the word "both" should go away.

d) We should make sure this information gets into the new Help Topics as well. We already made help topics for Editor and CKEditor modules, and we already have a topic on Accessibility, so I'll add a note to #3121340: Fix up minor copy problems in help topics.

quietone’s picture

quietone CreditAttribution: quietone as a volunteer commented
Issue summary: View changes
FileSize
interdiff-15-21.txt1.33 KB
3150364-21.patch1.81 KB
Screenshot_2020-09-25 CKEditr.png13.56 KB

20.a Answers the question from #4-4 about nested lists. IIt is OK to have them.
20.b Removed the link and changed the text to 'To support multi-lingual page content, a language button can be added to editor toolbars.'
20.c Text changed, removed 'both' and added 'and'.

And a new screenshot.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

I don't think multilingual has a hyphen in it. Maybe in that last bullet we should say CKEditor instead of "editor"? The second bullet says CKEditor... Otherwise, looks good!

Pooja Ganjage’s picture

Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commented
FileSize
3150364-23.patch1.8 KB

Hi,

I am applying patch using comment #21 and updating patch as per given suggestions by @jhodgdon.

Please review patch.

Thanks.

quietone’s picture

quietone CreditAttribution: quietone as a volunteer commented
Issue summary: View changes
FileSize
Screenshot from 2020-09-29 15-13-29.png16.34 KB

Updating screenshot in the IS after applying the patch in #23.

mgifford’s picture

mgifford
he/him
Primary language English
CreditAttribution: mgifford at OpenConcept Consulting Inc. commented
Issue tags: +we4authors

Would be great if this were more apparent. The Language toolbar button is something that is being discussed in a European initiative to improve the accessibility of popular authoring tools like Drupal.
https://accessibilitycluster.com/authoringTool/

This should be documented as most people who have content in most languages have no idea that this even exists in Core.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Related issues: +#3121340: Fix up minor copy problems in help topics

We have a plan to add this to the help topic on accessibility on this related issue.

Is this mentioned in the drupal.org accessibility documentation?

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Abhijith S’s picture

Abhijith S CreditAttribution: Abhijith S as a volunteer and at Zyxware Technologies commented
FileSize
3150364-before.png35.72 KB
3150364-after_patch-23.png44.61 KB

Applied patch #23 and it works .The description for the language toolbar button seems fine.Adding screenshots below

before patch:
before

after patch:
after

Abhijith S’s picture

Abhijith S CreditAttribution: Abhijith S as a volunteer and at Zyxware Technologies commented
Status: Needs review » Reviewed & tested by the community
mgifford’s picture

mgifford
he/him
Primary language English
CreditAttribution: mgifford at CivicActions commented

I wonder if it should be more explicit than:
'To support multilingual page content, a language button can be added to CKEditor toolbars.'

I would recommend something like:
'To support multilingual page content, CKEditor can be configured in Drupal 8 to include a language button in the toolbar.'

to help point authors to how this is done. You don't need to download a new CKEditor plugin, or engage a developer to add the toolbar. You just need someone with access to admin rights to configure CKEditor so that the button appears.

Perhaps this can be better expressed.

Pooja Ganjage’s picture

Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commented
FileSize
3150364-31.patch1.83 KB

Hi,

Creating a patch as suggested in #30 comment.

Please review the patch.

Thanks.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Reviewed & tested by the community » Needs work

That is not good. We don't want to use the word "Drupal" in there, and definitely not "Drupal 8" as this is a patch for Drupal 9 and will likely still be present in Drupal 10.

I like the previous patch more. What about the wording there did you think needed to be changed (without adding "Drupal 8" to it)?

Also when you make a new patch, please include an interdiff, and set the status to Needs Review (never leave it at Reviewed and tested if it's a new patch that hasn't been reviewed or tested).

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

Regarding not using the word Drupal, see
https://www.drupal.org/docs/develop/user-interface-standards/interface-t...

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

See also this meta issue: #2144861: [meta] Replace Drupal in UI text with the name of the distribution

Pooja Ganjage’s picture

Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commented
FileSize
3150364-35.patch1.8 KB
interdiff-35.txt1.03 KB

Hi,

Creating a patch and interdiff as suggested in #32 comment.

Please review the patch and interdiff.

Thanks.

Pooja Ganjage’s picture

Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commented
Status: Needs work » Needs review
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Needs work

OK, it looks like we are back to the previous patch.

I think mgifford in #30 was suggesting that we want to get the word "configured" in there, to make sure that people understand this a bit more. So can the wording be changed to use the word "configured" instead of "added"? mgifford suggested 'To support multilingual page content, CKEditor can be configured in Drupal 8 to include a language button in the toolbar.' ... maybe just take out the "in Drupal 8" part?

Pooja Ganjage’s picture

Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commented
FileSize
3150364-38.patch1.82 KB
interdiff-38.txt1.02 KB

Attached updated patch and interdiff as suggested in #37 comment.

Please review the patch and interdiff.

Thanks

Pooja Ganjage’s picture

Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commented
Status: Needs work » Needs review
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Reviewed & tested by the community

looks good, thanks!

  • lauriii committed 81768d4 on 9.2.x 
    Issue #3150364 by rajneeshb, Pooja Ganjage, quietone, jhodgdon, mgifford...
lauriii’s picture

lauriii
he/him
Primary language Finnish
Location Finland
CreditAttribution: lauriii at Acquia commented
Status: Reviewed & tested by the community » Fixed

Committed 81768d4 and pushed to 9.2.x. Thanks!

Not going to backport to 9.1.x because the change introduces changes in translatable strings.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.