U4-4115 - PropertyContextHelpOption value is being ignored

Created by Greg Fyans 22 Jan 2014, 16:18:56 Updated by Douglas Robar 30 Jun 2017, 10:14:36

Tags: Up For Grabs

The PropertyContextHelpOption, in umbracoSettings.config is being ignored, with the help text displaying underneath the label in the backoffice regardless of the value.

In versions < v7, when set to "icon" it renders an image that you hover your mouse over to display the title, but for v7 this should be a modal/popup that appears on click.

3 Attachments


Shannon Deminick 26 Jun 2017, 05:39:42

Closing issue due to inactivity - see blog post for details https://umbraco.com/blog/issue-tracker-cleanup/

Douglas Robar 26 Jun 2017, 10:53:01

Still valid bug report.

Personally, I'm a fan of the the icon setting. When a site goes to the content editors I have the 'text' settings so the descriptions are very visible. After a few weeks or a month I change the setting to 'icon' which makes the page display more compact while still having the help available.

Shannon Deminick 26 Jun 2017, 23:48:52

This is in progress and is going to be called "Lessons", some of this was demo'd at CG this year:

http://issues.umbraco.org/issue/U4-10050 http://issues.umbraco.org/issue/U4-10052 http://issues.umbraco.org/issue/U4-10051

I'll make this the parent task for those

Shannon Deminick 26 Jun 2017, 23:50:54

(At least I hope that this new contextual help will be what you are after @drobar ?)

Douglas Robar 27 Jun 2017, 10:45:35

Thanks, @Shandem, that might be just right, though I've never heard of 'lessons' before. Where was it demo'd at CG17? Maybe I can watch a video or see a few screenshots to confirm if lessons are the solution to this issue. Thanks!

Shannon Deminick 29 Jun 2017, 01:53:03

Hey @drobar , I think most of it was demo'd in the retreat presentation: https://vimeo.com/221715154 and some also in the keynote (IIRC).

We'd like to get this all achieved via the community including design decisions, etc... I think there's mostly PRs outstanding for review and then we'll need to finalize it (see child tasks). Any feedback is much appreciated!! :)

Douglas Robar 29 Jun 2017, 21:00:29

Thanks, @Shandem, just watched the retreat video and 'lessons' sounds like a great thing! It isn't, however, what the PropertyContextHelpOption setting is for. Let me explain what it does (well, what it used to do and I'd love if it did again)...

Normally, when you add a description text to a doctype property, you'll see that text appear slightly greyed out below the property label when you're editing a content page in the backoffice. Lovely. This is the default setting for PropertyContextHelpOption, which is set to 'text'. That is, it actually displays the description text.

If you set PropertyContextHelpOption to 'icon' you should/used to get a little gif image of a question mark next to the property label when editing a content page in the backoffice. You would not see the description text at all, just this little "help" icon (yes, the icon should be updated from the one used back in the 1990's). But when you hover over the icon you would get a flyout that would display the full description text. Not sure what the touch-screen equivalent of hovering over the icon is in this scenario but Mads or some clever person will know.

The point is... it's best practice to be rather verbose with descriptions. That takes up a lot of screen space, vertically. When you change to 'icon' mode you condense the properties into a nice grouping (especially true for a series of textstring properties, as is common on many doctypes). And you get help whenever you want it by hovering over the icon next to the properties label.

If the text comes from a lesson or the description field is immaterial to this bug report. This is about how that text is displayed.

Note: there is also a 'none' mode to PropertyContextHelpOption. But that's just silly and I can't imagine it is ever used. Who would ever turn off the description text entirely?! Maybe that option can be removed going forward.

Shannon Deminick 30 Jun 2017, 00:32:00

Ahh.. my bad. Ok i've changed the title/desc back to what they were. I actually then have no idea what PropertyContextHelpOption is or what it ever used to do ;)

Do you have screen shots of what it used to do? I'll have to refer this request up to @hartvig or @pploug who probably knew about this setting.

Douglas Robar 30 Jun 2017, 10:14:36

Here you go! Screenshots from v4 but you get the idea.

Priority: Normal

Type: Bug

State: Open


Difficulty: Normal


Backwards Compatible: True

Fix Submitted:

Affected versions: 7.0.0, 7.1.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.1.1, 7.1.2, 7.6.3

Due in version:


Story Points: