Problem/Motivation

The help text of the Field Layout 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.

Proposed resolution

Editing the text according to the standard.

Remaining tasks

  • Edit the Uses descriptions

User interface changes

This is a UI text change.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

ifrik created an issue. See original summary.

ifrik’s picture

Issue summary: View changes
DuaelFr’s picture

Issue tags: -DevDays Seville +DevDaysSeville

Fixing event tag :p

dhruveshdtripathi’s picture

Status: Active » Needs review
FileSize
1.15 KB

Made some changes according to Help text standards.

Status: Needs review » Needs work

The last submitted patch, 4: edit_hook_help_text_for-2861845-4.patch, failed testing.

dhruveshdtripathi’s picture

Status: Needs work » Needs review
FileSize
1.15 KB

Sorry about the last patch. Missed semi colon.

Aanal.addweb’s picture

Status: Needs review » Reviewed & tested by the community
FileSize
18.16 KB
18.53 KB

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

ifrik’s picture

Status: Reviewed & tested by the community » Needs work

Sorry, but the proposed text does not follow the help text standards, and it does not describe how this module can be used.

prash_98’s picture

Status: Needs work » Needs review
FileSize
1.54 KB

Have made the changes as suggested. Please review .

ifrik’s picture

Status: Needs review » Needs work
prash_98’s picture

Is there only an interdiff needed or any other issues?

prash_98’s picture

Status: Needs work » Needs review
FileSize
1.8 KB

Have attached the interdiff file for the above patch.

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.

prash_98’s picture

Any updates with this issue?

tim.plunkett’s picture

Status: Needs review » Needs work
+++ b/core/modules/field_layout/field_layout.module
@@ -23,12 +23,13 @@
-      $output .= '<p>' . t('For more information, see the <a href=":field-layout-documentation">online documentation for the Field Layout module</a>.', [':field-layout-documentation' => 'https://www.drupal.org/documentation/modules/field_layout']) . '</p>';
...
+      $output .= '<p>' . t('For more information, see the <a href=":field-layout-documentation">online documentation for the Field Layout module</a>.', [':field-layout-documentation' => 'https://www.drupal.org/project/fieldlayout']) . '</p>';

This is an incorrect change, this core module has nothing to do with https://www.drupal.org/project/fieldlayout

shashikant_chauhan’s picture

Status: Needs work » Needs review
FileSize
1.27 KB
1.88 KB

Adding updated patch based on previous comments and few minor corrections.

tim.plunkett’s picture

+++ b/core/modules/field_layout/field_layout.module
@@ -26,6 +26,10 @@ function field_layout_help($route_name, RouteMatchInterface $route_match) {
+      $output .= '<p>' . t('Field layout defines 9 default regions (top, float-left, float-right, body, bottom, etc.) into which node fields can be placed') . '</p>';
+      $output .= '<p>' . t('Layouts can also be changed dynamically in your themes node_preprocess hook to allow layouts to react to the node contents.') . '</p>';

Neither of these statements are true either :(

I'm very confused as to where this information is coming from?

ifrik’s picture

Status: Needs review » Needs work

I'm getting a bit lost on how to respond to this (and similar issues for hook_help texts).

We now got several patches, that describe things that the module doesn't do, and that don't follow the structure for a help text (as documented on https://www.drupal.org/help-text-standards)
It also looks like patches are just adding the same wording that other people have already added, or making new patches that are not based on the last patch but some previous one. Comments with the patches might say that the previous comments are taken into account, but looking at the interdiff's that doesn't seem to be the case.

My very practical proposal is therefore is to take this issue up during the mentored sprint at DrupalCon: starting fresh and outline what the module does in this issue first. And only when that is done, we should make a new patch.

michaellenahan’s picture

Issue tags: -DevDaysSeville +Vienna2017, +Novice
rakesh_verma’s picture

I'm looking at this one at DrupalCon Vienna under a mentored sprint.

rakesh_verma’s picture

Status: Needs work » Postponed

I had a word with @tim.plunkett at DC Vienna and we've decided to postpone working on it as of now as it's still in experimental stage and we're not really sure about the best practical Uses of Field Layout module yet.

Henceforth, we can't put the accurate "Uses" text in help section as of now.

rakesh_verma’s picture

While we're on the topic, I'd also like to mention that the module "fieldlayout" is not same as the core "field_layout" module and probably this is the major reason of all the confusion and wrong patches.

"fieldlayout" is not the core module and both the modules work differently. Please take care of the same in future patches. :)

tim.plunkett’s picture

Assigned: Unassigned » tim.plunkett
Issue tags: -Novice +Blocks-Layouts

Tagging for our future work, and assigning to myself.

Sorry for the confusion everyone! And thanks @rakesh_verma and @ifrik.

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.

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.

quietone’s picture

Component: documentation » field_layout.module
Issue tags: -Documentation, -user interface text

This was an issue during an documentation triage session. Field Layout is to be removed from core so I am moving this to that component. When the module is moved this can then go with it to contrib.

#3007167: [META] Enable layout builder for form displays, and deprecate field_layout

tim.plunkett’s picture

Assigned: tim.plunkett » Unassigned

Thanks @quietone

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.