Edit hook_help text for Settings Tray module

Hi ifrik,

I have updated the documentation. Please review. Find attached patch.

Thanks
Sourdrup

The previous patch file is enormous, including all sorts of seemingly unrelated things.

I've attached the parts of the patch that I think are relevant to this ticket, although I'm not 100% sure that I've got them all.

@sourdrup - was there anything else that you think needed to be captured here? There's more surrounding this text update, although doesn't fall under the documentation realm.

Thanks.

Added two more uses for the module in help text as suggested in #8, Please review the patch and give me suggestions if it is wrong.

Patch Applied. Screenshots attached. PFA

Modified the patch as per the comment #12, Please review.

The patch applied successfully. The help page looks like this now. @ifrik If the content is OK, then RTBC.

1. +++ b/core/modules/settings_tray/settings_tray.module
   @@ -21,15 +21,16 @@ function settings_tray_help($route_name, RouteMatchInterface $route_match) {
   +      $output .= '<p>' . t('The Settings Tray module provides a sidebar to configure blocks directly without leaving the page. For more information, see the <a href=":online-documentation">online documentation for the Settings Tray module</a>.', [':online-documentation' => 'https://www.drupal.org/documentation/modules/settings_tray']) . '</p>';
   

   I don't think we should say sidebar here, as there's work done to make this show on the top of the page for workflow.

2. +++ b/core/modules/settings_tray/settings_tray.module
   @@ -21,15 +21,16 @@ function settings_tray_help($route_name, RouteMatchInterface $route_match) {
   +      $output .= '<dd>' . t('When you click the <em>Quick edit</em> link in the contextual links of a block, then a tray opens in the sidebar. Here you can directly edit and save the main block configuration options. See the <a href=":links_help">Contextual links module help page</a> on how to use contextual links.', [':links_help' => Url::fromRoute('help.page', ['name' => 'contextual'])->toString()]) . '</dd>';
   

   Same remark about sidebar.

3. +++ b/core/modules/settings_tray/settings_tray.module
   @@ -21,15 +21,16 @@ function settings_tray_help($route_name, RouteMatchInterface $route_match) {
   +      $output .= '<dd>' . t('You can access more configuration options by clicking the <em>Advanced block ¶
   +options</em> link in the tray. This loads the default <em>Configure block</em> page. Depending on the block, other configuration options can be accessed by additional edit links in the tray, for example to configure an individual menu link in a menu block. You can also access the configuration page dicrectly by clicking the <em>Configure Block</em> link in the contextual links.') . '</dd>';
   

   The enter should be removed here, typo in directly.

Made changes suggested comment #20. Please review and let me know if those changes are replaced with correct words or not.

Thanks!

@dhruveshdtripathi - Can you provide interdiff so that we can check what exactly change from #18 to #21

There seem to be some reversions here that don't make sense. @ifrik's text has been changed in places so that it doesn't make sense grammatically.

IMO this needs to be redone, starting from #18, without changing too much text, while paying attention to the comments in #20, as some of them have been missed.

+++ b/core/modules/settings_tray/settings_tray.module
@@ -18,15 +19,15 @@ function settings_tray_help($route_name, RouteMatchInterface $route_match) {
+      $output .= '<p>'  . t('The Settings Tray module provides an administrative region (tray) to configure blocks directly without leaving the page. For more information, see the <a href=":online-documentation">online documentation for the Settings Tray module</a>.', [':online-documentation' => 'https://www.drupal.org/documentation/modules/settings_tray']) . '</p>';

Got an extra space in here after your initial paragraph tag. (sorry)

+++ b/core/modules/settings_tray/settings_tray.module
@@ -18,15 +19,15 @@ function settings_tray_help($route_name, RouteMatchInterface $route_match) {
+      $output .= '<dd>' . t('You can enter the editing mode for a whole page by clicking the <em>Edit</em> link in the toolbar. The editing mode marks the outline of each blocks and displays the contextual link icons. You can leave it again by clicking on <em>Editing</em>.') . '</dd>';

"The editing mode marks the outline of each blocks" > "The editing mode marks the outline of each block"

Reads nicely like this, just a couple of very minor things.

Thanks.

Nice work @ifrik, all looks good to me.

Patch applies fine, reads well and makes sense.

Happy to RTBC.

Hi all thanks for the work on this so.
Sorry as the module maintainer I think I needs more info.

At first the issue seemed to be just about standards but now it is actually changing the help text and description.

In #2897272: Fix module description, hook_help(), and document module scope in *.api.php file we spent a fair amount of time updating the help text to stabilize the module so I think we would need reason to change from that.

I probably should have consolidated these 2 issue together before. I will review this issue and comment again.

Sounds like the maintainer needs more info.