Improve user experience of the taxonomy/term/X/edit page

Added this issue to the summary at #1347448: [META] Taxonomy admin usability Improvements.

specify which field

Why not make it two column while we are at it just like node?

#3 sounds interesting, so broadening the scope to include that as a potential solution.

Ok so we can add vertical tabs in Drupal\taxonomy\TermForm::form and write seven_form_taxonomy_term_form_alter to replicate seven_form_node_form_alter

I've just created a patch for the same issue but for D7 a few weeks ago:
https://www.drupal.org/node/2650700

Here is a patch for D8. #3 makes perfect sense, but it's something that needs to be done in a classy theme as seven utilizes its templates, and term edit page has a different template than node edit page there. I think we can address that in a separate patch. For now, I've just updated Taxonomy term edit form to have vertical tabs and also updated path module to have its own vertical tab just like it has on a node edit form.

Looking forward for your review and hopefully merge. Thanks.

Noticed a small issue in the previous patch. Corrected and uploaded a new version.

Fixed the typo. New patch attached.

I rerolled the patch, to work against 8.3.x

I have tested and reviewed patch provided at #14. It's fine. Nice work!

I would have expected an rtbc to have screenshots and some usability review.

Ok, as requested from @alexpott, here are some screenshots

Before:

After:

Hmm, this is not the busiest of screens, there are only 2 additional configuration options besides title and description. So I'm not sure it's a very worthwhile change, especially if we keep the current ordering. I would think the URL alias field is used more often than the Relations settings. With URL alias shown before Relationships, the URL alias would become the default open vertical tab.

In general I think it's still worthwhile to move these things over to vertical tabs, but then we should also be aware of what gets show in that first tab that is open by default.

So needs work for that: switch the order of URL alias and Relationships so that URL alias comes first.

(good to see that the actual URL alias gets added to the vertical tab summary, nice!)

right…

@yoroy: Thanks for the review

Here is a new patch, where the path settings are first.

I have tested new changes and order is correct now.

Thanks! Tested again on simplytest and everything seems good.

Do we have examples of contrib modules that add things to this screen?

Also: #2847035: Remove useless descriptions on taxonomy term create/edit screen :-)

@yoroy any comments on #3?

Sitemap XML and Metatag are 2 examples of modules that add additional vertical tabs to the term edit page.

Here you can see how it looks with metatag and simple_sitemap enabled

Thanks for the screenshots! In the future, note that it's helpful to make your browser window small when taking screenshots and crop to only the relevant portion. This makes it easier to understand what is being changed and compare. See @yoroy's screenshots in #18 for a great example of a helpful screenshot. Also, it's always best to embed before and after screenshots in the issue summary in the UI changes section. Tagging for that issue summary update.

In #13, the URL path settings is not at the top again. I think we need better weights than the ones in the patch, or to actually mark it as the default vertical tab if that is possible (surely it is?), so that URL path settings really is at the top in most cases.

Ok, i adjusted the the weights of URL path and relation to be really at the top. So if a contrib module will not define any weight, it will appear after the core tabs.
Additionally i made URL path to the default tab. So if a module defines a really low weight (lower -1), it well be at the top, but the URL path will still be open by default.

I also added screenshots to the issue summary.

This needed a reroll because of #2776975: March 3, 2017: Convert core to array syntax coding standards for Drupal 8.3.x RC phase

I provide a normal diff, because it was not possible to create an interdiff.

Interdiff is a bit broken, but it's not relevant.

I have tested patch provided in #29. It looks good, it can be applied, order is correct, URL path is selected by default. When modules provide additional vertical tabs they are appended to end. So everything looks good. Screenshot provided.

The patch works fine when tested. Back to RTBC. Maybe CI error in #31

#3 was addressed by #18 so removing the Needs design-tag.

