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.

CommentFileSizeAuthor
#10 610418-10.views_.handler-help-options-form.patch1.02 KBjoachim
#2 views.handler-help-options-form.png51.15 KBjoachim
#2 610418.views_.handler-help-options-form.patch770 bytesjoachim

Comments

esmerel’s picture

esmerel commented
Status: Active » Postponed
joachim’s picture

joachim commented
Title: Add handlerr description to handler options form » Add handler description to handler options form
Status: Postponed » Needs review
StatusFileSize
new 610418.views_.handler-help-options-form.patch770 bytes
new views.handler-help-options-form.png51.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.

joachim’s picture

joachim commented
Version: 6.x-2.x-dev » 6.x-3.x-dev

Patch is on 3.x :)

dawehner’s picture

dawehner
Primary language German
commented

Shouldn't we check_plain the output here?

joachim’s picture

joachim commented

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

joachim’s picture

joachim commented

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

joachim’s picture

joachim commented

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

dawehner’s picture

dawehner
Primary language German
commented

Don't review patches at night!

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

merlinofchaos’s picture

merlinofchaos commented

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'],
);
joachim’s picture

joachim commented
StatusFileSize
new 610418-10.views_.handler-help-options-form.patch1.02 KB

Sure.

But some CSS is needed to pad it in now -- or some form tweaking I don't understand to get it into the title DIV.

merlinofchaos’s picture

merlinofchaos commented
Status: Needs review » Fixed

Tweaked slightly and committed to all versions.

Status: Fixed » Closed (fixed)

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