Problem/Motivation

The help text of the Layout Discovery module does not quite follow the Help text standards as described in https://www.drupal.org/help-text-standards. It misses a section to describe the Uses.

The use of Drupal::url() has been deprecated and needs to be replaced as well.
See #2868989: Replace calls of the deprecated Drupal::url() from update.module for details.

Proposed resolution

Editing the text according to the standard.

Remaining tasks

  • Edit the Uses descriptions
  • Replace Drupal::url()

User interface changes

This is a UI text change.

CommentFileSizeAuthor
#16 afterPatch.PNG52.11 KBAanal.addweb
#14 edit_hook_help_text_for-2861846-14.patch2.66 KBdhruveshdtripathi
#13 Help #10.2.png159.09 KBAanal.addweb
#12 layout_discovery_help.png132.61 KBdhruveshdtripathi
#11 interdiff.txt1.48 KBgaurav.kapoor
#11 edit_hook_help_text_for-2861846-11.patch2.66 KBgaurav.kapoor
#8 edit_hook_help_text_for-2861846-8.patch2.66 KBjarodriguez
#8 interdiff-2861846-4-8.txt3.12 KBjarodriguez
#5 Before.png52.11 KBAanal.addweb
#5 After.png14.49 KBAanal.addweb
#4 edit_hook_help_text_for-2861846-4.patch2.66 KBjarodriguez
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

ifrik created an issue. See original summary.

DuaelFr’s picture

DuaelFr
he/him
Primary language French
Location Montpellier, France
CreditAttribution: DuaelFr as a volunteer and at Happyculture commented
Issue tags: -DevDays Seville +DevDaysSeville

Fixing event tag :)

jarodriguez’s picture

jarodriguez CreditAttribution: jarodriguez as a volunteer and at La Drupalera by Emergya commented
Assigned: Unassigned » jarodriguez
jarodriguez’s picture

jarodriguez CreditAttribution: jarodriguez as a volunteer and at La Drupalera by Emergya commented
Status: Active » Needs review
FileSize
edit_hook_help_text_for-2861846-4.patch2.66 KB

Added uses cases in hook_help

Aanal.addweb’s picture

Aanal.addweb CreditAttribution: Aanal.addweb at AddWeb Solution Pvt. Ltd. commented
FileSize
After.png14.49 KB
Before.png52.11 KB

@jarodriguez, Thanks for the updated patch, it works well. I checked it via simplytest.me & also attached the images of results.

Aanal.addweb’s picture

Aanal.addweb CreditAttribution: Aanal.addweb at AddWeb Solution Pvt. Ltd. commented
Status: Needs review » Reviewed & tested by the community
ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
Status: Reviewed & tested by the community » Needs work

Thanks a lot!
Just two small changes:

We should mention in the About section that this module does not provide a UI - so that people don't look for it in vain.

An some nitpicking: Could you change "It's" to "It is", and change the "!" in Using an alternative class to a simply "."?

Since this is an experimental module, we should then check with the developers of the Layout module whether there is anything else that's not obvious, but should be covered here.

jarodriguez’s picture

jarodriguez CreditAttribution: jarodriguez as a volunteer and at La Drupalera by Emergya commented
FileSize
interdiff-2861846-4-8.txt3.12 KB
edit_hook_help_text_for-2861846-8.patch2.66 KB

Fix comments on #7

jarodriguez’s picture

jarodriguez CreditAttribution: jarodriguez as a volunteer and at La Drupalera by Emergya commented
Status: Needs work » Needs review
Aanal.addweb’s picture

Aanal.addweb CreditAttribution: Aanal.addweb at AddWeb Solution Pvt. Ltd. commented
Status: Needs review » Needs work

@jarodriguez, Thanks for the updated patch, but i found some issues from it.

1) there is one typo in "Regiastering dynamic layouts using derivatives"

2) Make line after period should be consistent for all sub titles of Uses section
i.e. "Using an alternate 'class'."

gaurav.kapoor’s picture

