README

This extension ships a simple plugin for the ckeditor to allow editors setting abbreviations. The plugin itself has been taken from https://github.com/ckeditor/ckeditor5-tutorials-examples/tree/main/abbreviation-plugin/part-3 without some changes.

Installation

Use ddev composer req michaelstaatz/ckeditor5-abbreviation or download the extension from TER.

Usage

All it takes to enable the plugin are the following changes in your RTE.yaml:

1. Import the configuration from the extension:

editor:
  config:
    importModules:
      - '@mista/ckeditor5_abbreviation/abbreviation.js'
    htmlSupport:
      allow:
        - { name: 'abbr', attributes: true, classes: true, styles: true }
    contentsCss:
      - "EXT:ckeditor5_abbreviation/Resources/Public/Css/Abbr.css"

1. Enable the plugin:

editor:
  config:
    toolbar:
      items:
        - abbreviation

1. Load the CSS - File

page.includeCSS.abbreviation-tooltip = EXT:ckeditor5_abbreviation/Resources/Public/Css/AbbreviationTooltip.css

Optional

There is an UpgradeWizard as part of this extension. Purpose is to replace all <abbr title=" with <abbr data-tooltip="

Credits

This extension was created by Michael Staatz with ♥ and is inspired by the extension rte_ckeditor_abbr