Suggestion for displaying help for the user when editing/ adding a layer

Topics: Core
Feb 28, 2013 at 3:04 PM
Creating or editing a layer can be a daunting task for someone not that familiar with the way they work, or for someone who is not that technical.

Whilst I know that there has been a call to make this UI more intuitive (http://orchard.codeplex.com/discussions/400864), I would also like to suggest a way to provide more help to the end user.

Currently, help is provided below the rule text area in the form of a link to this page: http://docs.orchardproject.net/Documentation/Managing-widgets#AddingaLayer. Whilst this resource has come in handy multiple times for me, the fact that the help page is hosted externally from the instance of Orchard that the user is trying to configure means that any additional rules provided by modules cannot be represented here.

I suggest a change to IRuleProvider: If two string properties were added (RuleSyntax and Description), and then each implementation of IRuleProvider were updated to provide these values, then it would be possible to replicate the table found on the external help page on the add/edit layer page itself. This would also allow additional rules provided by modules to be dynamically added to the help section as and when they are enabled.
Developer
Mar 4, 2013 at 10:29 AM
I think I would like that. Perhaps you could file a bug as a feature request so we can discuss it further. It could be part of the same effort to enhance Parts with descriptions -> http://orchard.codeplex.com/SourceControl/network/forks/sfmskywalker/ContentPartDescriptions
Mar 8, 2013 at 10:15 AM