Active
Project:
Advanced Help Injection and Export
Version:
6.x-1.x-dev
Component:
Code
Priority:
Normal
Category:
Feature request
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
9 Apr 2009 at 06:12 UTC
Updated:
16 Jun 2011 at 23:13 UTC
Jump to comment: Most recent file
Comments
Comment #1
nedjoI'm looking to use helpinject in building a set of features, Debut. Rather than having each feature's help in a separate module, I need the help to be part of the feature. Two potential approaches would be:
* Add features support to helpinject
* Add Drush integration, including the ability to add help to an existing module
The first would probably need patches on Features - since what helpinject does doesn't fit easily into Features approach - and also probably need Drush in any case e.g. to copy over image files. So just doing this in Drush seems more feasible, and also has the advantage of applying to non-Features modules.
Comment #2
nedjoMain barrier in adding helpinject to existing modules is that those modules may have need of hook_help() and/or hook_form_alter().
Proposed approach: introduce a new optional dependency, helpinjector. I opened #895554: Allow adding help to existing modules.
Comment #3
nedjoRough draft of a drush file, not yet working.
Requires the patch at #895554: Allow adding help to existing modules.
Comment #4
nedjoTagging.
Comment #5
nedjoChanges matching those in #895554: Allow adding help to existing modules (which is still required). Rather than actually generating files in helpinject.module, fetch an array of file data (filename, directory, contents, etc.). This is similar to what's done in Features and then leave drush free to create or modify files as needed.
Patch includes the following help (run
drush help helpinjectto display):Comment #6
sdrycroft commentedFor anyone that is reading the issue looking for something a little simpler (that works with the module as it is), then the enclosed helpinject.drush.inc (as patch or txt file) should work for you. Thanks must go to Nedjo for the start on this, although most of his customisations have been removed.
I must also emphasise, I'm not trying to piss anyone off here (Nedjo), it's just the patch you provided didn't do what I was looking for.
Comment #7
nedjo@sdrycroft: If #895554: Allow adding help to existing modules doesn't go in, your patch would make sense. And if #895554 takes awhile to review, it might make sense meanwhile to apply your patch, since it works with the module as it is and answers the initial feature request.
Comment #8
nedjoThe approach I sketched in would have added complexity without addressing underlying issues. I've abandoned it. See comments at #895554-11: Allow adding help to existing modules.