Closed (outdated)
Project:
Advanced Help Injection and Export
Version:
6.x-1.0-alpha2
Component:
User interface
Priority:
Normal
Category:
Feature request
Assigned:
Unassigned
Reporter:
Created:
13 Apr 2009 at 21:44 UTC
Updated:
27 Jun 2018 at 13:37 UTC
Jump to comment: Most recent
Comments
Comment #1
robertdouglass commentedHmm. I can see adding something like a link per block. I don't know how I'd satisfy the "views display", though. Can you describe to me more clearly what that would look like?
Comment #2
manimejia commentedAdding to blocks would be good ... but here's what I'm seeing ...
The need to add "help inject buttons" to views would be pretty much taken care of by using both the "path" and (proposed) "block" type, but a specific "view" type would take care of attached views as well as being a more accurate "attachment point" for view specific documentation.
I'm developing complete "pre-configured" website packages for small business owners. These packages consist of an install profile, a theme, and a custom module, built on top of a standard Drupal distribution (like Acquia Drupal). In this case, the targeted end users are not Drupal savvy, and probably don't care to be. In fact, this might be their first website. In these "pre-configured" packages, It would benefit both package developers and the end users to have an in depth "owners manual" available, and integrated into the navigation of the site. With such an owners manual, these business owners could understand (without relating to modules) the "high level" architecture and administration of their specific Drupal configuration.
Seems to me, that this sort of Documentation would best be delivered "in context" using the "advanced_help" module. Your "helpinject" module is a great tool to create these documentation texts, but so far they are only available to "inject" on forms and paths. A true "in context" help injecting solution (in this case) would include more attachment points. One per every view, would be a good way to document the purpose of each view in the site's architecture. One per every menu would be good to, for the same reason. The point being (in this case) to provide an an easy "in context" assistance to new website owners.
So far, to get advanced_help on every view, I have added the following code to
views-view.tpl.phpin my packaged theme:I'm not counting on this to work in injecting usable help on the views. But at least I can write my book pages, and get them referenced to a view ID. When I export the module, I'll probably have to tweak it. But that's where I'm going with this.
How can we get this module developed to "inject help" in views (and blocks and menus?) as well as paths and forms?
Thanks,
M.M.
Comment #3
robertdouglass commentedThese are really great suggestions and your code helps a lot in stimulating my thinking. I'll add these requests to the things I plan on implementing.
I'm working on this module as a free time project (which means mostly weekends). It's not possible to get me to work any faster on this (oh, but how I wish it were!) because there isn't any more time left over, but if you want to sponsor a different developer (preferably someone I know and can work with) to work on this or other features, I will gladly mentor them and guide them as best I can. Use my contact form to discuss that possibility if you're interested.
Comment #4
xqbzzr commentedSubscribe!
When building my current project I was really looking forward to using this module first time. From what I read this thing seemed to be fantastic. A module building its own submodules! Phew!
But now that I have it up and running I am a tiny bit disappointed, meaning no offence. I wanted those nifty little question-marks right at the top right corner of every block to explain what this block is for. And now - ??? - this is not possible...
That was what I thought this module would do. So if you find any time to work on this, it would be very appreciated!
After all, this module still is impressive, taking over whole the drupal system and plugging in all its icons.
Hang on!
Thank you
Comment #5
mrfelton commentedOn a similar note, I wanted to use this module to develop a website showcase where I would inject help icons all over the place, often in content and clicking on one would pop up a help box explaing how this part of the site was built. I'd love to see some progress on this ;)
Comment #6
shaneonabike commented+1
Comment #7
kenorb commentedRelated: #702564: Add injection into blocks
Comment #8
kenorb commentedDrupal 6 is no longer officially supported. If you think this issue is still relevant for 8.x, feel free to re-open.