Minor Improvements to the CK Editor module

Created on 5 September 2024, 15 days ago
Updated 13 September 2024, 7 days ago

Problem/Motivation

Working through the CK Editor plugin with a client bought out a couple of quick easy wins to improve CK Editor Assistants.

Remaining tasks

  • If you do not have permission to see a CKEditor Assistant, than it shouldn't appear
  • The title "Completion" is confusing and not technically accurate either. Change it to "Generate with AI"
  • I'm thinking we should retire the robot and replace it with the sparkle sign that everyone is using everywhere?
  • Make "Help and Support" configurable as it currently confuses people. We can bring it in more prominently if we get round to making our AI website.
  • Make the Taxonomy CK Editors (Tone and Translate) use the Description of the taxonomy term in the prompt as well. This will allow people to provide either clarifications on what the tone means or further instructions to the LLM for the client specific use case. For example a "Corporate Tone" could provide a prompt to explain and give examples of what that means for this organisation.
  • Write helper text in the place where you choose taxonomy for CK Editors situations (Tone, Translate). "The description field for each taxonomy term chosen will also be pasted to AI. You can use this to clarify what you mean by that term for the AI or provide further instructions when that term is selected".
  • Also make use of description for automators. The prompt should list the taxonomy terms for the AI as it does. But then say "Further information about the term" and then list them again with their description attached if there are any descriptions.
  • Helper text can be "The descriptions of the taxonomy terms are also presented to the AI to clarify when to choose a specific term and what that term means.
  • Have the modal popup auto resize when its too big

User interface changes

API changes

Data model changes

📌 Task
Status

Fixed

Version

1.0

Component

Miscellaneous

Created by

🇬🇧United Kingdom yautja_cetanu

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @yautja_cetanu
  • 🇬🇧United Kingdom yautja_cetanu
  • First commit to issue fork.
  • 🇧🇪Belgium wouters_f Leuven

    Disabled items will not be shown:

    Make Help & support configurable

    Notice the sparkles too.
    I would suggest to create a gray version of the sparkles because now its the only colored SVG wich stands out (maybe a bit too much).

  • 🇧🇪Belgium wouters_f Leuven
    • ✅ If you do not have permission to see a CKEditor Assistant, than it shouldn't appear
    • ✅ The title "Completion" is confusing and not technically accurate either. Change it to "Generate with AI"
    • ✅ I'm thinking we should retire the robot and replace it with the sparkle sign that everyone is using everywhere?
    • ✅ Make "Help and Support" configurable as it currently confuses people. We can bring it in more prominently if we get round to making our AI website.
    • Make the Taxonomy CK Editors (Tone and Translate) use the Description of the taxonomy term in the prompt as well. This will allow people to provide either clarifications on what the tone means or further instructions to the LLM for the client specific use case. For example a "Corporate Tone" could provide a prompt to explain and give examples of what that means for this organisation.
    • Write helper text in the place where you choose taxonomy for CK Editors situations (Tone, Translate). "The description field for each taxonomy term chosen will also be pasted to AI. You can use this to clarify what you mean by that term for the AI or provide further instructions when that term is selected".
    • Also make use of description for automators. The prompt should list the taxonomy terms for the AI as it does. But then say "Further information about the term" and then list them again with their description attached if there are any descriptions.
    • Helper text can be "The descriptions of the taxonomy terms are also presented to the AI to clarify when to choose a specific term and what that term means.
    • Have the modal popup auto resize when its too big
  • Merge request !61Resolve #3472421 "Ckeditor improvements" → (Merged) created by wouters_f
  • 🇩🇪Germany Marcus_Johansson

    So, I have fixed the rest, with some modifications:

    It wasn't mentioned here, but we wanted select lists on translate and tone, instead of autocomplete. I have implemented so it is that when the checkbox "Allow autocreate" is unchecked.
    I have added a checkbox in the settings called "Use term description for translation context", see screenshot. When this is enabled it uses the description if it exists.
    The description is available in the Taxonomy rule now in Automator as an optional token. So you can choose the list with just labels or the list with everything.

    The reasoning behind doing settings there, is that you might use the description for other purposes, like the Automator or actually describing the taxonomy term to the end user, so it shouldn't be used automatically.

    Regarding the resizing, there were settings already in the CKEditor module, so they should be enough to fix the size glitch we saw.

  • Status changed to Needs review 15 days ago
  • Status changed to Fixed 10 days ago
Production build 0.71.5 2024