[documentation] [Documentation task] Example modules need updating for 5.0

webchick drupal-docs at drupal.org
Tue Nov 7 21:40:16 UTC 2006


Issue status update for 
http://drupal.org/node/93497
Post a follow up: 
http://drupal.org/project/comments/add/93497

 Project:      Documentation
 Version:      <none>
 Component:    Documentation in CVS
 Category:     tasks
 Priority:     critical
 Assigned to:  Anonymous
 Reported by:  webchick
 Updated by:   webchick
 Status:       patch (code needs work)

Whoops. Accidentally committed that while I was committing an info file
for XMLRPC example. :(




webchick



Previous comments:
------------------------------------------------------------------------

Tue, 07 Nov 2006 20:33:42 +0000 : webchick

Yep.




------------------------------------------------------------------------

Tue, 07 Nov 2006 20:44:36 +0000 : pwolanin

what about adding the "pants module" as an example?


http://drupal.org/node/86528




------------------------------------------------------------------------

Tue, 07 Nov 2006 20:55:56 +0000 : webchick

Updated block_example and page_example modules.


Still to go:
- fileupload.module
- filter_example.module
- multipage_form_example.module
- node_example.module
- nodeapi_example.module
- xmlrpc_example.module




------------------------------------------------------------------------

Tue, 07 Nov 2006 20:56:40 +0000 : webchick

Pants module is cool, and gets across a lot of concepts, but imo isn't
appropriate for API documentation.




------------------------------------------------------------------------

Tue, 07 Nov 2006 20:58:51 +0000 : webchick

and before I get flamed for that, I don't mean inappropriate as "OMG
PANTS?!?! Won't someone think of the children!!!" I mean it as in each
example module in the API docs communicates one specific concept, and is
only a few functions in length. Pants module covers everything from
hook_user to XML-RPC. It's more of a tutorial than an example.




------------------------------------------------------------------------

Tue, 07 Nov 2006 21:29:21 +0000 : webchick

Attachment: http://drupal.org/files/issues/nodeapi_example.patch (4.01 KB)

Here's a start on nodeapi_example.module. It should be working, except
it isn't. :P For some reason, every time I save the node settings
options, it saves it as nodeapi_example_blog_blog which of course
doesn't work. But even correcting manually doesn't seem to be working
either.




------------------------------------------------------------------------

Tue, 07 Nov 2006 21:29:48 +0000 : webchick

Attachment: http://drupal.org/files/issues/nodeapi_example.info (134 bytes)

Here's the info file.






More information about the documentation mailing list