Problem/Motivation

The Help text page is present but is a little off the Help text standard (for core and contrib).

Proposed resolution

Make a few edits to the help text provided to bring it closer to the standard.

Remaining tasks

User interface changes

API changes

CommentFileSizeAuthor
#14 tweak_pathauto_help-2725555-14.4.patch3.87 KBBambell
#11 interdiff-2725555-8-11.txt3.23 KBrajeshwari10
#11 2725555-11.patch16.7 KBrajeshwari10
#8 2725555-Tweak_Pathauto_HELP-8.patch5.34 KBdbt102
#3 2725555-Tweak_Pathauto_HELP-3.patch6.05 KBdbt102

Comments

dbt102 created an issue. See original summary.

dbt102’s picture

dbt102 commented
Title: A tweak to Pathauto HELP » Tweak Pathauto HELP
dbt102’s picture

dbt102 commented
StatusFileSize
new 2725555-Tweak_Pathauto_HELP-3.patch6.05 KB
dbt102’s picture

dbt102 commented
Assigned: dbt102 » Unassigned
Status: Active » Needs review
alexdmccabe’s picture

alexdmccabe
he/him
Primary language English
Location Orlando, FL, US / Seminole lands
commented

Why were the help messages for the other routes removed?

dbt102’s picture

dbt102 commented

hmmm... good question ... that wasn't my intent ... I took them out temporarily because they all didn't seem to be working correctly. I mean't to figure out why and put them back in, but I forgot about them.

I've been working a lot of HELP text for several projects and this is the first one I remember where "3. Help text on administration pages" of the Help text standard (for core and contrib was actually implemented in hook_help .

I need to review function hook_help and see how to put the help messages back in for the other routes.

dbt102’s picture

dbt102 commented
Assigned: Unassigned » dbt102
Status: Needs review » Needs work
dbt102’s picture

dbt102 commented
Status: Needs work » Needs review
StatusFileSize
new 2725555-Tweak_Pathauto_HELP-8.patch5.34 KB

I put the help messages back in for this #8 patch. I removved them to begin with because I was working with D8.2.x-dev and they did not seem to do anything. When I looked of the admin pages where the messages should be, there were no messages. So based on @alexdmccabe comment in #5 I looked closer. This time working with drupal 8.1.x-dev, the admin page help showed up ok.

So, I figure if this new patch #8 tests OK, then there is another issue with Drupal Core 8.2.x-dev that needs investigated, because the behavior noted applies to all core and contrib modules, ie admin page help does not work properly.

berdir’s picture

berdir
Primary language German
Location Switzerland
commented
Title: Tweak Pathauto HELP » Tweak Pathauto help
Status: Needs review » Needs work

Thanks for working on this.

+++ b/pathauto.module
@@ -49,16 +50,19 @@ function pathauto_help($route_name, RouteMatchInterface $route_match) {
+      $output .= '<dd>' . t('The <strong>maximum alias length</strong> and <strong>maximum component length</strong> values default to 100 and have a limit of @max from Pathauto. This length is limited by the length of the "alias" column of the url_alias database table. The default database schema for this column is @max. If you set a length that is equal to that of the one set in the "alias" column it will cause problems in situations where the system needs to append additional words to the aliased URL. You should enter a value that is the length of the "alias" column minus the length of any strings that might get added to the end of the URL. The length of strings that might get added to the end of your URLs depends on which modules you have enabled and on your Pathauto settings. The recommended and default value is 100.') . '</dd>';

The part about the limit by database is no longer true. The limit is 255. @max is also actually broken and shows up on the page.

dbt102’s picture

dbt102 commented

thanks for the review/feedback @Berdir.

imo ... the whole paragragh you refernece in comment #9 seems kind of out of place for the module's Drupal Help page.

It's a very detailed, specific kind of instruction that I would expect to find in something like an installation guide for developers. This module's help overview page points to https://www.drupal.org/documentation/modules/pathauto , so as a -dev , I'd expect to go there to find that info.

So, would it be ok with you I I just drop that paragraph?

rajeshwari10’s picture

rajeshwari10 commented
Status: Needs work » Needs review
StatusFileSize
new 2725555-11.patch16.7 KB
new interdiff-2725555-8-11.txt3.23 KB

I ave replaced @max with 255 as said in #9.

Please review.

Thanks!!

berdir’s picture

berdir
Primary language German
Location Switzerland
commented
Status: Needs review » Needs work

Thanks, but the paragraph is stil lconfusing and too detailed, agreed with #10 on that. Fine with removing or shortening it. We could also check the descriptions of the relevant form fields and ensure we have enough explanation of it there.

Bambell’s picture

Bambell commented

@dbt102, this issue is currently assigned to you. Would you like to continue working on this issue or could someone else pick it up? Thanks.

Bambell’s picture

Bambell commented
Status: Needs work » Needs review
StatusFileSize
new tweak_pathauto_help-2725555-14.4.patch3.87 KB

Patch wouldn't apply. Am I dyslexic or was it already committed? The current help page looks like what patch #8 was intended to produce. I shortened the paragraph in #9 to something just sufficient to warn the user that an incorrect value can be a problem and to indicate to developers what exactly is needed. I also quickly reviewed all forms fields and the help page looks sufficient to me. I added "An alias is generated for the first pattern that applies." to the "Creating Pathauto Patterns" section.

@max is also actually broken and shows up on the page.

String replacement was missing..

Thanks,

Interdiff of #11 is fine, but the patch has 11 KB of non relevant changes.

berdir’s picture

berdir
Primary language German
Location Switzerland
commented
Status: Needs review » Fixed

Yes, I accidently committed the previous patch already as part of another issue, sorry about that.

Committed this now.

  • Berdir committed c0e1978 on 8.x-1.x authored by dbt102 
    Issue #2725555 by dbt102, rajeshwari10, Bambell: Tweak Pathauto help
dbt102’s picture

dbt102 commented

Thanks for stepping up to help with this @bambell and @rajeshwari10 . I got distracted on some other issues. Glad to see this got worked out. Thanks for your efforts too @berdir.

Status: Fixed » Closed (fixed)

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