A few weeks ago Sutharsan (Erik Stielstra) proposed a kind of dynamic help for Header Image. Together with Bojhan Somers (Bojhan) we developed his idea into a usable way of creating lists with configuration steps for modules (or anything else you'd like to use it for). Last night I created Dynamic Help based on our efforts so far. It's not much code and one might have his doubts as to why I have put this in a separate module. The reason behind all this is that I wanted to create an easy example of dynamic help (perhaps we can have it moved to core, hence the separate module) and that module maintainers can easily implement this feature without worrying about usability or consistency.
Vocabulary Index 6.x-2.x-dev already implements this module, so if you want to check it out and comment (comments are most welcome), please download Dynamic Help and Vocabulary Index and go to the general help page of the latter. There you'll find a list with a 'Configuration' above. That list is the dynamic help.
| Attachment | Size |
|---|---|
| Picture 9.png | 33 KB |
Comments
This is a nice step in the
This is a nice step in the right direction. Could this somehow be combined with advanced_help? And/or could a wizard be based on this?
A few notes, based on just the screenshot:
It isn't really intended to
It isn't really intended to be used as/in a wizard. It's more or less a basic list of possible steps the user might take to configure the module. If a module doesn't work as expected users may take a look at its dynamic help to get a quick overview of things they may still need to configure. Wizards are meant to configure something, Dynamic Help is meant to show users they may still need to configure something.
To clarify, this is help is
To clarify, this is help is tailored after Header Image, whether it applies for other modules that have a more structured workflow we didn't explore. On the note of the icon, I agree - you got a solution? We couldn't find one that would work with the constraints we have (we have a few other solution, maybe we could test them with users).
It is a step into the direction as you said, maybe we will see it more tailored for other workflows.
Icon
A green tick? It usually means "this step is done and okay, you can keep on working".
Steps don't necessarily have
Steps don't necessarily have to be executed for modules to work. They're more like guidelines. A green tick might indicate that those are necessary while they are not. A warning sign may do the same, but we thought these were necessary to get the user's attention.