D8CORE-1835: Added <abbr> button to CKEditor

[imonroe]

READY FOR REVIEW

Summary

• Adds a button to CKEditor for <abbr>

Review By (Date)

• 5/19/21

Criticality

• low

Urgency

• Normal

Review Tasks

Setup tasks and/or behavior to test

1. Follow the instructions here: D8CORE-1835: Added abbr buttons to ckeditor stanford_profile#550

Site Configuration Sync

• Is there a config:export in this PR that changes the config sync directory? N/A

Front End Validation

• Design is approved by @ user?
• HTML validation: Is the markup using the appropriate semantic tags and passes validation? Or, QA request ticket created?
• Cross-browser testing: Has been performed? Or, QA request ticket created?
• Automated accessibility: Scans performed? Or, QA request ticket created?
• Manual accessibility: Manually tested? Or, QA request ticket created?

Backend / Functional Validation

Code

• Are the naming conventions following our standards?
• Does the code have sufficient inline comments?
• Is there anything in this code that would be hidden or hard to discover through the UI?
• Are there any code smells?
• Are tests provided? eg (unit, behat, or codeception)

Code security

• Are all forms properly sanitized?
• Any obvious security flaws or new areas for attack?

General

• Is there anything included in this PR that is not related to the problem it is trying to solve?
• Is the approach to the problem appropriate?

Affected Projects or Products

• Does this PR impact any particular projects, products, or modules?

Associated Issues and/or People

• JIRA ticket(s)
• Other PRs
• Any other contextual information that might be helpful (e.g., description of a bug that this PR fixes, new functionality that it adds, etc.)
• Anyone who should be notified? (@mention them here)

Resources

• AMP Tool
• Accessibility Manual Test Script
• HTML Validator
• Browserstack and link to Browserstack Credentials

[pookmish]

Can't this be added in the same way our other ckeditor plugins are? https://github.com/SU-SWS/stanford_text_editor/blob/8.x/composer.json#L7

[imonroe]

So that's a great question. It's not an official plugin; it's actually taken from CKEditor's own documentation about how to write plugins. Here's the original source: https://github.com/ckeditor/ckeditor4-docs-samples/tree/master/tutorial-abbr-2/abbr

As you can see, it's a couple layers down into the repo instead of standing alone. I suppose we could pull it out and put it in a separate repo, but I'm not sure what we'd get in terms of benefit there. Nobody else would be updating it, so it would never change.

[pookmish]

Ok that makes sense then... next question... do we need a button for it?

[pookmish]

because we'll have to re-build this for Ckeditor 5 later

[imonroe]

Well, the button was the ask in the ticket: https://stanfordits.atlassian.net/browse/D8CORE-1835

If we want to decide not to do it, that's fine too, but maybe we should ask @cjwest. 🤷

[pookmish]

I'd rather just allow the tag, but not do the whole button approach. It's not a very common element anyways.
Sorry that you did the development to get the button.
Keep this PR open just in case we decide we want it later.

otherwise, lets adjust the profile PR to just add the tag as allowed.