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
Comment | File | Size | Author |
---|---|---|---|
#38 | interdiff-38.txt | 1.02 KB | Pooja Ganjage |
#38 | 3150364-38.patch | 1.82 KB | Pooja Ganjage |
#35 | interdiff-35.txt | 1.03 KB | Pooja Ganjage |
#35 | 3150364-35.patch | 1.8 KB | Pooja Ganjage |
#31 | 3150364-31.patch | 1.83 KB | Pooja Ganjage |
Comments
Comment #2
rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedI am looking on it
Comment #3
rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedCreated a patch as per IS.
Comment #4
andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer commentedenable 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".Comment #5
andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer commentedThis would be a nice quick-win for the bug smash initiative.
Comment #6
mgiffordThanks @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:
That looks a bit fishy
Comment #7
rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedI will look on it and create a patch as per #6
Comment #8
rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedCreate a patch as per the #6
Comment #9
rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commenteduploading updated patch as per #6
Comment #10
rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedIn last patch there was some spacing issue so remove that patch and uploading again updated patch as per #6
Comment #12
rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedI missed the closing tags so uploading the updated patch.
Comment #13
rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedComment #14
rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedcorrection in tags required. So uploading the updated patch
Comment #15
rajneeshb CreditAttribution: rajneeshb as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedRemoved the duplicate text in the last patch
Comment #16
quietone CreditAttribution: quietone as a volunteer commentedThe 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.
.
Is the nested list OK or does it need to be done in a different way?
Comment #17
pankaj.singh CreditAttribution: pankaj.singh as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedTested 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.
Comment #18
andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer commentedThanks for working on this everybody. This issue is going well.
The "after" screenshot in #17 looks good overall.
to support multi-lingual page content, <a href="/admin/config/content/formats">a language button can be enabled.</a>
.Comment #19
andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer commentedComment #20
jhodgdonA 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:
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.
Comment #21
quietone CreditAttribution: quietone as a volunteer commented20.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.
Comment #22
jhodgdonI 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!
Comment #23
Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commentedHi,
I am applying patch using comment #21 and updating patch as per given suggestions by @jhodgdon.
Please review patch.
Thanks.
Comment #24
quietone CreditAttribution: quietone as a volunteer commentedUpdating screenshot in the IS after applying the patch in #23.
Comment #25
mgiffordWould 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.
Comment #26
jhodgdonWe 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?
Comment #28
Abhijith S CreditAttribution: Abhijith S as a volunteer and at Zyxware Technologies commentedApplied patch #23 and it works .The description for the language toolbar button seems fine.Adding screenshots below
before patch:
after patch:
Comment #29
Abhijith S CreditAttribution: Abhijith S as a volunteer and at Zyxware Technologies commentedComment #30
mgiffordI 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.
Comment #31
Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commentedHi,
Creating a patch as suggested in #30 comment.
Please review the patch.
Thanks.
Comment #32
jhodgdonThat 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).
Comment #33
jhodgdonRegarding not using the word Drupal, see
https://www.drupal.org/docs/develop/user-interface-standards/interface-t...
Comment #34
jhodgdonSee also this meta issue: #2144861: [meta] Replace Drupal in UI text with the name of the distribution
Comment #35
Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commentedHi,
Creating a patch and interdiff as suggested in #32 comment.
Please review the patch and interdiff.
Thanks.
Comment #36
Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commentedComment #37
jhodgdonOK, 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?
Comment #38
Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commentedAttached updated patch and interdiff as suggested in #37 comment.
Please review the patch and interdiff.
Thanks
Comment #39
Pooja Ganjage CreditAttribution: Pooja Ganjage at Asentech LLC commentedComment #40
jhodgdonlooks good, thanks!
Comment #42
lauriiiCommitted 81768d4 and pushed to 9.2.x. Thanks!
Not going to backport to 9.1.x because the change introduces changes in translatable strings.