Contrib.social

Custom help field for tip dialog

Open on Drupal.org →
Created on 24 March 2024, 8 months ago
Updated 16 September 2024, 2 months ago

Problem/Motivation

It would be also helpful if their could be customizable fields that contain text/link where content authors can get help. For example, the current design supports this user story:

"As a content author for an organization called Nature Team, I just created a page and Editora11y is saying there are 3 accessibility issues detected. I am reviewing the text in the 1st issue tip dialog. While the text is helpful, I need further help but am not sure what to do. I have to guess my way through making the fix."

Proposed resolution

An improvement would be to allow website admins to enter customizable fields for getting local help.

"As a web admin for Nature Team, we have committed to accessibility. We have created local resources to support our content authors. On an EditorA11y admin interface, we are prompted to enter fields for links for getting help. I enter links to our local internal webpages"

This would support this story:

"As a content author for Nature Team, I just created a page and Editora11y is saying there are 3 accessibility issues detected. I am reviewing the text in the EditorA11y tip dialog. While the text is helpful, I need further help. The tip dialog also includes a link 'Nature Team Help'. I click the link and it takes me to a page with resources our web team created to help us".

✨ Feature request
Status

Closed: works as designed

Version

2.1

Component

Feature and test requests

Created by

mweiler

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

Comments & Activities

  • Issue created by @mweiler
  • Assigned to itmaybejj
  • Status changed to Needs review 8 months ago
  • Comment 8 months ago →
    🇺🇸United States itmaybejj

    There is not a GUI for this, but it is possible now in code, as the the tip contents are all defined in a global variable.

    If you look at https://git.drupalcode.org/project/editoria11y/-/blob/2.1.x/library/js/e...
    - each tip can be overridden in theme or injected JS, so long as it comes after the object is created

    Writing on a phone so can't promise this is right but basically:

    ed11yLang.en.altEmptyLinked.tip = () => `<p>hi</p>`

  • Status changed to Closed: works as designed 2 months ago
  • Comment 2 months ago →
    🇺🇸United States itmaybejj

    I'm closing this for now. The work it would take to add variables for all the strings to the GUI and map all those variables to the localization file is just out of scope for me. If someone wrote it, I'd review it.

    At the JS level, the localization file can be overwritten with your own values. Or you can use the ed11yPop event to modify the rendered tips however you want -- e.g., by adding that help link.

    That said -- the default language in the tips are just the result of this community winging it. I heartily welcome suggestions for improvement.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024