https://github.com/prgfx/prgfx.neos.textpartlanguage

Neos package to integrate the ckeditor5-language plugin into the CKEditor to allow tagging content for specific languages
https://github.com/prgfx/prgfx.neos.textpartlanguage

ckeditor neoscms

Last synced: 1 day ago
JSON representation

Neos package to integrate the ckeditor5-language plugin into the CKEditor to allow tagging content for specific languages

• Host: GitHub
• URL: https://github.com/prgfx/prgfx.neos.textpartlanguage
• Owner: PRGfx
• License: gpl-3.0
• Created: 2021-04-30T12:27:04.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-20T12:57:21.000Z (over 1 year ago)
• Last Synced: 2024-11-08T00:50:00.211Z (13 days ago)
• Topics: ckeditor, neoscms
• Language: JavaScript
• Homepage:
• Size: 249 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Version](https://poser.pugx.org/prgfx/neos-textpartlanguage/version)](//packagist.org/packages/prgfx/neos-textpartlanguage)

# Prgfx.Neos.TextPartLanguage

This package allows editors to tag selected text with a language, helping assistive technology with pronunciation, implementing the [WCAG 3.1.2 Language of Parts](https://www.w3.org/TR/UNDERSTANDING-WCAG20/meaning-other-lang-id.html) specification.

```

composer require prgfx/neos-textpartlanguage

```

This plugin is based on [@ckeditor/ckeditor5-language](https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-language), making the necessary adaptations to use it with the Neos backend.

![Screenshot of the plugin in the Neos backend](./Documentation/assets/preview.png)

## Usage

Enable it for a node property:

```yaml

'Neos.Demo:Content.Text':

  properties:

    text:

      ui:

        inline:

          editorOptions:

            textLanguages: true

```

Or set specific properties:

```yaml

'Neos.Demo:Content.Text':

  properties:

    text:

      ui:

        inline:

          editorOptions:

            textLanguages:

              languages:

                de: German

                en: My.Package:Main:textLanguages.languages.en

                fr: French

                gr: ~

              placeholder: My.Package:Main:textLanguages.placeholder

```

## Configuration

By default, this plugin provides the system-languages configured in `Neos.Neos.userInterface.availableLanguages`, but different default values can be set at `Neos.Neos.Ui.frontendConfiguration.'Prgfx.Neos.TextPartLanguage:languages'`.

## Appearance

In the backend this plugin underlines all marked text-elements through a stylesheet included in `prototype(Neos.Neos:Page).head.stylesheets.textPartLanguage` which you might disable, if you don't require it or want to apply custom styling.