Problem/Motivation

The hook_help text does not mention the "Custom block library" tab in the About section, and only mentions it in the second use description. Users adding a custom block type, only have a link to the page, and it would be better if they know where to find it without having to click on that link.

Proposed resolution

Adding a sentence to the About section to say that the module provides a Custom block library that lists both the custom block types and the costum blocks.

Remaining tasks

User interface changes

This is a user interface change.

API changes

CommentFileSizeAuthor
#7 update_hook_help_text-2469937-7.patch4.1 KBPieterJanPut
#2 2469937-hook-help-text-2.patch4.09 KBifrik
#1 2469937-hook-help-text-1.patch4.09 KBifrik
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
Version: 8.0.0-beta9 » 8.0.x-dev
Issue summary: View changes
Status: Active » Needs review
FileSize
2469937-hook-help-text-1.patch4.09 KB

Added a link to the Custom block library to the About section, and mentioned it in the first use.

ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
FileSize
2469937-hook-help-text-2.patch4.09 KB

Fixed a single typo.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Reviewed & tested by the community

Thanks! Looks good to me, and matches the UI. No typos. All great!

I did notice and file a new UI issue:
#2470155: Custom block types page has bad page title

ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
Issue tags: +drupaldevdays
anavarre’s picture

anavarre
Primary language French
Location 🇪🇺
CreditAttribution: anavarre at Acquia commented 
+++ b/core/modules/block_content/block_content.module
@@ -18,11 +18,11 @@ function block_content_help($route_name, RouteMatchInterface $route_match) {
+	$output .= '<p>' . t('The Custom Block module allows you to create custom <em>block types</em> and <em>content-containing blocks</em>, and provides a <a href="!block-library">Custom block library</a> listing all of them. Custom block types have fields; see the <a href="!field-help">Field module help</a> for more information. Once created, custom blocks can be placed in regions just like blocks provided by other modules; see the <a href="!blocks">Block module help page</a> for details. For more information, see <a href="!online-help">the online documentation for the Custom Block module</a>.', array('!block-library' => \Drupal::url('entity.block_content.collection'), '!block-content' => \Drupal::url('entity.block_content.collection'), '!field-help' => \Drupal::url('help.page', array('name' => 'field')), '!blocks' => \Drupal::url('help.page', array('name' => 'block')), '!online-help' => 'https://drupal.org/documentation/modules/block_content')) . '</p>';

Isn't there a tab used here instead of 2 spaces?

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott commented
Status: Reviewed & tested by the community » Needs work

@anavarre you're right.

PieterJanPut’s picture

PieterJanPut CreditAttribution: PieterJanPut at iO commented
Status: Needs work » Needs review
FileSize
update_hook_help_text-2469937-7.patch4.1 KB
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Reviewed & tested by the community

No tabs this time. Looks good. Thanks!

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick at Acquia commented
Status: Reviewed & tested by the community » Fixed

Yay, docs! :D

Committed and pushed to 8.0.x. Thanks!

  • webchick committed bfbd6c4 on 8.0.x 
    Issue #2469937 by ifrik, PieterJanPut, anavarre: Update hook_help text...

Status: Fixed » Closed (fixed)

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