Contrib.social

Update Comment Notify interface to follow usability best practices

Open on Drupal.org →
Created on 17 October 2023, over 1 year ago

Problem/Motivation

There are certain aspects of the Comment Notify module that are unclear and unintuitive. Updating this to use Drupal's user interface standards → will improve the module's usability.

Steps to reproduce

Enable the module and visit the Comment notification settings page.

Proposed resolution

Update the module's interface to follow Drupal's user interface standards → .

Remaining tasks

The following should be updated:

  1. Update "Bundles to enable for comment notification" to "Content to enable for comment notification"
  2. Update "Comments on bundle types enabled here will have the option of comment notification. Written as "Entity Type: Bundle: Comment field"." to "Comments on entity types enabled here will have the option of comment notificatiion."
  3. Remove the help text, "Choose which notification subscription styles are available for users"
  4. Change the Default state for the notification selection box from a select list to a checkbox
  5. Update "This flag presets the flag for the follow-up notification on the form that users will see when posting a comment" to "Choose the default subscription mode if both subscriptions modes are enabled.
  6. Update "If this is checked, new users will receive e-mail notifications for follow-ups on their entities by default until they individually disable the feature." to "Enable to email authors when new comments are published, unless they opt out for a specific content item."
  7. Update "Default mail subject for sending out node notifications to commenters" to "Default email subject for notifying commenters"
  8. Update "Default mail subject for sending out node notifications to authors" to "Default email subject for notifying authors"
  9. Update "node: Default mail text for sending out the notifications to entity authors" to "Default email message for notifying authors"
  10. Update "[comment:author] has commented on: "[node:title]" to "[comment:author] commented on "[node:title]"
  11. Update "You can view the comment at the following url [comment:url]" to "View the comment at [comment:url]"
  12. Update "You can stop receiving emails when someone replies to this post,
    by going to [comment-subscribed:unsubscribe-url]" to "Stop receiving emails when someone replies to this post,
    by visiting [comment-subscribed:unsubscribe-url]"
  13. Remove "You can set up auto-following feature for all future posts by creating your own user with a few clicks here [site:login-url]"

User interface changes

See above.

API changes

None

Data model changes

None

📌 Task
Status

Active

Version

1.0

Component

User interface

Created by

🇺🇸United States cedewey Denver, CO

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

Comments & Activities

  • Issue created by @cedewey
  • Comment over 1 year ago →
    🇺🇸United States cedewey Denver, CO
  • First commit to issue fork.
  • Open in Jenkins → Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update over 1 year ago
    12 pass, 2 fail
  • @diwakar07 opened merge request.
  • Assigned to diwakar07
  • Status changed to Needs review over 1 year ago
  • Comment over 1 year ago →
    🇮🇳India diwakar07

    Hi,
    I have updated the Comment Notify interface page accordingly.
    Please review.

  • Issue was unassigned.
  • Comment 12 months ago →
    🇮🇳India diwakar07
  • Comment 12 months ago →
    🇺🇸United States greggles Denver, Colorado, USA

    Thanks for this proposal, @cedewey and for making the fixes, @Diwakar07!

    @cedewey are you able to review the proposed merge request?

  • Status changed to RTBC 11 months ago
  • Comment 11 months ago →
    🇮🇳India Indranil Roy kolkata

    Hey @Diwakar07,
    I have tested your MR. LGTM.

  • Status changed to Needs work 5 months ago
  • Comment 5 months ago →
    🇹🇭Thailand AlfTheCat

    Hi guys, thanks for the great work.

    I ran into 3 issues after applying the patch (running Drupal 10.3.9):

    1 - the new setting for "Default state for the notification selection box" is confusing because the help text: "Choose the default subscription mode if both subscriptions modes are enabled." implies that I should select 1 option yet there are checkboxes allowing me to select all or none of the states. I think that if the admin is prompted for a default state, there should be a required radio select widget that allows only one option.

    2 - After I save the settings form I get a WSOD with error: 

    The website encountered an unexpected error. Try again later.
InvalidArgumentException: The configuration property enable_default.watcher.1 doesn't exist. in Drupal\Core\Config\Schema\ArrayElement->get() (line 95 of core/lib/Drupal/Core/Config/Schema/ArrayElement.php).

    3 - On the user account edit form, the text: "Check this box to receive email notifications for comments on your content (e.g. an article authored by you). You cannot disable notifications for individual threads." is confusing to end users because in my case they don't have the option to author articles. I think that in the help text it shouldn't be assumed site users are familiar with the article content type, and a more ambiguous text is perhaps better. I.e.: "Check this box to receive email notifications for comments on content you authored. You cannot disable notifications for individual threads."

    Thanks and hope this helps.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024