Improve help section

I have reviewed your patch and created another in response. This patch corrects some errors in the text and it cleans up the links. If links are part of a sentence, the link text should not be separated from the string and passed on to l(). The best way is to use a hardcoded link and only dynamically insert the path. This way the sentence stays intact, which will make translating it much easier.

I would stick to a <h2> for that heading. The headings setup in Garland isn't right. A <h1> tag is used for the site's title and a <h2> for the page's title, while the site's title shouldn't be in a <hX> tag at all and if you want the page's title to be a heading it should be enclosed within <h1> tags, because it's the most important heading on the page.

Kudos for the idea of a dynamic help!

Have you deleted the "(DONE)" and "(TO DO)" indicators from the patch? I have been thinking about them because I didn't really like the way you implemented them. It looked a bit ugly. Only now I know a solution which I hope you find better looking: All necessary steps to set up the module that cannot be performed should be marked red, all steps that can be performed, but haven't been should be marked yellow and all steps that have been performed should be marked green. I was thinking about using the same colours and icons as drupal.org uses for the version overview at a module's project page.

Perhaps tonight I'll be able to make a patch for this.

I have almost completely redesigned the installation instructions. It now features coloured indicators for all configuration steps; red means you don't have permission or there are no blocks to assign to regions, yellow means that a step has yet to be executed and green means that somebody has already executed that step. There is one step that doesn't have a colour in a certain state, which, logically, is its neutral state. I have also cut into the strings a bit. The one big-ass chunk containing the <ol> has now been separated into 6 smaller strings. This will make translating them easier. Next to the patch I have also written a CSS file. Since those aren't allowed as file uploads so I uploaded it somewhere else.

It's no CVS patch, just an ordinary patch between local files. I have however done a checkout before creating the patch, so it should work.

The difference is that steps marked red cannot be executed and that yellow indicates steps that _can_ be executed, but that no one has done that yet. During my trip home from work I thought of a way to make clear why a step cannot be executed. Next to that all we need are some nifty icons that fit the configuration status and I think that list is ready.

I have tweaked the help section a bit more. Two configuration steps have been merged, red now indicates steps yet to be executed and I have addedd a short description to explain this behaviour. The attached screenshot will say all there is to say actually.

//Edit: and we have an updated CSS file as well.

It seems like the CSS needs some tweaking. I'll try the patch this evening, but it looks good so far.

Sutha, could you please provide the images and CSS as well?

I would use background images for this rather than normal images. The icons are no actual part of the content and I seriously doubt people without a graphic browser will visit that page (just a matter of target audience).

Just a sidenote: the patch in #15 doesn't properly add the icons as images to the list.

The attached patch adds the icons as background images and fixes some minor CSS issues. I have updated the foreach loop that adds all list items to a single array. The status check was redundant, since a status has been set for every item once the loop is being executed.

I created Dynamic Help based on our work for this issue. Vocabulary Index 6.x-2.x-dev already uses this module. My intentions with Dynamic Help are to create a clear example of what Dynamic Help is, so it might be included in Drupal core. Until this happens other modules are encouraged to use Dynamic Help for their lists of configuration steps, so we can centralise development and improve usability.