Examples for Developers

rfay - October 3, 2009 - 14:03

Goals of this project:

Move the example modules that used to be hidden over in the documentation CVS over to the modules repository as first-class modules, which can be maintained, updated, and discussed in the issue queues.
Create simpletest suites for the example modules so that we know when there's a problem with them.
Add new example modules that show off core functionality for developers

Overall, we want the examples to be maintained!

Example Module Status:

Name	D6	D7	Simpletest
AHAH Example	X
AJAX Example		X
Batch Example	X	X	X
Block Example	X	X	X
Email Example	X	X	X
Filter Example	X	X	X
Form Element Example	X	X	X
Node API Usage Example	X
Node Access Example	X
Node Example (Node type)	X
Page Example	X	X	X
Scaffolding Example (Database Record Usage)	X
Trigger and Action Example	X
XMLRPC Example	X

Additional To-Do Wishlist of Examples:

What examples do you need as a developer? Create an issue in the queue if you think there's a need.

If you have an example module and want to be added as a committer, just ask. If you'd rather submit a patch, do that in the issue queue.

New example modules are welcome, either as a patch or you can apply for cvs permissions.

The module must demonstrate a core feature. We'll get an "Examples" category together for contrib feature demonstrations later.
Drupal coding standards must be maintained.
Run Coder module on your module before submitting.
New modules should have tests, if possible. The intent is that not only will the test keep the module maintained, but the test itself is also a great resource for developers.