Add a toggleable inline index of help pages.
redndahead - August 27, 2008 - 18:05
| Project: | Advanced help |
| Version: | 6.x-1.x-dev |
| Component: | Code |
| Category: | feature request |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | needs work |
Jump to:
Description
This patch creates a theme function that builds a toggleable inline index of help pages. You can limit the index to only certain pages to create a targeted help area. It degrades nicely so that the help pages will be shown and the index title will link to the module's index page.
| Attachment | Size |
|---|---|
| inline_index.patch | 2.64 KB |
#1
More info:
If you want to add it to your page, the theme function is:
theme('advanced_help_inline_index', $module, $title, $allowed_topics);$module = The name of the module who's help topics you would like to get.
$title = (Optional) The title of the help index header. If not specified it will be "Help Topics".
$allowed_topics = (Optional) An array of topics for that module that you would like to show. If not specified then it shows all of them.
Example:
theme('advanced_help_inline_index', 'mymodule', 'My Module Help Files', array('add-new-page', 'delete-page'));#2
This is an interesting concept. AT the very least it needs to be further documented. However, I think this is part of a wider featureset and I think this should not be committed to the project until we have a good idea where the whole system is intended to go. AFter a bit of discussion in IRC, this is a piece that is useful in a kind of auto-help block where the .ini file can be used to help provide contextual tutorial links in a block based upon the path. While this is a cool idea, we need to map it out more. I fear that putting in parts piecemeal will lead to fragmented implementations, and while this particular piece of code is cool it is not useful by itself, though I think it could be quite useful in combination with other features.