Add handler description to handler options form [#610418]

It would be really really useful if the description for a field/sort/filter/etc that is shown when you select it from the list was also shown at the top of its settings form.
These descriptions often have very useful information (eg, taxonomy: all terms tells you you may get duplicates), and I often find I return to the add *thing* list just to read up on what a particular handler does.

Comment	File	Size	Author
#10	610418-10.views_.handler-help-options-form.patch	1.02 KB	joachim
#10
#2	views.handler-help-options-form.png	51.15 KB	joachim
#2	610418.views_.handler-help-options-form.patch	770 bytes	joachim
#2

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

esmerel CreditAttribution: esmerel commented 9 July 2010 at 20:57

Status:

Active

» Postponed

Comment #2

joachim CreditAttribution: joachim commented 10 July 2010 at 17:11

Title:	Add handlerr description to handler options form	» Add handler description to handler options form
Status:	Postponed	» Needs review

File	Size
610418.views_.handler-help-options-form.patch	770 bytes

views.handler-help-options-form.png	51.15 KB

Here's a one-line patch :)

views.handler-help-options-form.png

Probably needs some more work elsewhere in the UI as the title of the form + the help text both in bold feels a bit shouty.

Comment #3

joachim CreditAttribution: joachim commented 10 July 2010 at 17:12

Version:

6.x-2.x-dev

» 6.x-3.x-dev

Patch is on 3.x :)

Comment #4

dawehner

German

CreditAttribution: dawehner commented 11 July 2010 at 00:08

Shouldn't we check_plain the output here?

Comment #5

joachim CreditAttribution: joachim commented 11 July 2010 at 07:37

$handler->help is a string set in hook_views_handler(). If we don't trust our developers....

Comment #6

joachim CreditAttribution: joachim commented 11 July 2010 at 07:38

AFAIK $handler->help is a string defined in code in hook_views_handler(). If we don't trust our developers....

Comment #7

joachim CreditAttribution: joachim commented 11 July 2010 at 07:40

(d.org is doing something wacky with comments today!)

Comment #8

dawehner

German

CreditAttribution: dawehner commented 11 July 2010 at 07:59

Don't review patches at night!

Perhaps it would make sense here to make some kind of different visual appearance, for example em em

Comment #9

merlinofchaos CreditAttribution: merlinofchaos commented 15 October 2010 at 00:14

I'm not sure I want a <br /> there.

I think I'd rather see something like:

$form['form_description'] = array(
  '#type' => 'markup',
  '#weight' => -1000,
  '#prefix' => '<div class="description">',
  '#suffix' => '</div>',
  '#value' => $handler->definition['help'],
);