Remove UI description that says what is stored in the field

lisarex - October 25, 2009 - 22:32
Project:Drupal
Version:7.x-dev
Component:field_ui.module
Category:task
Priority:normal
Assigned:Unassigned
Status:closed
Issue tags:D7UX, ui-text, Usability
Description

The UI text on admin/structure/types/manage/listing/fields/field_subheading/field-settings is going to really overwhelm the average user so I want to tidy this up.

AttachmentSizeStatusTest resultOperations
field_settings_uiOLD.png52 KBIgnoredNoneNone

#1

lisarex - October 25, 2009 - 22:33

added tags

#2

lisarex - October 26, 2009 - 01:08
Component:field_ui.module» node.module

#3

yched - October 26, 2009 - 23:54
Component:node.module» field_ui.module

That one is actually for field_ui, Lisa ;-)

#4

yched - October 27, 2009 - 00:01

And I think this is in fact a duplicate of #563998: Field UI: no way to set the translatable property.

[edit: hmm, maybe I was too quick, it depends on exactly which UI text you want to improve. If that's the one about translatable field, then #563998: Field UI: no way to set the translatable property is the issue]

#5

lisarex - October 29, 2009 - 03:11
Title:Improve UI text on Field Settings page» Improve UI text that describes what is stored in the field
Assigned to:lisarex» Anonymous
Status:active» needs review

Thanks yched.

I updated the title. I will only tackle the text that appears at the top of the page, e.g. 'Boolean: This field stores simple on/off or yes/no options.' and my personal favorite 'Text: This field stores varchar text in the database.' ;)

This will likely need to be several patches but I'll just start with this one!

After screenshot attached, before screenshot is in the main issue.

AttachmentSizeStatusTest resultOperations
after614294.png6.49 KBIgnoredNoneNone
uitext_614294_4.patch622 bytesIdlePassed on all environments.View details | Re-test

#6

lisarex - November 3, 2009 - 23:31
Title:Improve UI text that describes what is stored in the field » Remove UI description that says what is stored in the field

OK, following some discussion in IRC, Bojhan & I think these descriptions are not useful where they currently appear, *after* someone has created a field. If someone is unclear about the type of field they are creating, they should check in Documentation, since there is no good place to describe Boolean, Float, the 3 list types, etc in this interface.

This patch removes the 'description' from Text, Long text and Long text and summary (currently visible at admin/structure/types/manage/article/fields/body/ and admin/structure/types/manage/article/fields/body/field-settings)

Note that the field label and colon are still present and serve as a reminder of what type of field it is... I think they could do w/ a bit more styling though (position it evenly vertically within whitespace would be good!)

Now we find out if the descriptions are used elsewhere in core....

AttachmentSizeStatusTest resultOperations
afterFieldDesc.png10.02 KBIgnoredNoneNone
uifielddesc_614294_6.patch1.21 KBIdlePassed: 14668 passes, 0 fails, 0 exceptionsView details | Re-test

#7

yched - November 4, 2009 - 00:22

reporting/developping what I said on IRC:

+1 for removing this. The place where this info currently shows up makes no sense. You should see those help texts *before* you create the field, they're here to help you pick a field type...

Problem is, we didn't really find a good place to display it :-/. It's information you need to see when picking a field type. But the field type picker being a select, there's no obvious place for this info.
Possibly a JS-updated string "somewhere" on the 'Manage Fields' screen when you select a field type. Browers don't react on 'hover' on select options.
Or maybe a 'more informations on field types' link opening a popup. This would stay in line with #87994: Filter tips modal popup => full jQuery UI integration / #609094: Popups for the "More Help" links if they get in.

This being said, big -1 to removing the 'description' strings in hook_field_info() themselves. We want to keep those for now (and possibly adjust them when we know where they'll end up). We just want to *not* display them at the top of field edit forms. This happens in field_ui.admin.inc, field_ui_field_edit_form() and field_ui_field_settings_form().

#8

yched - November 4, 2009 - 00:23
Status:needs review» needs work

Thus, CNW.

+ kind of related: #622614: Consider reducing the number of field types

#9

Bojhan - November 4, 2009 - 16:45

@yched Do you have a patch to not display them? I agree we might not have to actually remove the text, but more guidance for us (who are not awsome php programmers) to achieve this - might be helpful.

#10

yched - November 4, 2009 - 20:13
Status:needs work» needs review

Here's a patch.

AttachmentSizeStatusTest resultOperations
field_ui_no_descriptions-614294-10.patch2.47 KBIdleFailed: 14640 passes, 1 fail, 0 exceptionsView details | Re-test

#11

System Message - November 4, 2009 - 20:35
Status:needs review» needs work

The last submitted patch failed testing.

#12

sun - November 7, 2009 - 21:55

+++ modules/field_ui/field_ui.admin.inc 4 Nov 2009 20:12:59 -0000
@@ -812,20 +812,14 @@
+  drupal_set_title(check_plain($instance['label']));

drupal_set_title() does check_plain() by default now.

This review is powered by Dreditor.

#13

Bojhan - November 7, 2009 - 22:13
Status:needs work» needs review

Fixed tha_suns comment, lets hope that makes a greeny test

AttachmentSizeStatusTest resultOperations
field_ui_no_descriptions-614294-10.patch2.5 KBIdleFailed: 14669 passes, 1 fail, 0 exceptionsView details | Re-test

#14

System Message - November 7, 2009 - 22:35
Status:needs review» needs work

The last submitted patch failed testing.

#15

yched - November 8, 2009 - 04:51
Status:needs work» needs review

Need to fix the test accordingly.

AttachmentSizeStatusTest resultOperations
field_ui_no_descriptions-614294-15.patch3.61 KBIdlePassed: 14701 passes, 0 fails, 0 exceptionsView details | Re-test

#16

sun - November 8, 2009 - 05:39
Status:needs review» reviewed & tested by the community

#17

Dries - November 8, 2009 - 09:25
Status:reviewed & tested by the community» fixed

Committed to CVS HEAD. Thanks!

#18

System Message - November 22, 2009 - 09:30
Status:fixed» closed

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

 
 

Drupal is a registered trademark of Dries Buytaert.