1. +++ b/core/modules/path/path.module
   @@ -37,27 +37,47 @@ function path_help($route_name, RouteMatchInterface $route_match) {
   +    '#weight' => -2,
   

   Changing the weight causes some unexpected changes, such as that the order in other entity forms might change. This happens at least in the node form.

2. +++ b/core/modules/path/path.module
   @@ -37,27 +37,47 @@ function path_help($route_name, RouteMatchInterface $route_match) {
   +function path_form_node_form_alter(&$form, FormStateInterface $form_state) {
   ...
   +function path_form_taxonomy_term_form_alter(&$form, FormStateInterface $form_state) {
   

   This might be easier to read if the form targeting would be done inside one form alter using the form_id.

3. +++ b/core/modules/path/path.module
   @@ -37,27 +37,47 @@ function path_help($route_name, RouteMatchInterface $route_match) {
   + * Implements hook_form_BASE_FORM_ID_alter() for taxonomy_term_form().
   

   This comment is referring to a non-existing function

I moved the weight, as well as the default_tab, into the alter hooks. This enables the possibility to change those settings in different situations and gets us back the previous node form behaviour.
Since path_entity_base_field_info() handles now media as well, I added the corresponding media form alter hook, to have the same behaviour in media.
I like the approach better to have seperate form alter implamentations, espacially now with the different configurations, so I kept that for now.

This also fixes https://www.drupal.org/node/2939583. We discussed these two issues @globalsprintweekend.

The patch is also reviewed over here: https://www.drupal.org/project/drupal/issues/2939583 :)

As @k4v posted, we reviewed the patch at https://www.drupal.org/project/drupal/issues/2939583 and I have now also reviewed taxonomy/term/x/edit and it looks good.

+++ b/core/modules/path/path.module
@@ -38,27 +38,57 @@ function path_help($route_name, RouteMatchInterface $route_match) {
+/**
+ * Implements hook_form_BASE_FORM_ID_alter() for \Drupal\media\MediaForm.
+ */
+function path_form_media_form_alter(&$form, FormStateInterface $form_state) {
+  path_entity_form($form, $form_state);
+  $form['advanced']['#default_tab'] = 'edit-path-settings';
+  $form['path_settings']['#weight'] = -2;
+}

this is out of scope, the issue here is about terms, not media?

If we intend to combine the issues, can we rename this one and give it an appropriate scope.

Note I'd prefer this one to just touch taxonomy, and then the other one to be postponed on this.

That would be within our scope guidelines

Also - we need tests here

Thanks folks!

Removed the media stuff and added a test to verify, that the URL alias input is the first tab in the vertical tabs menu.

The patch from #45 looks good.

+++ b/core/modules/path/path.module
@@ -38,27 +38,48 @@ function path_help($route_name, RouteMatchInterface $route_match) {
+function path_entity_form(array &$form, FormStateInterface $form_state) {

Could we call this path_entity_form_helper() or something? Not massively keen on adding a new non-hook procedural function to a module - we could probably just duplicate the code even?

If we want to refrain from introducing a non-hook, I guess renaming would not help much. So I duplicated the code in this patch.

Maybe this is also a duplicate of
https://www.drupal.org/project/drupal/issues/2916809?

Patch #48 can't be applied on 9.2.x.Needs reroll

Checking patch core/modules/path/path.module...
error: while searching for:
  $form['path']['#group'] = 'path_settings';
}

/**
 * Implements hook_entity_base_field_info().
 */

error: patch failed: core/modules/path/path.module:59
error: core/modules/path/path.module: patch does not apply
Checking patch core/modules/path/tests/src/Functional/PathTaxonomyTermFormTest.php...
Checking patch core/modules/taxonomy/src/TermForm.php...
error: while searching for:
    $form_state->set(['taxonomy', 'parent'], $parent);
    $form_state->set(['taxonomy', 'vocabulary'], $vocabulary);

    $form['relations'] = [
      '#type' => 'details',
      '#title' => $this->t('Relations'),
      '#open' => $vocabulary->getHierarchy() == VocabularyInterface::HIERARCHY_MULTIPLE,
      '#weight' => 10,
    ];

    // \Drupal\taxonomy\TermStorageInterface::loadTree() and

error: patch failed: core/modules/taxonomy/src/TermForm.php:25
error: core/modules/taxonomy/src/TermForm.php: patch does not apply

Rerolled patch #48 for 9.2.x .Please check

The reroll in #56 didn't include the test added in #45

Addressing the deprecations

Applied #56 patch in durpal-9.3.x-dev applied successfully
Thanks for the patch
for ref sharing screenshot ...

Still relevant for the usability and consistency of Drupal 9+!

I simplified the patch a bit. The other patch worked, but it was throwing the admins off having a "URL path settings" and "URL alias" tab. Not sure if there's a need for the "URL path settings" tab that I'm missing?

patch in #64 applies cleanly working fine on local 9.5

If #64 is used it will need test cases.

Reviewing #58 which still applies cleanly to D10.1

Manually testing I can confirm I am seeing the tabs

But believe the testing should be expanded some. Currently it tests for the path-settings tab. Should also check for
1. The Relations tab -> that the weight and parent fields appear inside.
2. When URL alias field is hidden from form display I would want to see that no tab appears

Thanks!