Show Priority and Status level descriptions in issue tracking
JohnAlbin - July 15, 2007 - 07:58
| Project: | Drupal.org customizations |
| Component: | User interface |
| Category: | feature request |
| Priority: | normal |
| Assigned: | JohnAlbin |
| Status: | closed |
Description
In the Drupal issue queue, in particular, it seems it would be useful to have a “Help” link next to the Issue information. Specifically, modifying $form['issue_info'] = array( '#type' => 'fieldset', '#title' => t('Issue information')); to include a '#description' that links to the meaning of all the fields and the Drupal development process. For example:
Descriptions of the Priority and Status levels can be found in the Contributing to Development Handbook.
Submission guidelines could be used, but some help text right next to the pull-down menus would be much better.
To make this a more general feature request: I would like to see customizable descriptions for the Project Information and the Issue Information fieldsets.
#1
It should already be possible to do this just by implementing hook_form_alter, right? This sounds like something best left for the drupal.org module, instead of providing an elaborate UI in the project issue module to allow admins to provide descriptions of these fields.
I'm moving this over to the drupal.org module for possible implementation on drupal.org.
#2
#3
Ok. You've got two choices here.
The -above.patch adds the description as the fieldset’s description, so the code is simple, but the descriptive text comes before the actual "Priority" and "Status" pull-downs it describes.
The -below.patch puts the description just below the "Priority" and "Status" pull-downs, but the code is cruftier since it needs a
style="clear: left"in order to be positioned below the floated pull-downs.PIck your poison.
#4
Thanks for getting this started. One real problem, and a few minor cosmetic ones:
A) that only works on new issues, not on followup comments. You also need to do this if $form_id == 'comment_form', but only if it's an issue...
B) I prefer the description below, but I think it's more clear if you put the div tags for that into #prefix and #suffix for that form element, instead of just munging it all together into the #value. Given that, I'd also prefer the usual FAPI-style for indenting the array (I find that more readable).
C) I'd prefer if you just used /node/N for the URLs for those links, instead of http://drupal.org/node/N so that whenever we sync the d.o DB to other test sites, the links are relative to the same site.
Thanks,
-Derek
#5
Can do!
Now that I'm modifying 2 separate forms, I've added a $priority_status_description variable to make it easier to apply the same form element to each form.
#6
The "Contributing to Development Handbook" link brings you to http://drupal.org/node/10259 which is no longer called "Contributing to Development" nor where the pages about the issue queue now live. ;) I'm going to change that to link to http://drupal.org/node/317 and call that the "Issue queue handbook". Sound good?
#7
Like so.
#8
Committed and deployed. Yay.
#9
Woo-hoo! Looks good! :-D
#10
I just committed and deployed a change to the help text: s/levels/values. Upon further consideration, "Status levels" didn't make much sense to me. ;)
#11
Automatically closed -- issue fixed for two weeks with no activity.