First, this is AWESOME... a great start!

I have a couple of thoughts and suggestions... let me know if I should split these out into separate items.

1) What is docs/developer/hooks doing? Is that being parsed? How? Setting that up is going to be a pain for most admins. Keep in mind that they may have not figured out CVS yet. Is there a way that could be included with the module?

You might even be able to snag the docs in realtime by parsing these files instead of reading from docs/developer/hooks:

http://cvs.drupal.org/viewcvs/*checkout*/drupal/contributions/docs/devel...
http://cvs.drupal.org/viewcvs/*checkout*/drupal/contributions/docs/devel...
http://cvs.drupal.org/viewcvs/*checkout*/drupal/contributions/docs/devel...
http://cvs.drupal.org/viewcvs/*checkout*/drupal/contributions/docs/devel...

2) I'd rather see the result page output a textarea rather than a scrolling div. The advantage of a textarea is that most browsers will select everything INSIDE the textarea when you click in it and do a 'select all'. Scrolling divs don't, so it's a pain to copy and paste.

3) from your README:

* I need a fancy JavaScript/AJAX guru to hook up magic so when you
select from the available module types, it automatically selects

Tell me what you need!

4) from your README:

* I would like to add the option to import help text from a Drupal.org
handbook page, to help encourage authors to write standardized
documentation in http://www.drupal.org/handbook/modules/

Neat idea. I would love to see a quick line about each hook next to it's textbox. Or maybe popup ("title" tag) help text when you roll over the button. Or a expandable div with this text (so it doesn't muck up the page flow). I'd probably lean toward getting everything you need into the docs/developer/hooks documents rather than trying to import help for the handbook.

Just some thoughts.

Rock!
-Jeff Robbins
www.lullabot.com

Comments

webchick’s picture

Awesome, thanks for the feedback, Jeff!

1) What is docs/developer/hooks doing? Is that being parsed? How?

The list of hooks that appears in the form is populated automatically by parsing the files in docs/developer/hooks. I did this for a couple reasons:

1. I didn't want to have to update my script everytime a new hook was added/removed (which seemed like it was happening A LOT with the forms API stuff)
2. If this tool takes off in a big way, it will encourage people to keep those docs updated. ;D

However...

Setting that up is going to be a pain for most admins. Keep in mind that they may have not figured out CVS yet. Is there a way that could be included with the module?

You might even be able to snag the docs in realtime by parsing these files instead of reading from docs/developer/hooks

What an awesome idea! I will incorporate that into the next release (aka the next time I have a major bout of insomnia ;)). I learned recently of the drupal_http_request function, which should work perfectly for that. I could also have it maybe save the files locally to the files/ directory so that it could still be usable without a 'net connection (which is likely why I chose to do the "look in a local CVS repos" route... I wrote the beginnings of this on the plane back from Vancouver ;)).

2) I'd rather see the result page output a textarea rather than a scrolling div. The advantage of a textarea is that most browsers will select everything INSIDE the textarea when you click in it and do a 'select all'. Scrolling divs don't, so it's a pain to copy and paste.

Yeah, I originally had it as a textarea, but then Steven asked me to change it to a scrolling div. I will go ahead and switch it back to textarea because not being able to "select all" is quite a nasty usability bug. :P

[re: AJAX] Tell me what you need!

Well for starters, help on stuff like this:

Or maybe popup ("title" tag) help text when you roll over the button. Or a expandable div with this text (so it doesn't muck up the page flow).

These are all very excellent suggestions but at the moment I am quite rusty on JavaScript/DOM so it would take me some time to figure out how to do it.

But the main thing is I would like to be able to establish "groups" of hooks (and would be cool if this was configurable in some way but not an immediate concern) for different module types/features. For example:

- Node (this would auto-check hook_node_info, hook_insert, hook_update, etc. etc.)
- Block (this would auto-check hook_block)
- etc.

Basically, I would like to incorporate the JavaScript/AJAX components you outlined in your iintiial mockups of this module.

However, I would really like to finally properly learn AJAX so what I might do is try and code this myself (unless of course you have a bout of insomnia before I do ;)) and maybe shoot you an e-mail every once in awhile to help me through a couple sticky parts, if you'd be ok with that?

webchick’s picture

You went and got me all jazzed about this module again so I couldn't sleep, and ended up implementing your suggestions 1 and 2 tonight. ;)

I'll try and work some on 3 and 4 over the weekend. Thanks again for the feedback! :)

webchick’s picture

Assigned: Unassigned » webchick

Adding this to my tracker too so I don't lose track (ha!) of it.

webchick’s picture

Status: Active » Fixed

Ok, I'm going to mark this fixed now, since the bulk of what you asked for (sans fancy formatting) is there. Please let me know if you have other suggestions!

Anonymous’s picture

Status: Fixed » Closed (fixed)