gaurav.kapoor CreditAttribution: gaurav.kapoor at OpenSense Labs commented
Status: Needs work » Needs review
FileSize
edit_hook_help_text_for-2861846-11.patch2.66 KB
interdiff.txt1.48 KB

10.1 Fixed. @dhwani.addweb can use explain your 2nd point again.Thanks!. Should " \'theme\'' " this kind of words also be replaced with 'theme' or "theme".

dhruveshdtripathi’s picture

dhruveshdtripathi CreditAttribution: dhruveshdtripathi at DevsAdda for OpenSense Labs commented
Status: Needs review » Reviewed & tested by the community
FileSize
layout_discovery_help.png132.61 KB

Didn't understand suggestion #10.2

10.1 is fixed. Changing status to RTBC till the point #10.2 gets clear.

Aanal.addweb’s picture

Aanal.addweb CreditAttribution: Aanal.addweb at AddWeb Solution Pvt. Ltd. commented
Status: Reviewed & tested by the community » Needs work
FileSize
Help #10.2.png159.09 KB

@dhruveshdtripathi & @gaurav.kapoor, thanks for providing your reviews & patch, i attached the file please kindly review it i hope it gives some idea for #10.2.
Let me know if i'm wrong.

dhruveshdtripathi’s picture

dhruveshdtripathi CreditAttribution: dhruveshdtripathi at DevsAdda for OpenSense Labs commented
Assigned: jarodriguez » Unassigned
Status: Needs work » Needs review
FileSize
edit_hook_help_text_for-2861846-14.patch2.66 KB

Removed the peroid. Thank you @dhwani.addweb for noticing this.

Status: Needs review » Needs work

The last submitted patch, 14: edit_hook_help_text_for-2861846-14.patch, failed testing.

Aanal.addweb’s picture

Aanal.addweb CreditAttribution: Aanal.addweb at AddWeb Solution Pvt. Ltd. commented
Status: Needs work » Reviewed & tested by the community
FileSize
afterPatch.PNG52.11 KB

@dhruveshdtripathi, Thank you for your patch, it works well for me. I tested it by simplytest.me & PFA.

ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
Component: documentation » layout.module
Status: Reviewed & tested by the community » Needs review

Can somebody involved with the development of the Layout module please check whether this documentation covers all functionality?

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
CreditAttribution: tim.plunkett at Acquia commented 
  1. +++ b/core/modules/layout_discovery/layout_discovery.module
@@ -14,6 +14,18 @@ function layout_discovery_help($route_name) {
+      $output .= '<dd>' . t('It is possible to tell layout_plugin to use a particular theme hook (which you\'ve manually registered using hook_theme()). This can be useful if, for example, you want to use the same template to render multiple layouts.') . '</dd>';

    layout_plugin appears several times here but that is not a term used by core. 

  2. +++ b/core/modules/layout_discovery/layout_discovery.module
@@ -14,6 +14,18 @@ function layout_discovery_help($route_name) {
+      $output .= '<dt>' . t('Registering dynamic layouts using derivatives') . '</dt>';
+      $output .= '<dd>' . t('If you wanted to create a flexible layout builder, you\'d give the site administrator some user interface to declare a new layout, and the configuration for each layout would be saved as a config entity. Then you\'d register a layout class that used a "deriver" to dynamically register a layout plugin for each of those saved config entities.') . '</dd>';

    Please remove this, it's highly speculative and not really in scope

Furthermore, this module actually does none of these things. It's all done by the Layout API which is not in any module.
This module only exists until the API is stable and the "glue code" functionality can be moved to system.module.

ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented

Thanks Tim,

jarodriguez do you got time to continue working on this?

ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
Status: Needs review » Needs work
ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
Issue summary: View changes

The use of Drupal::url() has been deprecated and needs to be replaced as well.
See #2868989: Replace calls of the deprecated Drupal::url() from update.module for details.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
CreditAttribution: tim.plunkett at Acquia commented
Component: layout.module » layout_discovery.module

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.