Problem/Motivation

Modules are supposed to provide a Help text page per the HELP standards for Core and Contrib.

The existing HELP page is kind of weird when compared to ALL other modules (core or contrib) I've come across, because much of what this module does (providing the Token UI) actually IS the HELP page.

Proposed resolution

Write a help text according to the Drupal HELP standard defined at --> https://www.drupal.org/node/632280

Remaining tasks

User interface changes

Improves the UI

Adding in some additional general text to help orient the user will go a long way towards eliminating that 1st timer 'wtf' experience, especially for this module :-)

CommentFileSizeAuthor
#10 interdiff-2728067-2-9.txt3.24 KBdbt102
#9 2728067-Add_Token_HELP-9.patch2.3 KBhussainweb
#2 2728067-Add_Token_HELP-2.patch1.99 KBdbt102

Comments

dbt102 created an issue. See original summary.

dbt102’s picture

dbt102 commented
StatusFileSize
new 2728067-Add_Token_HELP-2.patch1.99 KB
dbt102’s picture

dbt102 commented
Assigned: dbt102 » Unassigned
Status: Active » Needs review

Status: Needs review » Needs work

The last submitted patch, 2: 2728067-Add_Token_HELP-2.patch, failed testing.

dbt102’s picture

dbt102 commented
Issue summary: View changes
Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 2: 2728067-Add_Token_HELP-2.patch, failed testing.

dbt102’s picture

dbt102 commented

hmmm... not sure why this is failing . Double checked the patch on my local

dave$ git apply -v 2728067-Add_Token_HELP-2.patch 
Checking patch token.module...
Applied patch token.module cleanly.

works OK there.

I wonder if it has something to do with 'non-standard' use of hook_help

dbt102’s picture

dbt102 commented
Status: Needs work » Needs review
hussainweb’s picture

hussainweb
Primary language English
commented
StatusFileSize
new 2728067-Add_Token_HELP-9.patch2.3 KB

This should fix the failures. I have also made some more tweaks to the help text. I think it could be simpler but it is good enough for a review now.

dbt102’s picture

dbt102 commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new interdiff-2728067-2-9.txt3.24 KB

I reviewed the #9 patch. It applies cleanly, and I think the changes made to tweak those provided by #2 add value to the effort, so thanks for that @hussainweb.

I've attached an interdiff of the old/new patch for easy refernce and marking this issue RTBC.

berdir’s picture

berdir
Primary language German
Location Switzerland
commented
Title: Add_Token_HELP » Update help text

uppercase = shouting. Lets not do that ;)

Not sure I see the point in linking to the project page when you have the module already installed, but eveything else looks fine.

  • Berdir committed 9700696 on 8.x-1.x authored by hussainweb 
    Issue #2728067 by dbt102, hussainweb: Update help text
berdir’s picture

berdir
Primary language German
Location Switzerland
commented
Status: Reviewed & tested by the community » Fixed
dbt102’s picture

dbt102 commented

Thanks for the review/comments @Berdir.

Any chance you can give me commit credit as well?

I spent a lot of time on this one and provided the initial patches, interdiff, etc.

I'm kind of a man on the mission, and a project credit for Token is one I would especially prize :-)

berdir’s picture

berdir
Primary language German
Location Switzerland
commented

Only one person can get be the commit author, I realized too late that it was set to hussainweb.

However, both of you got issue credit, which is the official way of tracking this now anyway.

dbt102’s picture

dbt102 commented

NP, just wanted to make sure I at least asked, Thanks for the reply

Status: Fixed » Closed (fixed)

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