Add hook_help() to the module

Created on 26 September 2016, almost 8 years ago
Updated 19 June 2023, about 1 year ago

Problem/Motivation

Improves the module help by providing a Help text page per the HELP standards for Core and Contrib. :-)

Proposed resolution

Write a help text according to https://www.drupal.org/node/632280 →

User interface changes

Improves the UI

📌 Task
Status

RTBC

Version

2.0

Component

Code

Created by

🇮🇳India Shashwat Purav Mumbai

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

Comments & Activities

Not all content is available!

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

  • 🇮🇳India Nupur Badola

    Patch is working and marking it to RTBC.

  • 🇺🇸United States Greg Boggs Portland Oregon

    The energy on this review is awesome. However, the last commit for Drupal 7 was many years ago and the Drupal 10 version of this module could use a hook_help. So this patch needs a reroll for the latest release.

  • Status changed to Needs work about 1 year ago
  • 🇺🇸United States Greg Boggs Portland Oregon
  • Status changed to Needs review about 1 year ago
  • 🇮🇳India arpitk

    Here is the updated patch. Please review.

    Thanks!

  • Status changed to Needs work about 1 year ago
  • 🇵🇭Philippines clarkssquared

    Hi arpitk

    I applied your patch 8 to Add to Cal module version 8.x-2.x-dev, I confirmed that the patch implemented hook_help(), however, when I visit the help page it throws an error below.

    User warning: Invalid placeholder (!link) with string: "For screenshots and a more detailed explanation of how this module works, check out this blog post." in Drupal\Component\Render\FormattableMarkup::placeholderFormat() (line 249 of core/lib/Drupal/Component/Render/FormattableMarkup.php).
    Drupal\Component\Render\FormattableMarkup::placeholderFormat('For screenshots and a more detailed explanation of
    how this module works, check out this blog post.', Array) (Line: 195)
    Drupal\Core\StringTranslation\TranslatableMarkup->render() (Line: 15)
    Drupal\Core\StringTranslation\TranslatableMarkup->__toString() (Line: 36)
    addtocal_help('help.page.addtocal', Object)
    call_user_func_array(Object, Array) (Line: 417)
    Drupal\Core\Extension\ModuleHandler->invoke('addtocal', 'help', Array) (Line: 140)
    Drupal\help\Controller\HelpController->helpPage('addtocal')
    call_user_func_array(Array, Array) (Line: 123)
    Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() (Line: 580)
    Drupal\Core\Render\Renderer->executeInRenderContext(Object, Object) (Line: 124)
    Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->wrapControllerExecutionInRenderContext(Array, Array) (Line: 97)
    Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() (Line: 169)
    Symfony\Component\HttpKernel\HttpKernel->handleRaw(Object, 1) (Line: 81)
    Symfony\Component\HttpKernel\HttpKernel->handle(Object, 1, 1) (Line: 58)
    Drupal\Core\StackMiddleware\Session->handle(Object, 1, 1) (Line: 48)
    Drupal\Core\StackMiddleware\KernelPreHandle->handle(Object, 1, 1) (Line: 106)
    Drupal\page_cache\StackMiddleware\PageCache->pass(Object, 1, 1) (Line: 85)
    Drupal\page_cache\StackMiddleware\PageCache->handle(Object, 1, 1) (Line: 48)
    Drupal\Core\StackMiddleware\ReverseProxyMiddleware->handle(Object, 1, 1) (Line: 51)
    Drupal\Core\StackMiddleware\NegotiationMiddleware->handle(Object, 1, 1) (Line: 23)
    Stack\StackedHttpKernel->handle(Object, 1, 1) (Line: 718)
    Drupal\Core\DrupalKernel->handle(Object) (Line: 19)

    Please look at the screenshot for your reference

    Thanks

  • 🇮🇳India Raveen Kumar

    Hello Guys. Hope all are doing well.
    I have installed the module on my Drupal website has version 9.5.9 And PHP version 8.1.
    I hook_help for this module was implemented successfully after applying patch#8.
    However, @clarkssquared mentioned He gets an error after visiting the help page. I have also the same error as you can see in my attached screenshot.
    I have created an updated patch for it, which seems to be resolving the issue. I am adding my screenshots for your reference. Please have a look. And it would be great if someone can test it.
    And Thank You.

  • Status changed to Needs review about 1 year ago
  • 🇮🇳India Raveen Kumar

    Someone, Please test this patch. Thank You.

  • Status changed to RTBC about 1 year ago
  • 🇵🇭Philippines clarkssquared

    Hi Raveen Thakur

    I applied your patch #11 to my local and I confirmed that your patch fixed the error of patch #8 on the help page.

    1. Applied Patch #8 first
    2. and then applied Patch #11

    Please look at the screenshot attached for your reference.

    Thank you

  • 🇮🇳India Raveen Kumar

    @clarkssquared, Thank You for your confirmation.

Production build 0.69.0 2024