Add a tour for the ECA main page

Created on 3 January 2023, over 1 year ago
Updated 3 March 2024, 6 months ago

Problem/Motivation

At the moment the onboarding for screen reader users, aside the general a11y related issues upstream, to communicate the basic concepts of ECA and BPMN, is sort of challenging - it is simply difficult near to impossible to orient and grasp the general basic structure without any visual queues. An aspect that is even potentially an issue for some sighted users.

Steps to reproduce

Proposed resolution

ECA main tour (route: entity.eca.collection):

  1. a general tip with no focus
  2. models tab in focus
  3. import tab in focus
  4. settings tab in focus
  5. log tab in focus
  6. parameters tab in focus (the tip is defined but is only displayed when the parameters module is installed)
  7. add new model button in focus - quickly explain that either a new model editing screen is opened if a single modeler is installed or you have the option to choose in which modeler you want to create your model in if more than one modeler is installed.

=> ideally it would be good to add a tip to several or even each of the columns available but i am not sure with which selector that could be accomplished. so far i lean towards having a single tip for #edit-eca-entities thead
=> I wouldn't create a dedicated tour for the import and log pages.

Remaining tasks

User interface changes

API changes

Data model changes

Feature request
Status

Active

Version

2.0

Component

User interface

Created by

🇩🇪Germany rkoller Nürnberg, Germany

Live updates comments and jobs are added and updated live.
  • Usability

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

  • Accessibility

    It affects the ability of people with disabilities or special needs (such as blindness or color-blindness) to use Drupal.

Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Merge request !285Issue #3330840: Add a tour for the ECA main page → (Closed) created by rkoller
  • 🇩🇪Germany rkoller Nürnberg, Germany

    I've pushed a first draft for the tour tip content. I tried to mind the tour text standards defined here: https://www.drupal.org/docs/develop/user-interface-standards/tour-text-s... . the first unfocused tour tip describing the whole page is therefore intentionally without a selector and unfocused. some descriptions seem apparent but it has to be kept in mind that screen reader users dont have the extra visual context and information. there are a few open questions:

    1. the number of tour tips differs between claro and gin. in claro you have 8 tips while in gin you have 13 (the reason see #8 Add a tour for the ECA main page Active - when a selector isn't found the tip is simply left out of the tour). question is should the List of models be shown at all? or the other way around should the column header tips be shown at all instead?

    2. except the add new model button i've switched the positioning to an explicit value. for the button in claro it would be best to show it to the right while in gin the button is better shown to the left or the bottom. therefore a clearly defined position doesnt work for that tour tip but for the others it does.

    3. and any feedback is welcome in regards of word smithing and details that have to be communicated.

  • Status changed to Needs work over 1 year ago
  • 🇩🇪Germany jurgenhaas Gottmadingen

    This is looking good to me except that the parameters tab should be removed as it's not provided by ECA. That tour item should be moved to the eca_parameter module.

    The column headers are OK as they are now. It's perfect that they adjust to what's possible depending on the active admin theme.

    As for the location of the button to add a new model, I don't think we need to bother about that in this issue.

    Wording is good to me. And I prefer to move incrementally. That's why I suggest merging this an adopt changes later, if anyone is going to propose any. Otherwise, issues like this remain open forever. IN other words, once the parameter tab is being removed, this would be RTBC to me.

  • 🇩🇪Germany rkoller Nürnberg, Germany

    the tab is only displayed when eca_parameters is installed. if eca_parameters isnt installed it isn't displayed. and for the case eca_parameters is installed i would leave the tip in for consistency and clarity reasons. all other tabs have a tip so the parameters should have its own imho. that was the reason i've added it in the first place.

    and about adding the model and move incrementally. i completely agree but there is one detail i've realized that might make the move incrementally a bit difficult. when eca is already installed with the tip for the main page for example and in a new update that tip is updated those changes aren't available after the update of eca? i've simply changed a tip label manually for a project where eca is already installed and those changes where not in place when i've started the tour (also cleared caches before). is it possible that due to the fact that the tour is config that the config is only loaded on module install and for subsequent updates some config import would be necessary?

  • 🇩🇪Germany rkoller Nürnberg, Germany

    and i've found the corresponding issue on d.o about tour tips never getting updated: 🐛 Tour tips are provided as configuration, so never get updated Postponed

  • 🇩🇪Germany jurgenhaas Gottmadingen

    the tab is only displayed when eca_parameters is installed. if eca_parameters isnt installed it isn't displayed. and for the case eca_parameters is installed i would leave the tip in for consistency and clarity reasons. all other tabs have a tip so the parameters should have its own imho. that was the reason i've added it in the first place.

    That's technically correct, but still why should ECA have a tour for a third party component in its code? For long term maintenance, it is important to keep things where they belong to.

    And for the whole config update questions, this is a very generic topic. Yes, modules that come with config updates have to be aware, that the updated config is not updated on existing Drupal installations. We should not bother about that here, it would only distract us from what we want to achieve here.

  • Status changed to Postponed about 1 year ago
  • 🇩🇪Germany jurgenhaas Gottmadingen
  • 🇩🇪Germany jurgenhaas Gottmadingen
  • Status changed to Active 7 months ago
  • 🇩🇪Germany jurgenhaas Gottmadingen

    Moving to the separate module.

  • Pipeline finished with Failed
    3 months ago
    #192974
  • Pipeline finished with Success
    3 months ago
    Total: 216s
    #192975
  • Pipeline finished with Success
    3 months ago
    Total: 212s
    #192982
  • Pipeline finished with Failed
    about 1 month ago
    Total: 435s
    #234907
Production build 0.71.5 2024