by Jeff Eaton on April 30, 2012 // Short URL

Module Monday: Module Instructions

How to Save Readme and Install Files to Drupal 7's Module Administration Page

In a perfect world, every Drupal module would come with online documentation and support Earl Miles' Advanced Help module for in-depth instructions. In that same perfect world, ever site builder and administrator would read the INSTALL.txt and README.txt files that ship with complex modules before trying to install them. Alas, neither of those dreams is likely to become a reality anytime soon. In the meantime, there's Module Instructions -- a simple one-trick-pony that puts the contents of Readme and Install files right on Drupal's module administration page.

Module Instructions additions to the module administration form

There's not much to say about the interface: when you visit the module administration page, Module Instructions scans each module's directory, hunting for install or readme files. if it finds them, it adds links to that module's line on the administration form. It's simple, it's effective, and while it isn't of much use on a production web site, it's a great tool to have when you're experimenting with new modules or sorting out the installed modules for an in-progress site. (The editor of Module Monday, for example, feels the acute pain of installing dozens of modules for testing purposes. Anything that consolidates their documentation is a good thing...)

Module instructions displayed inside of an Overlay window

If you're a developer interested in customizing Drupal 7's module administration form, Module Instructions is also a useful example of how to alter and bend that notoriously complex administration page. It doesn't interfere with the normal documentation or configuration links used by Drupal core, and plays nicely with other administration-page tweaks like Module Filter.

Jeff Eaton

Senior Digital Strategist

Want Jeff Eaton to speak at your event? Contact us with the details and we’ll be in touch soon.

Comments

Jesse Gifford

Thanks for pointing this out.

Thanks for pointing this out. This could be quite useful. Digging for documentation can be a pain.

Your first link to the module has a typo. It's drupa.org instead of drupal.org.

Reply

Jake Rayson

Your pain is worth it

Dear Jeff,

Sorry to hear of your acute pain. But I think it's worth it, as I read *every* issue of Module Monday. In fact, there is generally a party round my desk when the email comes in.

So please grin and bear it and carry on ;)

regards, Jake

Reply

patcon

Niiice. Awesome find. In

Niiice. Awesome find. In regards to the ideal-world scenario of properly-read README's (presumeably by the light of chandeliers made of licorice and jujubes), it seems github has the right idea with having the project docs derived from the VCS'd readme itself... :)

http://drupal.org/node/1534896

Nice find though. Thanks Eaton!

Reply

Michael

Slow module list?

when you visit the module administration page, Module Instructions scans each module's directory, hunting for install or readme files. if it finds them, it adds links to that module's line on the administration form

That page is already usually very slow, particularly if it decides to check for updates. Does this module make that page load even slower?

Reply