Update Help Text Standards Examples to Modify Heading Structure

This was discussed at a coding standards meeting. #3380936: Coding Standards Meeting 2023-08-01 2100 UTC → where the following points were raised.

• This is referring to hook_help which is intended to be deprecated, 🌱 Deprecate hook_help() and combine with Topics Active .
• Should the Help Topic standards be withing the Coding standard wiki pages. What is the history for having them separate? Should they be moved?

I've updated the Issue Summary. In doing so I have removed two of the requested changes because that section of documentation, the example, was deleted. See https://www.drupal.org/node/632280/revisions/view/12277977/12369190 →

I now see that there is wiki page for ' Help Topic Standards → '. I think these changes should also go there. Or is there a better way to have the same information in two places?

Setting to NW

Update the IS in preparation for announcing this one

This change is scriptable

core$ cat help.sh 
#!/bin/bash

# Path to the Drupal root directory.
DRUPAL_ROOT="/path/to/drupal"
DRUPAL_ROOT="."

# Function name pattern of hook implementations for hook_help.
HOOK_HELP_PATTERN='function .*_help'

# Find all files in the Drupal root directory.
find "$DRUPAL_ROOT" -type f -name "*.module" | while read -r file; do
    # Check if the file contains the implementation of hook_help.
    if grep -q "$HOOK_HELP_PATTERN" "$file"; then
        # Use sed to replace <h3> with <h2> in the hook_help implementation.
        sed -i "/${HOOK_HELP_PATTERN}/,/^}/{s/<h3>/<h2>/g; s/<\\/h3>/<\\/h2>/g;}" "$file"
        echo "Updated $file"
    fi
done

echo "Done replacing <h3> tags with <h2> in hook_help implementations."

This was discussed by the coding standards committee and we all agreed to do this.

I have updated the documentation per the issue summary.

We also agreed that this isn't a Coding Standards issue, so moving to the Core queue.

The followup to make the change is 📌 Change help headings for WCAG 2.0 Active

quietone → credited longwave → .

Adding credit for the discussion amongst some coding standing committee members.

The patches are woefully out of date, please open a merge request instead and let's work on this against 11.x there.

Oh I see, we are scripting the changes instead. But if we are doing that in another issue, what's this issue for - only updating docs?

Hiding the patches so they don't confuse others like they did to me.

The Needs Review Queue Bot → tested this issue.

While you are making the above changes, we recommend that you convert this patch to a merge request → . Merge requests are preferred over patches. Be sure to hide the old patch files as well. (Converting an issue to a merge request without other contributions to the issue will not receive credit.)

Yes, this is about documentation.

On reflection, the change record should be on this issue as it is the changing the Standards documentation.

I added a change record here.

Thank you, back to RTBC

@andypost, thank you!

The documentation is updated and the implementation issue is also complete. The remaining piece is to publish the CR and set this to Fixed. I double checked the docs and the CR and I don't see anything that needs to be changed. Since there has been no further feedback and even though I wrote the CR I am going to publish and set this to Fixed.

Thank you to everyone her for improving Drupal!

Automatically closed - issue fixed for 2 weeks with no activity.